Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/knip/fixtures/plugins/hardhat/contracts/Test.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
pragma solidity ^0.8.0;

import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol"

contract Test is ERC20 {}
10 changes: 9 additions & 1 deletion packages/knip/fixtures/plugins/hardhat/hardhat.config.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
const config = {};
import "@nomicfoundation/hardhat-node-test-reporter";
import "@solidstate/hardhat-contract-sizer";
import type { HardhatUserConfig } from "../../../src/plugins/hardhat/types.js";

const config: HardhatUserConfig = {
solidity: {
dependenciesToCompile: ["@solidstate/contracts/interfaces/IERC20.sol"],
},
};

export default config;

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions packages/knip/fixtures/plugins/hardhat/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{
"name": "@plugins/hardhat",
"devDependencies": {
"@nomicfoundation/hardhat-node-test-reporter": "*",
"@openzeppelin/contracts": "*",
"@solidstate/contracts": "*",
"@solidstate/hardhat-contract-sizer": "*",
"hardhat": "*"
}
}
Empty file.
51 changes: 42 additions & 9 deletions packages/knip/src/plugins/hardhat/index.ts
Original file line number Diff line number Diff line change
@@ -1,25 +1,58 @@
import type { IsPluginEnabled, Plugin, Resolve } from '../../types/config.js';
import { toDependency } from '../../util/input.js';
import { hasDependency } from '../../util/plugin.js';
import type {
IsPluginEnabled,
Plugin,
Resolve,
ResolveConfig,
} from "../../types/config.js";
import { toDeferResolve, toDependency, toEntry } from "../../util/input.js";
import { hasDependency } from "../../util/plugin.js";
import type { HardhatUserConfig } from "./types.js";

// https://hardhat.org/docs

const title = 'Hardhat';
const title = "Hardhat";

const enablers = ['hardhat'];
const enablers = ["hardhat"];

const isEnabled: IsPluginEnabled = ({ dependencies }) => hasDependency(dependencies, enablers);
const isEnabled: IsPluginEnabled = ({ dependencies }) =>
hasDependency(dependencies, enablers);

const entry: string[] = ['hardhat.config.{js,cjs,mjs,ts}'];
const config = ["hardhat.config.{js,cjs,mjs,ts}"];

const resolve: Resolve = async () => {
return [toDependency('hardhat')];
const inputs = [toDependency("hardhat")];

// TODO: only add test files if a Hardhat test reporter is installed
// TODO: get test path from config
const patterns = [
"**/*{.,-,_}test.?(c|m)(j|t)s",
"**/test-*.?(c|m)(j|t)s",
"**/test.?(c|m)(j|t)s",
"**/test/**/*.?(c|m)(j|t)s",
];
inputs.push(...patterns.map((id) => toEntry(id)));

return inputs;
};

const resolveConfig: ResolveConfig<HardhatUserConfig> = (config) => {
return [config.solidity]
.flat()
.filter(
(solidityConfig) =>
typeof solidityConfig !== "undefined" &&
typeof solidityConfig !== "string",
)
.map((solidityConfig) => solidityConfig.dependenciesToCompile ?? [])
.flat()
.map((dependency) => toDeferResolve(dependency));
};

export default {
title,
enablers,
isEnabled,
entry,
config,
resolve,
resolveConfig,
} satisfies Plugin;
11 changes: 11 additions & 0 deletions packages/knip/src/plugins/hardhat/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
interface CommonSolidityUserConfig {
dependenciesToCompile?: string[];
// TODO: use remappings to detect imports in *.sol files
remappings?: string[];
}

type SolidityUserConfig = string | string[] | CommonSolidityUserConfig;

export interface HardhatUserConfig {
solidity?: SolidityUserConfig;
}
Loading