Skip to content

chore: replace depcheck with knip#9047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cryptodev-2s merged 5 commits into from
Jun 8, 2026
Merged

chore: replace depcheck with knip #9047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
31636fa
chore: replace depcheck with knip
cryptodev-2s Jun 8, 2026
edd239f
fix: dedupe deps
cryptodev-2s Jun 8, 2026
dc90a6b
chore: remove vestigial lint:dependencies scripts
cryptodev-2s Jun 8, 2026
3a4e04b
fix: make knip.config.ts pass eslint
cryptodev-2s Jun 8, 2026
d7d5ec5
Merge remote-tracking branch 'origin/main' into chore/replace-depchec…
cryptodev-2s Jun 8, 2026
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
32 changes: 0 additions & 32 deletions .depcheckrc.yml
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/processes/package-migration-process-guide.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,7 +73,7 @@ This document outlines the process for migrating a MetaMask library into the cor

### **[PR#8]** 3. Remove files and directories that will be replaced by files in the monorepo root directory

- **Remove**: `.github/`, `.git*`, `scripts/`, `.depcheckrc.json`, `.yarn/`, `.yarnrc.yml`, `yarn.lock`, `.editorconfig`, `.eslint*`, `.prettier*`, `.nvm*`.
- **Remove**: `.github/`, `.git*`, `scripts/`, `knip.config.ts`, `.yarn/`, `.yarnrc.yml`, `yarn.lock`, `.editorconfig`, `.eslint*`, `.prettier*`, `.nvm*`.
- **Keep**: `src/`, `tests/`, `CHANGELOG.md`, `LICENSE`, `package.json`, `README.md`, `jest.config.js`, `tsconfig*.json`, `typedoc.json`
- [Example PR](https://github.com/MetaMask/core/pull/1764)

Expand Down
58 changes: 58 additions & 0 deletions knip.config.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
import type { KnipConfig } from 'knip';

const config: KnipConfig = {
workspaces: {
'.': {
entry: [
'scripts/**/*.{ts,js,sh}',
'tests/**/*.ts',
'*.config.{js,cjs,mjs,ts}',
'jest.config.*.js',
'yarn.config.cjs',
'eslint.config.mjs',
'.prettierrc.js',
'release.config.js',
'knip.config.ts',
],
project: ['scripts/**/*.ts', 'tests/**/*.ts', '*.{js,cjs,mjs,ts}'],
Comment on lines +6 to +17

@MrtenzMrtenzJun 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sounds like it only works on a limited set of paths, instead of the entire repository?

@cryptodev-2scryptodev-2sJun 8, 2026•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, intentional for now: --workspace . in the lint script scopes this to the root workspace. depcheck wasn't actually checking packages/* either (it only validated root deps), so coverage's the same as before. Happy to expand knip to lint all workspaces in a follow-up PR.
Check the deleted .depcheckrc.yml

@MrtenzMrtenzJun 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that's intentional 🤔 We should definitely be checking all packages.

@GudahttGudahttJun 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree it's a mistake, but it's a pre-existing one. Solving it in a later PR sounds good to me, but we really should fix it.

I had discovered this independently a few of weeks ago but forgot to mention it

ignore: ['scripts/create-package/package-template/**'],
// The `preset: 'ts-jest'` shorthand expands to `ts-jest/jest-preset`,
// which knip can't resolve to an actual file even though `ts-jest` is
// listed in `devDependencies`.
ignoreUnresolved: ['ts-jest/jest-preset'],
},
},
ignoreDependencies: [
// Dependencies used by Yarn binaries in `.yarn`
/^@yarnpkg\//u,
'clipanion',
'typanion',
// Dependencies imported implicitly by TypeScript
/^@types\//u,
// Tools (packages which we use as executables and not libraries)
'@lavamoat/allow-scripts',
'@metamask/auto-changelog',
'@metamask/create-release-branch',
'eslint-interactive',
'rimraf',
'simple-git-hooks',
'ts-node',
'typedoc',
// Plugins for tools
/^@typescript-eslint\//u,
/^eslint-config-/u,
/^eslint-plugin-/u,
'jest-silent-reporter',
'prettier-plugin-packagejson',
'typescript-eslint',
// Jest environments referenced in `jest.config.scripts.js`
'jest-environment-node',
'jest-environment-jsdom',
// Dependencies imported implicitly by tools
'eslint-import-resolver-typescript',
// Dependencies which plug into the NPM lifecycle
'@lavamoat/preinstall-always-fail',
],
};

export default config;
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,8 @@
"create-release-branch": "create-release-branch --formatter oxfmt",
"create-package": "tsx scripts/create-package",
"lint": "yarn lint:eslint && echo && yarn lint:misc --check && yarn constraints && yarn lint:dependencies && yarn lint:teams && yarn messenger-action-types:check && yarn readme-content:check",
"lint:dependencies": "depcheck && yarn dedupe --check",
"lint:dependencies:fix": "depcheck && yarn dedupe",
"lint:dependencies": "knip --workspace . --dependencies && yarn dedupe --check",
"lint:dependencies:fix": "knip --workspace . --dependencies && yarn dedupe",
"lint:eslint": "yarn build:only-clean && NODE_OPTIONS='--max-old-space-size=6144' yarn eslint",
"lint:fix": "yarn lint:eslint --fix --prune-suppressions && echo && yarn lint:misc --write && yarn constraints --fix && yarn lint:dependencies:fix && yarn messenger-action-types:generate && yarn readme-content:update",
"lint:misc": "oxfmt --ignore-path .gitignore",
Expand DownExpand Up@@ -66,7 +66,6 @@
"@typescript-eslint/parser": "^8.48.0",
"@yarnpkg/types": "^4.0.0",
"comment-json": "^4.5.1",
"depcheck": "^1.4.7",
"eslint": "^9.39.1",
"eslint-config-prettier": "^9.1.0",
"eslint-import-resolver-typescript": "^3.6.3",
Expand All@@ -80,6 +79,7 @@
"isomorphic-fetch": "^3.0.0",
"jest": "^29.7.0",
"jest-silent-reporter": "^0.5.0",
"knip": "^6.15.0",
"lodash": "^4.17.21",
"nock": "^13.3.1",
"oxfmt": "^0.44.0",
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -253,5 +253,5 @@
}
],
"files": [],
"include": ["./docs", "./types", "./scripts"]
"include": ["./docs", "./types", "./scripts", "./knip.config.ts"]
}
Loading
Loading