@knip/mcp 0.0.16 → 0.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knip/mcp",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "description": "Knip MCP Server",
   "type": "module",
   "bin": {
@@ -28,7 +28,7 @@
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.25.1",
     "zod": "^4.1.11",
-    "knip": "^5.81.0"
+    "knip": "^5.83.0"
   },
   "engines": {
     "node": ">=18.18.0"

package/src/docs/docs/features/auto-fix.mdx

@@ -9,13 +9,13 @@ Run Knip as you normally would, and if the report looks good then run it again
 with the `--fix` flag to let Knip automatically apply fixes. It fixes the
 following [issue types][1]:
 
-- Remove `export` keyword for unused exports and exported types
+- Remove `export` keyword for unused exports, re-exports, and exported types
 - Remove `export default` keywords for unused default exports
-- Remove exports, re-exports and exported types
 - Remove unused enum members
 - Remove unused class members (disabled by default)
 - Remove unused `dependencies` and `devDependencies` from `package.json`
 - Remove unused files
+- Remove unused catalog entries
 
 :::caution
 
@@ -91,9 +91,9 @@ configuration in your project.
 
 ### 2. Unused variables
 
-Use a tool like ESLint or Biome to find and remove unused variables inside
-files. Even better, try [remove-unused-vars][3] to remove unused variables
-within files.
+Use a tool like ESLint or Biome to find and remove unused imports and variables
+inside files. Even better, try [remove-unused-vars][3] to remove unused
+variables within files.
 
 This may result in more deleted code, and Knip may then find more unused code.
 Rinse and repeat!
@@ -316,6 +316,20 @@ component are unused and will remove those.
 
 Note that [`classMembers` aren't included by default][4].
 
+### Catalog entries
+
+Unused [catalog][5] entries are removed from `pnpm-workspace.yaml`:
+
+```diff title="pnpm-workspace.yaml"
+ packages:
+   - 'packages/*'
+ catalog:
+   react: ^18.0.0
+-  unused-package: ^1.0.0
+```
+
+Catalogs in `package.json` are supported as well.
+
 ## What's not included
 
 Operations that auto-fix does not (yet) perform and why:
@@ -331,3 +345,4 @@ Operations that auto-fix does not (yet) perform and why:
 [2]: https://github.com/JoshuaKGoldberg/formatly
 [3]: https://github.com/webpro-nl/remove-unused-vars
 [4]: ../guides/handling-issues.mdx#class-members
+[5]: https://pnpm.io/catalogs

package/src/docs/docs/features/production-mode.md

@@ -37,7 +37,7 @@ Here's what's included in production mode:
 - Only `entry` and `project` patterns suffixed with `!`
 - Only production `entry` file patterns exported by plugins (such as Next.js and
   Remix)
-- Only the `start` and `postinstall` scripts
+- Only the `start` script (of `package.json#scripts`)
 - Ignore exports with the [`@internal` tag][1]
 
 :::note

package/src/docs/docs/features/reporters.md

@@ -79,16 +79,18 @@ The keys match the [reported issue types][6]. Example usage:
 knip --reporter json
 ```
 
-### Github Actions
-
-TODO
+### GitHub Actions
 
+Use the GitHub Actions reporter in a workflow for annotations in pull requests.
 Example usage:
 
 ```sh
 knip --reporter github-actions
 ```
 
+Changed files in pull requests will now contain inline annotations for lint
+findings.
+
 ### Markdown
 
 The built-in `markdown` reporter output is meant to be saved to a Markdown file.
@@ -138,8 +140,8 @@ dangling.js
 <summary>Unused dependencies (2)</summary>
 
 ```
-unused-dep     package.json
-my-package     package.json
+my-package     package.json:17:5
+unused-dep     package.json:20:5
 ```
 
 </details>
@@ -162,8 +164,8 @@ dangling.js
   <summary>Unused dependencies (2)</summary>
 
 ```
-unused-dep     package.json
-my-package     package.json
+my-package     package.json:17:5
+unused-dep     package.json:20:5
 ```
 
 </details>

package/src/docs/docs/guides/handling-issues.mdx

@@ -17,6 +17,13 @@ files will also reduce the number of unused dependencies.
 3. [Unresolved imports][3]
 4. [Unused exports][4]
 
+:::tip
+
+Try the [Knip Editor Extension][5]! Let your coding agent use the built-in
+MCP Server and create a custom `knip.json` for you.
+
+:::
+
 ## Unused files
 
 Getting the list of unused files right trickles down into the other issue types
@@ -27,22 +34,29 @@ of `project` files, but not in the set of files resolved from the `entry` files:
 unused files = project files - (entry files + resolved files)
 ```
 
-Let's go over common causes for unused files:
+:::tip
+
+Addressing reported [Configuration Hints][6] first might help significantly,
+especially when handling unused files.
+
+:::
+
+Common causes for unused files include:
 
-- [Missing generated files][5]
-- [Dynamic import specifiers][6]
-- [Unsupported arguments in scripts][7]
-- [Unsupported file formats][8]
-- [Missing plugin][9]
-- [Incomplete plugin][10]
-- [TypeScript path aliases in monorepos][11]
-- [Relative paths across workspaces][12]
-- [Integrated monorepos][13]
-- [Auto-mocking or auto-imports][14]
+- [Missing generated files][7]
+- [Dynamic import specifiers][8]
+- [Unsupported arguments in scripts][9]
+- [Unsupported file formats][10]
+- [Missing plugin][11]
+- [Incomplete plugin][12]
+- [TypeScript path aliases in monorepos][13]
+- [Relative paths across workspaces][14]
+- [Integrated monorepos][15]
+- [Auto-mocking or auto-imports][16]
 
 In most cases you can add `entry` patterns manually.
 
-Use `--files` to [filter the report][15] and focus only on unused files:
+Use `--files` to [filter the report][17] and focus only on unused files:
 
 ```sh
 knip --files
@@ -55,15 +69,15 @@ exports.
 :::caution
 
 Don't add unused files to the `ignore` option before reading [configuring
-project files][16]. Learn why and when to use `entry`, `project`, production
-mode and `ignore` patterns for better results and performance.
+project files][18]. Learn why and when to use `entry`, `project`, production
+mode and `ignore*` patterns for better results and performance.
 
 :::
 
 ### Missing generated files
 
 For certain features, Knip needs to run after relevant files are generated. For
-instance, [source mapping][17] in a monorepo may require files to be built into
+instance, [source mapping][19] in a monorepo may require files to be built into
 `dist` folders first. And generated files in the `src` directory may import
 other files. For instance, the `src/routeTree.gen.ts` file generated by
 `@tanstack/router` must exist so Knip can find the imported route files.
@@ -101,7 +115,7 @@ Some tooling command arguments aren't recognized:
 **Solution**: add `production.ts` to `entry` patterns.
 
 This works the same for any script, also those in GitHub Actions workflows or
-Git hooks. See [script parser][18] for more details about Knip's script parser.
+Git hooks. See [script parser][20] for more details about Knip's script parser.
 
 ### Unsupported file formats
 
@@ -118,7 +132,7 @@ Entry files referenced in HTML files (e.g. `<script src="production.js">`).
 **Solution**: add `production.js` to `entry` patterns. Or add an `.html`
 compiler to extract and resolve the value of `<script src>` elements.
 
-Knip has support for some popular framework formats through [compilers][19], and
+Knip has support for some popular framework formats through [compilers][21], and
 additional compilers can be added for any file type. The recommended solution is
 usually to add the file as shown in each example as an `entry` file.
 
@@ -134,16 +148,16 @@ examples:
 - A framework automatically imports all files matching `src/models/*.ts` → those
   files are reported as unused.
 
-**Solution**: [create a new plugin][20] for the tool or framework that's not [in
-the list][21] yet. Or work around it and add `entry` patterns and maybe ignore a
-dependency or two (using [`ignoreDependencies`][22]).
+**Solution**: [create a new plugin][22] for the tool or framework that's not [in
+the list][23] yet. Or work around it and add `entry` patterns and maybe ignore a
+dependency or two (using [`ignoreDependencies`][24]).
 
 ### Incomplete plugin
 
 Files may be reported as unused if existing plugins do not include that entry
-file pattern yet. See the [plugins section of entry files][23] for more details.
+file pattern yet. See the [plugins section of entry files][25] for more details.
 
-**Solution**: [override plugin configuration][24] to customize default patterns
+**Solution**: [override plugin configuration][26] to customize default patterns
 for existing plugins. Or even better: send a pull request to improve the plugin.
 
 ### TypeScript path aliases in monorepos
@@ -179,7 +193,7 @@ Knip, it's better to be explicit and list other workspaces as dependencies in
 An additional benefit is that Knip will report unused and unlisted dependencies
 from now on.
 
-Also see [FAQ: Why can't I use path aliases to reference other workspaces?][25]
+Also see [FAQ: Why can't I use path aliases to reference other workspaces?][27]
 
 ### Relative paths across workspaces
 
@@ -202,7 +216,7 @@ import { something } from '@org/common';
 An additional benefit is that Knip will report unused and unlisted dependencies
 from now on.
 
-Also see [TypeScript path aliases in monorepos][11].
+Also see [TypeScript path aliases in monorepos][13].
 
 ### Integrated monorepos
 
@@ -210,7 +224,7 @@ Multiple instances of configuration files like `.eslintrc` and
 `jest.config.json` across the repository may be reported as unused when working
 in a (mono)repo with a single `package.json`.
 
-**Solution**: see [integrated monorepos][26] for more details and how to
+**Solution**: see [integrated monorepos][28] for more details and how to
 configure plugins to target those configuration files.
 
 ### Auto-mocking or auto-imports
@@ -245,12 +259,12 @@ unused dependencies.
 
 The most common causes for unused dependencies include:
 
-- [Missing or incomplete plugins][27]
-- [Unrecognized references][28]
-- [Type Definition Packages][29]
-- [Dependencies named after Node.js builtins][30]
+- [Missing or incomplete plugins][29]
+- [Unrecognized references][30]
+- [Type Definition Packages][31]
+- [Dependencies named after Node.js builtins][32]
 
-Use `--dependencies` to [filter the report][15] and focus only on issues related
+Use `--dependencies` to [filter the report][17] and focus only on issues related
 to dependencies:
 
 ```sh
@@ -281,10 +295,10 @@ Sometimes a reference to a dependency is unrecognizable or unreachable to Knip,
 so it's a false positive and incorrectly reported as unused.
 
 **Solution**: add a new plugin or improve an existing one. If you don't feel
-like a plugin could solve it, a last resort is to use [ignoreDependencies][22].
+like a plugin could solve it, a last resort is to use [ignoreDependencies][24].
 
 If a binary (or "executable") is referenced you'll want to use `ignoreBinaries`
-instead. See [unlisted binaries][31].
+instead. See [unlisted binaries][33].
 
 ### Dependencies named after Node.js builtins
 
@@ -292,7 +306,7 @@ Some packages have the same name as a Node.js builtin (for instance `buffer` or
 `process`).
 
 **Solution**: if Knip reports such a dependency as unused, add it to
-[ignoreDependencies][22].
+[ignoreDependencies][24].
 
 ### Conditional or dynamic dependencies
 
@@ -322,7 +336,7 @@ reported as unused.
 This limitation exists because Knip executes configuration files to parse their
 exported value. While Knip can parse configuration files statically using AST
 (Abstract Syntax Tree) analysis, this approach becomes complex very quickly and
-most of the time it is easier to use the [`ignoreDependencies`][22]
+most of the time it is easier to use the [`ignoreDependencies`][24]
 configuration option for conditionals.
 
 ```json title="knip.json"
@@ -360,7 +374,7 @@ In strict production mode, even when re-exported and part of the package's
 public API, Knip does not try to figure out what exactly are "production types"
 and expects those in `devDependencies`.
 
-**Solution**: list exceptions in [ignoreDependencies][22].
+**Solution**: list exceptions in [ignoreDependencies][24].
 
 ### Unlisted dependencies
 
@@ -392,7 +406,7 @@ reported as an unlisted binary as there is no package that contains it.
 
 Binaries that are installed on the OS already and thus likely not meant to be
 installed from npm are not reported as unlisted (details: [list of ignored
-binaries in source][32]).
+binaries in source][34]).
 
 #### Missing binaries
 
@@ -402,7 +416,7 @@ either the way your package manager installs dependencies and binaries, or by
 not running Knip from the root of the repository.
 
 **Solution**: run Knip from the project root. If needed, [lint workspaces
-individually][33].
+individually][35].
 
 Sometimes binaries and how they're reported can be a bit confusing. See this
 example:
@@ -438,10 +452,10 @@ or consider the binary and package(s) referenced, respectively.
 Knip may ignore or be unable to resolve an import specifier or dependency
 references. The most common causes for unresolved imports:
 
-- [Template strings][34]
-- [Extensionless imports][28]
-- [Unrecognized path aliases][35]
-- [External aliased imports][36]
+- [Template strings][36]
+- [Extensionless imports][30]
+- [Unrecognized path aliases][37]
+- [External aliased imports][38]
 
 ### Template strings
 
@@ -478,19 +492,19 @@ browsers) require a file extension for import specifiers.
 
 ### Unrecognized path aliases
 
-Knip considers TS config path aliases and [paths configured in knip.json][37],
+Knip considers TS config path aliases and [paths configured in knip.json][39],
 but not those in e.g. Webpack or Vite configurations.
 
-**Solution**: configure [paths][37] or try relative imports. Otherwise, use
-[`ignoreUnresolved`][38] as a last resort.
+**Solution**: configure [paths][39] or try relative imports. Otherwise, use
+[`ignoreUnresolved`][40] as a last resort.
 
 ### External aliased imports
 
 External libraries may use aliased imports that aren't resolved by Knip.
 
-For instance, [unplugin-icons][39] does this to import icons from icon sets as
+For instance, [unplugin-icons][41] does this to import icons from icon sets as
 components. Such imports are reported as unused. Use the [`paths` configuration
-option][37] to tell Knip where to find the icon types:
+option][39] to tell Knip where to find the icon types:
 
 ```json title="knip.json"
 {
@@ -501,9 +515,9 @@ option][37] to tell Knip where to find the icon types:
 ```
 
 Where `[framework]` is the name of the framework you're using (see [available
-types][40]).
+types][42]).
 
-**Solution**: try [--include-libs][41] or configure [paths][37].
+**Solution**: try [--include-libs][43] or configure [paths][39].
 
 ## Unused exports
 
@@ -511,17 +525,17 @@ By default, Knip does not report unused exports of `entry` files.
 
 The most common causes for unused exports include:
 
-- [Namespace enumerations][42]
-- [External libraries][43]
+- [Namespace enumerations][44]
+- [External libraries][45]
 
-Use the `--exports` flag to [filter][15] and focus only on issues related to
+Use the `--exports` flag to [filter][17] and focus only on issues related to
 exports:
 
 ```sh
 knip --exports
 ```
 
-Use [includeEntryExports][44] to report unused exports of entry files as well.
+Use [includeEntryExports][46] to report unused exports of entry files as well.
 This can be set per workspace.
 
 ### Namespace enumerations
@@ -533,7 +547,7 @@ are then **not** reported.
 **Solution**: if all exports on imported namespaces should be considered
 individually, include the `nsExports` issue type to disable the heuristic.
 
-See [namespace imports][45] to see all related patterns.
+See [namespace imports][47] to see all related patterns.
 
 ### External libraries
 
@@ -569,22 +583,22 @@ Knip does not include external type definitions by default so it won't see the
 export being referenced.
 
 **Solution**: include the type definitions of external libraries with the
-[--include-libs][41] flag:
+[--include-libs][43] flag:
 
 ```shell
 knip --include-libs
 ```
 
 This comes at a performance and memory penalty, but should give better results
-if you need it. This flag is implied when [classMembers][46] are included (that
+if you need it. This flag is implied when [classMembers][48] are included (that
 feature comes with roughly the same performance penalty).
 
 ### Exclude exports from the report
 
 To exclude false positives from the report, there are a few options:
 
-- [Ignore exports used in file][47] for exports used internally.
-- Individual exports can be [tagged using JSDoc syntax][48].
+- [Ignore exports used in file][49] for exports used internally.
+- Individual exports can be [tagged using JSDoc syntax][50].
 - Have the export in an entry file:
 
   - Add the file to the `entry` file patterns array in the configuration.
@@ -595,11 +609,11 @@ To exclude false positives from the report, there are a few options:
 ### Missing unused exports?
 
 Did you expect certain exports in the report, but are they missing? They might
-be exported from an entry file. In that case, use [--include-entry-exports][44]
+be exported from an entry file. In that case, use [--include-entry-exports][46]
 to make Knip also report unused exports in entry files.
 
 The exports of non-standard extensions like `.astro`, `.mdx`, `.vue` or
-`.svelte` are not available by default. See [compilers][19] for more details on
+`.svelte` are not available by default. See [compilers][21] for more details on
 how to include them.
 
 ### Class members
@@ -614,10 +628,10 @@ knip --include classMembers
 This option is also available in the Knip configuration file. Note that this
 feature comes at a cost: linting will take more time and more memory.
 
-Individual class members can be [tagged using JSDoc syntax][48].
+Individual class members can be [tagged using JSDoc syntax][50].
 
 Classes exported from entry files are ignored, and so are their members. Use
-[--include-entry-exports][44] to make Knip also report members of unused exports
+[--include-entry-exports][46] to make Knip also report members of unused exports
 in entry files.
 
 ### Enum members
@@ -629,64 +643,66 @@ Reporting such members can be disabled:
 knip --exclude enumMembers
 ```
 
-Individual enum members can be [tagged using JSDoc syntax][48].
+Individual enum members can be [tagged using JSDoc syntax][50].
 
 Enums exported from entry files are ignored, and so are their members. Use
-[--include-entry-exports][44] to make Knip also report members of unused exports
+[--include-entry-exports][46] to make Knip also report members of unused exports
 in entry files.
 
 ## Feedback or false positives?
 
 If you believe Knip incorrectly reports something as unused (i.e. there's a
-false positive), feel free to create a [minimal reproduction][49] and open an
+false positive), feel free to create a [minimal reproduction][51] and open an
 issue on GitHub. It'll make Knip better for everyone!
 
 [1]: #unused-files
 [2]: #unused-dependencies
 [3]: #unresolved-imports
 [4]: #unused-exports
-[5]: #missing-generated-files
-[6]: #dynamic-import-specifiers
-[7]: #unsupported-arguments-in-scripts
-[8]: #unsupported-file-formats
-[9]: #missing-plugin
-[10]: #incomplete-plugin
-[11]: #typescript-path-aliases-in-monorepos
-[12]: #relative-paths-across-workspaces
-[13]: #integrated-monorepos
-[14]: #auto-mocking-or-auto-imports
-[15]: ../features/rules-and-filters.md#filters
-[16]: ./configuring-project-files.md
-[17]: ../features/source-mapping.md
-[18]: ../features/script-parser.md
-[19]: ../features/compilers.md
-[20]: ../writing-a-plugin/index.md
-[21]: ../reference/plugins.md
-[22]: ../reference/configuration.md#ignoredependencies
-[23]: ../explanations/plugins.md#entry-files
-[24]: ../explanations/entry-files.md#plugins
-[25]: ../reference/faq.md#why-cant-i-use-path-aliases-to-reference-other-workspaces
-[26]: ../features/integrated-monorepos.md
-[27]: #missing-or-incomplete-plugin
-[28]: #unrecognized-reference
-[29]: #type-definition-packages
-[30]: #dependencies-named-after-nodejs-builtins
-[31]: #unlisted-binaries
-[32]: https://github.com/webpro-nl/knip/blob/e031018e676c47d84873cc2403251c0111ef318d/packages/knip/src/constants.ts#L39-L148
-[33]: ../features/monorepos-and-workspaces.md#lint-a-single-workspace
-[34]: #template-strings
-[35]: #unrecognized-path-aliases
-[36]: #external-aliased-imports
-[37]: ../reference/configuration.md#paths
-[38]: ../reference/configuration.md#ignoreunresolved
-[39]: https://www.npmjs.com/package/unplugin-icons
-[40]: https://github.com/unplugin/unplugin-icons/tree/main/types
-[41]: ../reference/cli.md#--include-libs
-[42]: #namespace-enumerations
-[43]: #external-libraries
-[44]: ../reference/configuration.md#includeentryexports
-[45]: ../guides/namespace-imports.md
-[46]: #class-members
-[47]: ../reference/configuration.md#ignoreexportsusedinfile
-[48]: ../reference/jsdoc-tsdoc-tags.md
-[49]: ../guides/issue-reproduction.md
+[5]: ../reference/integrations.md
+[6]: ../reference/configuration-hints.md
+[7]: #missing-generated-files
+[8]: #dynamic-import-specifiers
+[9]: #unsupported-arguments-in-scripts
+[10]: #unsupported-file-formats
+[11]: #missing-plugin
+[12]: #incomplete-plugin
+[13]: #typescript-path-aliases-in-monorepos
+[14]: #relative-paths-across-workspaces
+[15]: #integrated-monorepos
+[16]: #auto-mocking-or-auto-imports
+[17]: ../features/rules-and-filters.md#filters
+[18]: ./configuring-project-files.md
+[19]: ../features/source-mapping.md
+[20]: ../features/script-parser.md
+[21]: ../features/compilers.md
+[22]: ../writing-a-plugin/index.md
+[23]: ../reference/plugins.md
+[24]: ../reference/configuration.md#ignoredependencies
+[25]: ../explanations/plugins.md#entry-files
+[26]: ../explanations/entry-files.md#plugins
+[27]: ../reference/faq.md#why-cant-i-use-path-aliases-to-reference-other-workspaces
+[28]: ../features/integrated-monorepos.md
+[29]: #missing-or-incomplete-plugin
+[30]: #unrecognized-reference
+[31]: #type-definition-packages
+[32]: #dependencies-named-after-nodejs-builtins
+[33]: #unlisted-binaries
+[34]: https://github.com/webpro-nl/knip/blob/e031018e676c47d84873cc2403251c0111ef318d/packages/knip/src/constants.ts#L39-L148
+[35]: ../features/monorepos-and-workspaces.md#lint-a-single-workspace
+[36]: #template-strings
+[37]: #unrecognized-path-aliases
+[38]: #external-aliased-imports
+[39]: ../reference/configuration.md#paths
+[40]: ../reference/configuration.md#ignoreunresolved
+[41]: https://www.npmjs.com/package/unplugin-icons
+[42]: https://github.com/unplugin/unplugin-icons/tree/main/types
+[43]: ../reference/cli.md#--include-libs
+[44]: #namespace-enumerations
+[45]: #external-libraries
+[46]: ../reference/configuration.md#includeentryexports
+[47]: ../guides/namespace-imports.md
+[48]: #class-members
+[49]: ../reference/configuration.md#ignoreexportsusedinfile
+[50]: ../reference/jsdoc-tsdoc-tags.md
+[51]: ../guides/issue-reproduction.md

package/src/docs/docs/guides/issue-reproduction.md

@@ -19,6 +19,8 @@ influence the issue at hand, such as:
 - Dependent or depending workspaces in a monorepo
 - Knip configuration in `knip.json`
 
+## Keep it minimal
+
 Create the minimum of source code and configuration with a few files to
 reproduce and demonstrate the issue. Having this as a basis has many benefits:
 
@@ -30,6 +32,12 @@ reproduce and demonstrate the issue. Having this as a basis has many benefits:
 Providing this with an issue description will help us help you and improve the
 chances the issue can be looked into efficiently and in a timely manner.
 
+Useful **complements** to a minimal reproduction might include:
+
+- Screenshots, videos, code snippets or log output
+- Links to an existing project repository
+- Applications scaffolded by tools like Angular or Svelte CLI
+
 ## Before opening an issue
 
 Before opening an issue, please make sure you:
@@ -67,13 +75,9 @@ including:
 - A public repository on e.g. GitHub or GitLab.
 - A new [fixtures folder in the Knip repository][9].
 
-The goal is to have an easy and common understanding and reproduction. A link to
-your existing project repository will likely not be considered "minimal". Issues
-containing just a screenshot, or snippets of output or source code don't provide
-the full picture and aren't complete nor actionable.
-
-If you're unable to create a reproduction using one of the methods described
-then please clearly explain this in the issue or [contact me][10].
+The goal is to have an easy and common understanding and reproduction. If you're
+unable to create a reproduction using one of the methods described then please
+clearly explain this in the issue or [contact me][10].
 
 ## Pull Request