@knip/mcp 0.0.18 → 0.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +17 -17
- package/src/docs/blog/for-editors-and-agents.md +47 -43
- package/src/docs/blog/knip-v3.mdx +1 -1
- package/src/docs/blog/knip-v4.mdx +2 -2
- package/src/docs/blog/two-years.mdx +1 -1
- package/src/docs/explanations/comparison-and-migration.md +4 -0
- package/src/docs/explanations/plugins.md +38 -10
- package/src/docs/features/auto-fix.mdx +22 -7
- package/src/docs/features/monorepos-and-workspaces.md +19 -4
- package/src/docs/features/production-mode.md +1 -1
- package/src/docs/features/reporters.md +9 -7
- package/src/docs/guides/configuring-project-files.md +13 -13
- package/src/docs/guides/contributing.md +1 -1
- package/src/docs/guides/handling-issues.mdx +183 -121
- package/src/docs/guides/issue-reproduction.md +21 -12
- package/src/docs/guides/performance.md +19 -8
- package/src/docs/guides/troubleshooting.md +7 -10
- package/src/docs/guides/using-knip-in-ci.md +16 -20
- package/src/docs/index.mdx +3 -3
- package/src/docs/overview/configuration.md +6 -6
- package/src/docs/overview/features.md +5 -5
- package/src/docs/overview/getting-started.mdx +15 -5
- package/src/docs/reference/cli.md +269 -243
- package/src/docs/reference/configuration.md +24 -7
- package/src/docs/reference/faq.md +111 -59
- package/src/docs/reference/jsdoc-tsdoc-tags.md +12 -1
- package/src/docs/reference/known-issues.md +43 -21
- package/src/docs/reference/plugins.md +15 -1
- package/src/docs/reference/related-tooling.md +3 -3
- package/src/docs/sponsors.mdx +3 -4
- package/src/docs/typescript/unused-exports.md +1 -1
- package/src/docs/writing-a-plugin/index.md +17 -4
- package/src/tools.js +3 -9
- package/src/docs/docs/blog/brief-history.md +0 -30
- package/src/docs/docs/blog/for-editors-and-agents.md +0 -131
- package/src/docs/docs/blog/knip-v3.mdx +0 -88
- package/src/docs/docs/blog/knip-v4.mdx +0 -149
- package/src/docs/docs/blog/knip-v5.mdx +0 -190
- package/src/docs/docs/blog/migration-to-v1.md +0 -65
- package/src/docs/docs/blog/release-notes-v2.md +0 -46
- package/src/docs/docs/blog/slim-down-to-speed-up.md +0 -269
- package/src/docs/docs/blog/state-of-knip.md +0 -191
- package/src/docs/docs/blog/two-years.mdx +0 -107
- package/src/docs/docs/explanations/comparison-and-migration.md +0 -129
- package/src/docs/docs/explanations/entry-files.md +0 -70
- package/src/docs/docs/explanations/plugins.md +0 -329
- package/src/docs/docs/explanations/why-use-knip.md +0 -128
- package/src/docs/docs/features/auto-fix.mdx +0 -348
- package/src/docs/docs/features/compilers.md +0 -172
- package/src/docs/docs/features/integrated-monorepos.md +0 -61
- package/src/docs/docs/features/monorepos-and-workspaces.md +0 -149
- package/src/docs/docs/features/production-mode.md +0 -95
- package/src/docs/docs/features/reporters.md +0 -304
- package/src/docs/docs/features/rules-and-filters.md +0 -102
- package/src/docs/docs/features/script-parser.md +0 -156
- package/src/docs/docs/features/source-mapping.md +0 -100
- package/src/docs/docs/guides/configuring-project-files.md +0 -205
- package/src/docs/docs/guides/contributing.md +0 -24
- package/src/docs/docs/guides/handling-issues.mdx +0 -708
- package/src/docs/docs/guides/issue-reproduction.md +0 -102
- package/src/docs/docs/guides/namespace-imports.md +0 -125
- package/src/docs/docs/guides/performance.md +0 -108
- package/src/docs/docs/guides/troubleshooting.md +0 -133
- package/src/docs/docs/guides/using-knip-in-ci.md +0 -50
- package/src/docs/docs/guides/working-with-commonjs.md +0 -72
- package/src/docs/docs/index.mdx +0 -160
- package/src/docs/docs/overview/configuration.md +0 -104
- package/src/docs/docs/overview/features.md +0 -66
- package/src/docs/docs/overview/getting-started.mdx +0 -205
- package/src/docs/docs/overview/screenshots-videos.md +0 -42
- package/src/docs/docs/playground.mdx +0 -38
- package/src/docs/docs/reference/cli.md +0 -511
- package/src/docs/docs/reference/configuration.md +0 -430
- package/src/docs/docs/reference/dynamic-configuration.mdx +0 -72
- package/src/docs/docs/reference/faq.md +0 -432
- package/src/docs/docs/reference/issue-types.md +0 -43
- package/src/docs/docs/reference/jsdoc-tsdoc-tags.md +0 -122
- package/src/docs/docs/reference/known-issues.md +0 -86
- package/src/docs/docs/reference/plugins/.gitkeep +0 -0
- package/src/docs/docs/reference/plugins/angular.md +0 -33
- package/src/docs/docs/reference/plugins/astro-db.md +0 -34
- package/src/docs/docs/reference/plugins/astro-og-canvas.md +0 -13
- package/src/docs/docs/reference/plugins/astro.md +0 -43
- package/src/docs/docs/reference/plugins/ava.md +0 -46
- package/src/docs/docs/reference/plugins/babel.md +0 -38
- package/src/docs/docs/reference/plugins/biome.md +0 -34
- package/src/docs/docs/reference/plugins/bumpp.md +0 -38
- package/src/docs/docs/reference/plugins/bun.md +0 -13
- package/src/docs/docs/reference/plugins/c8.md +0 -26
- package/src/docs/docs/reference/plugins/capacitor.md +0 -35
- package/src/docs/docs/reference/plugins/changelogen.md +0 -38
- package/src/docs/docs/reference/plugins/changelogithub.md +0 -38
- package/src/docs/docs/reference/plugins/changesets.md +0 -33
- package/src/docs/docs/reference/plugins/commitizen.md +0 -35
- package/src/docs/docs/reference/plugins/commitlint.md +0 -39
- package/src/docs/docs/reference/plugins/convex.md +0 -34
- package/src/docs/docs/reference/plugins/create-typescript-app.md +0 -33
- package/src/docs/docs/reference/plugins/cspell.md +0 -36
- package/src/docs/docs/reference/plugins/cucumber.md +0 -36
- package/src/docs/docs/reference/plugins/cypress.md +0 -40
- package/src/docs/docs/reference/plugins/danger.md +0 -33
- package/src/docs/docs/reference/plugins/dependency-cruiser.md +0 -44
- package/src/docs/docs/reference/plugins/docusaurus.md +0 -39
- package/src/docs/docs/reference/plugins/dotenv.md +0 -24
- package/src/docs/docs/reference/plugins/drizzle.md +0 -33
- package/src/docs/docs/reference/plugins/eleventy.md +0 -38
- package/src/docs/docs/reference/plugins/eslint.md +0 -74
- package/src/docs/docs/reference/plugins/expo.md +0 -38
- package/src/docs/docs/reference/plugins/expressive-code.md +0 -39
- package/src/docs/docs/reference/plugins/gatsby.md +0 -46
- package/src/docs/docs/reference/plugins/github-action.md +0 -33
- package/src/docs/docs/reference/plugins/github-actions.md +0 -34
- package/src/docs/docs/reference/plugins/glob.md +0 -26
- package/src/docs/docs/reference/plugins/graphql-codegen.md +0 -43
- package/src/docs/docs/reference/plugins/hardhat.md +0 -33
- package/src/docs/docs/reference/plugins/husky.md +0 -37
- package/src/docs/docs/reference/plugins/i18next-parser.md +0 -44
- package/src/docs/docs/reference/plugins/jest.md +0 -50
- package/src/docs/docs/reference/plugins/karma.md +0 -36
- package/src/docs/docs/reference/plugins/knex.md +0 -33
- package/src/docs/docs/reference/plugins/ladle.md +0 -40
- package/src/docs/docs/reference/plugins/lefthook.md +0 -43
- package/src/docs/docs/reference/plugins/lint-staged.md +0 -45
- package/src/docs/docs/reference/plugins/linthtml.md +0 -38
- package/src/docs/docs/reference/plugins/lockfile-lint.md +0 -38
- package/src/docs/docs/reference/plugins/lost-pixel.md +0 -33
- package/src/docs/docs/reference/plugins/markdownlint.md +0 -34
- package/src/docs/docs/reference/plugins/mdx.md +0 -37
- package/src/docs/docs/reference/plugins/mdxlint.md +0 -35
- package/src/docs/docs/reference/plugins/metro.md +0 -46
- package/src/docs/docs/reference/plugins/mocha.md +0 -48
- package/src/docs/docs/reference/plugins/moonrepo.md +0 -35
- package/src/docs/docs/reference/plugins/msw.md +0 -36
- package/src/docs/docs/reference/plugins/nano-staged.md +0 -36
- package/src/docs/docs/reference/plugins/nest.md +0 -38
- package/src/docs/docs/reference/plugins/netlify.md +0 -42
- package/src/docs/docs/reference/plugins/next-intl.md +0 -33
- package/src/docs/docs/reference/plugins/next-mdx.md +0 -36
- package/src/docs/docs/reference/plugins/next.md +0 -53
- package/src/docs/docs/reference/plugins/nitro.md +0 -50
- package/src/docs/docs/reference/plugins/node-modules-inspector.md +0 -45
- package/src/docs/docs/reference/plugins/node.md +0 -48
- package/src/docs/docs/reference/plugins/nodemon.md +0 -27
- package/src/docs/docs/reference/plugins/npm-package-json-lint.md +0 -38
- package/src/docs/docs/reference/plugins/nuxt.md +0 -49
- package/src/docs/docs/reference/plugins/nx.md +0 -57
- package/src/docs/docs/reference/plugins/nyc.md +0 -36
- package/src/docs/docs/reference/plugins/oclif.md +0 -33
- package/src/docs/docs/reference/plugins/oxlint.md +0 -44
- package/src/docs/docs/reference/plugins/parcel.md +0 -37
- package/src/docs/docs/reference/plugins/playwright-ct.md +0 -39
- package/src/docs/docs/reference/plugins/playwright-test.md +0 -26
- package/src/docs/docs/reference/plugins/playwright.md +0 -49
- package/src/docs/docs/reference/plugins/plop.md +0 -33
- package/src/docs/docs/reference/plugins/pnpm.md +0 -33
- package/src/docs/docs/reference/plugins/postcss.md +0 -43
- package/src/docs/docs/reference/plugins/preconstruct.md +0 -33
- package/src/docs/docs/reference/plugins/prettier.md +0 -36
- package/src/docs/docs/reference/plugins/prisma.md +0 -55
- package/src/docs/docs/reference/plugins/react-cosmos.md +0 -39
- package/src/docs/docs/reference/plugins/react-router.md +0 -34
- package/src/docs/docs/reference/plugins/relay.md +0 -52
- package/src/docs/docs/reference/plugins/release-it.md +0 -34
- package/src/docs/docs/reference/plugins/remark.md +0 -37
- package/src/docs/docs/reference/plugins/remix.md +0 -40
- package/src/docs/docs/reference/plugins/rollup.md +0 -47
- package/src/docs/docs/reference/plugins/rsbuild.md +0 -33
- package/src/docs/docs/reference/plugins/rslib.md +0 -33
- package/src/docs/docs/reference/plugins/rspack.md +0 -33
- package/src/docs/docs/reference/plugins/rstest.md +0 -33
- package/src/docs/docs/reference/plugins/semantic-release.md +0 -38
- package/src/docs/docs/reference/plugins/sentry.md +0 -35
- package/src/docs/docs/reference/plugins/simple-git-hooks.md +0 -35
- package/src/docs/docs/reference/plugins/size-limit.md +0 -35
- package/src/docs/docs/reference/plugins/sst.md +0 -33
- package/src/docs/docs/reference/plugins/starlight.md +0 -33
- package/src/docs/docs/reference/plugins/storybook.md +0 -44
- package/src/docs/docs/reference/plugins/stryker.md +0 -33
- package/src/docs/docs/reference/plugins/stylelint.md +0 -38
- package/src/docs/docs/reference/plugins/svelte.md +0 -34
- package/src/docs/docs/reference/plugins/sveltekit.md +0 -33
- package/src/docs/docs/reference/plugins/svgo.md +0 -37
- package/src/docs/docs/reference/plugins/svgr.md +0 -40
- package/src/docs/docs/reference/plugins/swc.md +0 -33
- package/src/docs/docs/reference/plugins/syncpack.md +0 -38
- package/src/docs/docs/reference/plugins/tailwind.md +0 -33
- package/src/docs/docs/reference/plugins/tanstack-router.md +0 -48
- package/src/docs/docs/reference/plugins/taskfile.md +0 -40
- package/src/docs/docs/reference/plugins/travis.md +0 -33
- package/src/docs/docs/reference/plugins/ts-node.md +0 -27
- package/src/docs/docs/reference/plugins/tsdown.md +0 -45
- package/src/docs/docs/reference/plugins/tsup.md +0 -45
- package/src/docs/docs/reference/plugins/tsx.md +0 -46
- package/src/docs/docs/reference/plugins/typedoc.md +0 -49
- package/src/docs/docs/reference/plugins/typescript.md +0 -50
- package/src/docs/docs/reference/plugins/unbuild.md +0 -33
- package/src/docs/docs/reference/plugins/unocss.md +0 -36
- package/src/docs/docs/reference/plugins/vercel-og.md +0 -38
- package/src/docs/docs/reference/plugins/vike.md +0 -34
- package/src/docs/docs/reference/plugins/vite.md +0 -48
- package/src/docs/docs/reference/plugins/vitepress.md +0 -34
- package/src/docs/docs/reference/plugins/vitest.md +0 -50
- package/src/docs/docs/reference/plugins/vue.md +0 -33
- package/src/docs/docs/reference/plugins/webdriver-io.md +0 -33
- package/src/docs/docs/reference/plugins/webpack.md +0 -48
- package/src/docs/docs/reference/plugins/wireit.md +0 -33
- package/src/docs/docs/reference/plugins/wrangler.md +0 -33
- package/src/docs/docs/reference/plugins/xo.md +0 -40
- package/src/docs/docs/reference/plugins/yarn.md +0 -33
- package/src/docs/docs/reference/plugins/yorkie.md +0 -33
- package/src/docs/docs/reference/plugins.md +0 -140
- package/src/docs/docs/reference/related-tooling.md +0 -46
- package/src/docs/docs/sponsors.mdx +0 -64
- package/src/docs/docs/typescript/unused-dependencies.md +0 -86
- package/src/docs/docs/typescript/unused-exports.md +0 -87
- package/src/docs/docs/writing-a-plugin/argument-parsing.md +0 -202
- package/src/docs/docs/writing-a-plugin/index.md +0 -392
- package/src/docs/docs/writing-a-plugin/inputs.md +0 -162
- package/src/docs/reference/plugins/angular.md +0 -33
- package/src/docs/reference/plugins/astro-db.md +0 -34
- package/src/docs/reference/plugins/astro.md +0 -43
- package/src/docs/reference/plugins/ava.md +0 -46
- package/src/docs/reference/plugins/babel.md +0 -38
- package/src/docs/reference/plugins/biome.md +0 -34
- package/src/docs/reference/plugins/bumpp.md +0 -38
- package/src/docs/reference/plugins/bun.md +0 -33
- package/src/docs/reference/plugins/c8.md +0 -26
- package/src/docs/reference/plugins/capacitor.md +0 -35
- package/src/docs/reference/plugins/changelogen.md +0 -38
- package/src/docs/reference/plugins/changelogithub.md +0 -38
- package/src/docs/reference/plugins/changesets.md +0 -33
- package/src/docs/reference/plugins/commitizen.md +0 -35
- package/src/docs/reference/plugins/commitlint.md +0 -39
- package/src/docs/reference/plugins/convex.md +0 -34
- package/src/docs/reference/plugins/create-typescript-app.md +0 -33
- package/src/docs/reference/plugins/cspell.md +0 -36
- package/src/docs/reference/plugins/cucumber.md +0 -36
- package/src/docs/reference/plugins/cypress.md +0 -40
- package/src/docs/reference/plugins/danger.md +0 -33
- package/src/docs/reference/plugins/dependency-cruiser.md +0 -44
- package/src/docs/reference/plugins/docusaurus.md +0 -39
- package/src/docs/reference/plugins/dotenv.md +0 -24
- package/src/docs/reference/plugins/drizzle.md +0 -33
- package/src/docs/reference/plugins/eleventy.md +0 -38
- package/src/docs/reference/plugins/eslint.md +0 -74
- package/src/docs/reference/plugins/expo.md +0 -38
- package/src/docs/reference/plugins/gatsby.md +0 -46
- package/src/docs/reference/plugins/github-action.md +0 -33
- package/src/docs/reference/plugins/github-actions.md +0 -34
- package/src/docs/reference/plugins/glob.md +0 -26
- package/src/docs/reference/plugins/graphql-codegen.md +0 -43
- package/src/docs/reference/plugins/hardhat.md +0 -33
- package/src/docs/reference/plugins/husky.md +0 -37
- package/src/docs/reference/plugins/i18next-parser.md +0 -44
- package/src/docs/reference/plugins/jest.md +0 -50
- package/src/docs/reference/plugins/karma.md +0 -36
- package/src/docs/reference/plugins/ladle.md +0 -40
- package/src/docs/reference/plugins/lefthook.md +0 -43
- package/src/docs/reference/plugins/lint-staged.md +0 -45
- package/src/docs/reference/plugins/linthtml.md +0 -38
- package/src/docs/reference/plugins/lockfile-lint.md +0 -38
- package/src/docs/reference/plugins/lost-pixel.md +0 -33
- package/src/docs/reference/plugins/markdownlint.md +0 -34
- package/src/docs/reference/plugins/mdx.md +0 -37
- package/src/docs/reference/plugins/mdxlint.md +0 -35
- package/src/docs/reference/plugins/metro.md +0 -46
- package/src/docs/reference/plugins/mocha.md +0 -48
- package/src/docs/reference/plugins/moonrepo.md +0 -35
- package/src/docs/reference/plugins/msw.md +0 -36
- package/src/docs/reference/plugins/nano-staged.md +0 -36
- package/src/docs/reference/plugins/nest.md +0 -38
- package/src/docs/reference/plugins/netlify.md +0 -42
- package/src/docs/reference/plugins/next-intl.md +0 -33
- package/src/docs/reference/plugins/next-mdx.md +0 -36
- package/src/docs/reference/plugins/next.md +0 -53
- package/src/docs/reference/plugins/node-modules-inspector.md +0 -45
- package/src/docs/reference/plugins/node.md +0 -48
- package/src/docs/reference/plugins/nodemon.md +0 -27
- package/src/docs/reference/plugins/npm-package-json-lint.md +0 -38
- package/src/docs/reference/plugins/nuxt.md +0 -49
- package/src/docs/reference/plugins/nx.md +0 -57
- package/src/docs/reference/plugins/nyc.md +0 -36
- package/src/docs/reference/plugins/oclif.md +0 -33
- package/src/docs/reference/plugins/oxlint.md +0 -44
- package/src/docs/reference/plugins/playwright-ct.md +0 -39
- package/src/docs/reference/plugins/playwright-test.md +0 -26
- package/src/docs/reference/plugins/playwright.md +0 -49
- package/src/docs/reference/plugins/plop.md +0 -33
- package/src/docs/reference/plugins/pnpm.md +0 -33
- package/src/docs/reference/plugins/postcss.md +0 -43
- package/src/docs/reference/plugins/preconstruct.md +0 -33
- package/src/docs/reference/plugins/prettier.md +0 -36
- package/src/docs/reference/plugins/prisma.md +0 -55
- package/src/docs/reference/plugins/react-cosmos.md +0 -39
- package/src/docs/reference/plugins/react-router.md +0 -34
- package/src/docs/reference/plugins/relay.md +0 -52
- package/src/docs/reference/plugins/release-it.md +0 -34
- package/src/docs/reference/plugins/remark.md +0 -37
- package/src/docs/reference/plugins/remix.md +0 -40
- package/src/docs/reference/plugins/rollup.md +0 -47
- package/src/docs/reference/plugins/rsbuild.md +0 -33
- package/src/docs/reference/plugins/rslib.md +0 -33
- package/src/docs/reference/plugins/rspack.md +0 -33
- package/src/docs/reference/plugins/rstest.md +0 -33
- package/src/docs/reference/plugins/semantic-release.md +0 -38
- package/src/docs/reference/plugins/sentry.md +0 -35
- package/src/docs/reference/plugins/simple-git-hooks.md +0 -35
- package/src/docs/reference/plugins/size-limit.md +0 -36
- package/src/docs/reference/plugins/sst.md +0 -33
- package/src/docs/reference/plugins/starlight.md +0 -33
- package/src/docs/reference/plugins/storybook.md +0 -44
- package/src/docs/reference/plugins/stryker.md +0 -33
- package/src/docs/reference/plugins/stylelint.md +0 -38
- package/src/docs/reference/plugins/svelte.md +0 -37
- package/src/docs/reference/plugins/svgo.md +0 -37
- package/src/docs/reference/plugins/svgr.md +0 -40
- package/src/docs/reference/plugins/swc.md +0 -33
- package/src/docs/reference/plugins/syncpack.md +0 -38
- package/src/docs/reference/plugins/tailwind.md +0 -33
- package/src/docs/reference/plugins/taskfile.md +0 -34
- package/src/docs/reference/plugins/travis.md +0 -33
- package/src/docs/reference/plugins/ts-node.md +0 -27
- package/src/docs/reference/plugins/tsdown.md +0 -45
- package/src/docs/reference/plugins/tsup.md +0 -45
- package/src/docs/reference/plugins/tsx.md +0 -46
- package/src/docs/reference/plugins/typedoc.md +0 -49
- package/src/docs/reference/plugins/typescript.md +0 -50
- package/src/docs/reference/plugins/unbuild.md +0 -33
- package/src/docs/reference/plugins/unocss.md +0 -36
- package/src/docs/reference/plugins/vercel-og.md +0 -38
- package/src/docs/reference/plugins/vike.md +0 -34
- package/src/docs/reference/plugins/vite.md +0 -48
- package/src/docs/reference/plugins/vitest.md +0 -50
- package/src/docs/reference/plugins/vue.md +0 -33
- package/src/docs/reference/plugins/webdriver-io.md +0 -33
- package/src/docs/reference/plugins/webpack.md +0 -48
- package/src/docs/reference/plugins/wireit.md +0 -33
- package/src/docs/reference/plugins/wrangler.md +0 -33
- package/src/docs/reference/plugins/xo.md +0 -40
- package/src/docs/reference/plugins/yarn.md +0 -33
- package/src/docs/reference/plugins/yorkie.md +0 -33
- /package/src/docs/{docs/reference → reference}/configuration-hints.md +0 -0
- /package/src/docs/{docs/reference → reference}/integrations.md +0 -0
|
@@ -23,8 +23,7 @@ Knip is intentionally strict to maximize its potential. It may initially report
|
|
|
23
23
|
many unused files. However, getting this right will result in great reports and
|
|
24
24
|
tidy codebases.
|
|
25
25
|
|
|
26
|
-
If it doesn't
|
|
27
|
-
change go a long way towards success.
|
|
26
|
+
If it doesn't work out at first, a small change can go a long way.
|
|
28
27
|
|
|
29
28
|
:::
|
|
30
29
|
|
|
@@ -33,9 +32,8 @@ change go a long way towards success.
|
|
|
33
32
|
Knip reports lint issues in your codebase. See [handling issues][5] to deal with
|
|
34
33
|
the reported issues.
|
|
35
34
|
|
|
36
|
-
If
|
|
37
|
-
|
|
38
|
-
reproduction][6] first.
|
|
35
|
+
If you're considering filing an issue, please read [issue reproduction][6]
|
|
36
|
+
first.
|
|
39
37
|
|
|
40
38
|
Exit code 1 indicates a successful run, but lint issues were found.
|
|
41
39
|
|
|
@@ -47,8 +45,7 @@ See [known issues][7] as it may be listed there and a workaround may be
|
|
|
47
45
|
available. If it isn't clear what's throwing the exception, try another run with
|
|
48
46
|
`--debug` to locate the cause of the issue with more details.
|
|
49
47
|
|
|
50
|
-
If
|
|
51
|
-
do! It'll make Knip better for everyone. Please read [issue reproduction][6]
|
|
48
|
+
If you're considering filing an issue, please read [issue reproduction][6]
|
|
52
49
|
first.
|
|
53
50
|
|
|
54
51
|
Exit code 2 indicates an exception was thrown by Knip.
|
|
@@ -93,7 +90,7 @@ a regex that works too:
|
|
|
93
90
|
|
|
94
91
|
<img src="/screenshots/trace-dependency.png" alt="trace dependency" class="mw500" />
|
|
95
92
|
|
|
96
|
-
Use [--workspace \[
|
|
93
|
+
Use [--workspace \[filter\]][8] to filter accordingly.
|
|
97
94
|
|
|
98
95
|
#### Legend
|
|
99
96
|
|
|
@@ -124,10 +121,10 @@ to [open an issue on GitHub][14].
|
|
|
124
121
|
[2]: #exceptions-thrown-by-knip
|
|
125
122
|
[3]: #debug
|
|
126
123
|
[4]: #trace
|
|
127
|
-
[5]: ../guides/handling-issues.
|
|
124
|
+
[5]: ../guides/handling-issues.mdx
|
|
128
125
|
[6]: ./issue-reproduction.md
|
|
129
126
|
[7]: ../reference/known-issues.md
|
|
130
|
-
[8]: ../reference/cli.md#--workspace-
|
|
127
|
+
[8]: ../reference/cli.md#--workspace-filter
|
|
131
128
|
[9]: ../explanations/entry-files.md
|
|
132
129
|
[10]: ../explanations/plugins.md
|
|
133
130
|
[11]: ../features/production-mode.md
|
|
@@ -21,10 +21,12 @@ on: push
|
|
|
21
21
|
jobs:
|
|
22
22
|
lint:
|
|
23
23
|
runs-on: ubuntu-latest
|
|
24
|
-
name: Ubuntu/Node
|
|
24
|
+
name: Ubuntu/Node v24
|
|
25
25
|
steps:
|
|
26
26
|
- uses: actions/checkout@v4
|
|
27
27
|
- uses: actions/setup-node@v4
|
|
28
|
+
with:
|
|
29
|
+
node-version: 24
|
|
28
30
|
- name: Install dependencies
|
|
29
31
|
run: npm install --ignore-scripts
|
|
30
32
|
- name: Run knip
|
|
@@ -33,22 +35,16 @@ jobs:
|
|
|
33
35
|
|
|
34
36
|
## Notes
|
|
35
37
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
- [
|
|
41
|
-
-
|
|
42
|
-
- [--no-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
[1]: ../reference/cli.md#--no-progress
|
|
50
|
-
[2]: ../reference/cli.md#--cache
|
|
51
|
-
[3]: ../reference/cli.md#--max-issues
|
|
52
|
-
[4]: ../reference/cli.md#--no-exit-code
|
|
53
|
-
[5]: ../reference/cli.md#--reporter-reporter
|
|
54
|
-
[6]: ../explanations/why-use-knip.md
|
|
38
|
+
- Use [--cache][1] to speed up consecutive runs (default location:
|
|
39
|
+
`./node_modules/.cache/knip`).
|
|
40
|
+
- See [Reporters][2] including the GitHub Actions reporter.
|
|
41
|
+
- Consider running Knip twice: a default run and a [production mode][3] run.
|
|
42
|
+
- See [CLI arguments → Output][4] for some relevant options such as
|
|
43
|
+
`--treat-config-hints-as-errors` and `--no-exit-code`.
|
|
44
|
+
- In CI environments, the [--no-progress][5] flag is set automatically.
|
|
45
|
+
|
|
46
|
+
[1]: ../reference/cli.md#--cache
|
|
47
|
+
[2]: ../features/reporters.md
|
|
48
|
+
[3]: ../features/production-mode.md
|
|
49
|
+
[4]: ../reference/cli.md#output
|
|
50
|
+
[5]: ../reference/cli.md#--no-progress
|
package/src/docs/index.mdx
CHANGED
|
@@ -31,7 +31,7 @@ import Contributors from '../../components/Contributors.astro';
|
|
|
31
31
|
|
|
32
32
|
:::section{.badges}
|
|
33
33
|
|
|
34
|
-
[![NPM Version][2]][1] [![NPM Downloads][3]][1] [![GitHub Repo
|
|
34
|
+
[![NPM Version][2]][1] [![NPM Downloads][3]][1] [![GitHub Repo stars][5]][4]
|
|
35
35
|
|
|
36
36
|
:::
|
|
37
37
|
|
|
@@ -138,10 +138,10 @@ A curated selection of articles about Knip, most recent first:
|
|
|
138
138
|
[3]: https://img.shields.io/npm/dm/knip?color=f56e0f
|
|
139
139
|
[4]: https://github.com/webpro-nl/knip
|
|
140
140
|
[5]: https://img.shields.io/github/stars/webpro-nl/knip?style=flat&color=f56e0f
|
|
141
|
-
[6]:
|
|
141
|
+
[6]: /sponsors
|
|
142
142
|
[7]: https://webpro.nl/hire-me
|
|
143
143
|
[8]: ./reference/plugins.md
|
|
144
|
-
[9]:
|
|
144
|
+
[9]: /playground
|
|
145
145
|
[10]: ./guides/troubleshooting.md
|
|
146
146
|
[11]: https://www.jamesshopland.com
|
|
147
147
|
[12]: https://blog.val.town/gardening-dependencies
|
|
@@ -52,10 +52,9 @@ folder:
|
|
|
52
52
|
}
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
from the analysis. See [configuring project files][1] for details.
|
|
55
|
+
The set of `project` files determines the analysis scope. Use negated `project`
|
|
56
|
+
patterns to exclude files from the analysis. See [configuring project files][1]
|
|
57
|
+
for details.
|
|
59
58
|
|
|
60
59
|
The values you set override the default values, they are not merged.
|
|
61
60
|
|
|
@@ -64,8 +63,9 @@ The values you set override the default values, they are not merged.
|
|
|
64
63
|
Be specific with `entry` files. Minimize the number of entry files and wildcards
|
|
65
64
|
for better results.
|
|
66
65
|
|
|
67
|
-
Plugins are enabled automatically, and
|
|
68
|
-
Next.js, Astro, Remix, Vitest, Playwright and many
|
|
66
|
+
Plugins are enabled automatically, and their entry files are added
|
|
67
|
+
automatically. Such as for Next.js, Astro, Remix, Vitest, Playwright and many
|
|
68
|
+
more.
|
|
69
69
|
|
|
70
70
|
:::
|
|
71
71
|
|
|
@@ -19,7 +19,7 @@ Also see [related tooling][2].
|
|
|
19
19
|
| Configuration hints | Display configuration hints to keep `knip.json` tidy |
|
|
20
20
|
| [Debug][7] | Use `--debug` for troubleshooting |
|
|
21
21
|
| [Filters][8] | Exclude or focus on specific issue types |
|
|
22
|
-
| [Format][9] |
|
|
22
|
+
| [Format][9] | Use `--format` with `--fix` to auto-format modified files |
|
|
23
23
|
| [JSDoc tags][10] | Tag and exclude specific exports from the report |
|
|
24
24
|
| [Memory usage][11] | Use `--memory` for detailed memory usage insights |
|
|
25
25
|
| [Monorepos][12] | Workspaces are first-class citizen |
|
|
@@ -33,10 +33,10 @@ Also see [related tooling][2].
|
|
|
33
33
|
| [Rules][20] | Exclude or focus on specific issue types |
|
|
34
34
|
| [Script parser][21] | Shell scripts and `package.json` contain entry paths and dependencies |
|
|
35
35
|
| [Source mapping][22] | Map `dist` files back to `src` files |
|
|
36
|
-
| [Strict mode][23] | Use `--strict` to
|
|
36
|
+
| [Strict mode][23] | Use `--strict` to tighten and lint only production `dependencies` |
|
|
37
37
|
| [Trace][24] | Trace exports to find where they are used |
|
|
38
38
|
| [Watch mode][25] | Use `--watch` for live updates of unused files and exports |
|
|
39
|
-
| [Workspace][26] | Use `--workspace` to
|
|
39
|
+
| [Workspace][26] | Use `--workspace` to filter workspaces in a monorepo |
|
|
40
40
|
|
|
41
41
|
[1]: ../reference/issue-types.md
|
|
42
42
|
[2]: ../reference/related-tooling.md
|
|
@@ -44,7 +44,7 @@ Also see [related tooling][2].
|
|
|
44
44
|
[4]: ../reference/cli.md#--cache
|
|
45
45
|
[5]: ../guides/working-with-commonjs.md
|
|
46
46
|
[6]: ../features/compilers.md
|
|
47
|
-
[7]: ../guides/troubleshooting.md#
|
|
47
|
+
[7]: ../guides/troubleshooting.md#debug
|
|
48
48
|
[8]: ../features/rules-and-filters.md#filters
|
|
49
49
|
[9]: ../features/auto-fix.mdx#format
|
|
50
50
|
[10]: ../reference/jsdoc-tsdoc-tags.md
|
|
@@ -63,4 +63,4 @@ Also see [related tooling][2].
|
|
|
63
63
|
[23]: ../features/production-mode.md#strict-mode
|
|
64
64
|
[24]: ../guides/troubleshooting.md#trace
|
|
65
65
|
[25]: ../reference/cli.md#--watch
|
|
66
|
-
[26]: ../features/monorepos-and-workspaces#
|
|
66
|
+
[26]: ../features/monorepos-and-workspaces.md#filter-workspaces
|
|
@@ -75,9 +75,18 @@ Knip will lint your project and report unused dependencies, exports and files.
|
|
|
75
75
|
If the output makes sense to you, feel free to go to the next page:
|
|
76
76
|
[configuration][2].
|
|
77
77
|
|
|
78
|
+
:::tip
|
|
79
|
+
|
|
80
|
+
Try the [Knip Editor Extension][3]! Let your coding agent use the built-in MCP
|
|
81
|
+
Server and create a custom `knip.json` for you.
|
|
82
|
+
|
|
83
|
+
:::
|
|
84
|
+
|
|
78
85
|
## Too Much?
|
|
79
86
|
|
|
80
|
-
In large or complex codebases the output might be overwhelming.
|
|
87
|
+
In large or complex codebases the output might be overwhelming.
|
|
88
|
+
|
|
89
|
+
Start by
|
|
81
90
|
limiting the number of shown issues per type:
|
|
82
91
|
|
|
83
92
|
<Tabs syncKey="pm">
|
|
@@ -108,12 +117,12 @@ limiting the number of shown issues per type:
|
|
|
108
117
|
|
|
109
118
|
The output is easier to digest and may include some configuration hints to get
|
|
110
119
|
an idea of what's left to configure. Many unused files? Go to [configuration][2]
|
|
111
|
-
and follow up with [troubleshooting][
|
|
120
|
+
and follow up with [troubleshooting][4] if needed.
|
|
112
121
|
|
|
113
122
|
:::tip
|
|
114
123
|
|
|
115
124
|
Do not use the `ignore` option just to get rid of unwanted output. Read
|
|
116
|
-
[Configuring Project Files][
|
|
125
|
+
[Configuring Project Files][5] to get the most out of Knip.
|
|
117
126
|
|
|
118
127
|
:::
|
|
119
128
|
|
|
@@ -191,5 +200,6 @@ already.
|
|
|
191
200
|
|
|
192
201
|
[1]: /playground
|
|
193
202
|
[2]: ./configuration.md
|
|
194
|
-
[3]: ../
|
|
195
|
-
[4]: ../guides/
|
|
203
|
+
[3]: ../blog/for-editors-and-agents.md
|
|
204
|
+
[4]: ../guides/troubleshooting.md
|
|
205
|
+
[5]: ../guides/configuring-project-files.md
|