@knip/mcp 0.0.20 → 0.0.22

package/src/docs/docs/reference/jsdoc-tsdoc-tags.md

@@ -0,0 +1,133 @@
+---
+title: JSDoc & TSDoc Tags
+---
+
+JSDoc or TSDoc tags can be used to make exceptions for unused or duplicate
+exports.
+
+Knip tries to minimize configuration and introduces no new syntax. That's why it
+hooks into JSDoc and TSDoc tags.
+
+:::caution
+
+Adding tags or excluding a certain type of issues from the report is usually not
+recommended. It hides issues, which is often a sign of code smell or ambiguity
+and ends up harder to maintain. It's usually better to refactor the code (or
+report an issue with Knip for false positives).
+
+:::
+
+JSDoc comments always start with `/**` (not `//`) and can be single or
+multi-line.
+
+## Tags
+
+Use arbitrary [tags][1] to exclude or include tagged exports from the report.
+Example:
+
+```ts
+/** @lintignore */
+export const myUnusedExport = 1;
+
+/** @lintignore */
+import Unresolved from './generated/lib.js';
+```
+
+And then include (`+`) or exclude (`-`) these tagged exports from the report
+like so:
+
+```shell
+knip --tags=-lintignore,-internal
+```
+
+Tags can also be [configured in `knip.json`][2].
+
+When an excluded tag is no longer necessary because the export is actually used,
+Knip reports a **tag hint**:
+
+```sh
+Tag hints (1)
+ignored  unimported.ts  Unused tag in unimported.ts: ignored → @custom
+```
+
+This helps you clean up tags that were added to suppress issues that have since
+been resolved.
+
+## `@public`
+
+By default, Knip reports unused exports in non-entry files.
+
+Tag the export as `@public` and Knip will not report it.
+
+Example:
+
+```ts
+/**
+ * @public
+ */
+export const unusedFunction = () => {};
+```
+
+This tag can also be used to make exceptions in entry files when using
+[--include-entry-exports][3].
+
+[JSDoc: @public][4] and [TSDoc: @public][5]
+
+## `@internal`
+
+Internal exports are not meant for public consumption, but only for internal
+usage such as tests. This means they would be reported in [production mode][6].
+
+Mark the export with `@internal` and Knip will not report the export in
+production mode.
+
+Example:
+
+```ts
+/** @internal */
+export const internalTestedFunction = () => {};
+```
+
+In general it's not recommended to expose and test implementation details, but
+exceptions are possible. Those should not be reported as false positives, so
+when using production mode you'll need to help Knip out by tagging them as
+`@internal`.
+
+[TSDoc: @internal][7]
+
+## `@alias`
+
+Knip reports duplicate exports. To prevent this, tag one of the exports as
+`@alias`.
+
+Example:
+
+```ts
+export const Component = () => {};
+
+/** @alias */
+export default Component;
+```
+
+An alternative solution is to use `--exclude duplicates` and exclude all
+duplicates from being reported.
+
+[JSDoc: @alias][8]
+
+## `@beta`
+
+Works identical to [`@public`][9]. Knip ignores other tags like `@alpha` and
+`@experimental`.
+
+[TSDoc: @beta][10]
+
+[1]: ../reference/cli.md#--tags
+[2]: ./configuration.md#tags
+[3]: ./cli.md#--include-entry-exports
+[4]: https://jsdoc.app/tags-public.html
+[5]: https://tsdoc.org/pages/tags/public/
+[6]: ../features/production-mode.md
+[7]: https://tsdoc.org/pages/tags/internal/
+[8]: https://jsdoc.app/tags-alias.html
+[9]: #public
+[10]: https://tsdoc.org/pages/tags/beta/

package/src/docs/docs/reference/known-issues.md

@@ -0,0 +1,86 @@
+---
+title: Known Issues
+---
+
+List of known issues and workarounds for exceptions thrown during a Knip run.
+
+See [handling issues][1] to learn more about dealing with lint issues.
+
+## Exceptions from config files
+
+An exception may be thrown when a Knip plugin loads a JavaScript or TypeScript
+configuration file such as `webpack.config.js` or `vite.config.ts`:
+
+```sh
+$ knip
+Error loading .../vite.config.ts
+```
+
+Knip may load such files differently, in a different environment, with missing
+environment variables, missing path aliases, etcetera. Use `--debug` to locate
+the cause of the issue with more details.
+
+Potential workarounds:
+
+- [Set path aliases][2] for "Cannot find module" errors
+- Set missing environment variable(s), potential solutions:
+  - Use a helper package like [dotenvx][3]
+  - `KEY=VAL knip`
+  - `node --env-file .env $(which knip)`
+- Disable loading the file by overriding the default `config` for that plugin.
+  - Example: `vite: { config: [] }`
+  - In a monorepo, be more specific like so:
+    `workspaces: { "packages/lib": { vite: { config: [] } } }`
+  - If this helps, add the file as an `entry` file for static analysis.
+- Disable the related plugin.
+  - Example: `eslint: false`
+  - In a monorepo, be more specific like so:
+    `workspaces: { "packages/lib": { eslint: false } }`
+  - If this helps, add the file as an `entry` file for static analysis.
+- As a last resort, ignore the workspace: `ignoreWorkspaces: ["packages/lib"]`.
+
+## Path aliases in config files
+
+Loading the configuration file (e.g. `cypress.config.ts`) for one of Knip's
+plugins may give an error:
+
+```sh
+$ knip
+Analyzing workspace ....
+Error loading .../cypress.config.ts
+Reason: Cannot find module '@alias/name'
+Require stack:
+- .../cypress.config.ts
+```
+
+Some tools (such as Cypress and Jest) support using TypeScript path aliases in
+the configuration file.
+
+Potential workarounds:
+
+- Rewrite the import in the configuration file to a relative import.
+- Inject support with a module like `tsx`: `NODE_OPTIONS="--import tsx" knip`
+- Or `tsconfig-paths`: `NODE_OPTIONS="--import tsconfig-paths/register.js" knip`
+- Use Bun with [knip-bun][4].
+- See [exceptions from config files][5] for more potential workarounds.
+
+## Nx Daemon
+
+In Nx projects you might encounter this error:
+
+```sh
+NX   Daemon process terminated and closed the connection
+```
+
+The solution is to [disable the Nx Daemon][6]:
+
+```sh
+NX_DAEMON=false knip
+```
+
+[1]: ../guides/handling-issues.mdx
+[2]: #path-aliases-in-config-files
+[3]: https://dotenvx.com/
+[4]: ./cli.md#knip-bun
+[5]: #exceptions-from-config-files
+[6]: https://nx.dev/concepts/nx-daemon#turning-it-off

package/src/docs/docs/reference/plugins/angular.md

@@ -0,0 +1,34 @@
+---
+title: Angular
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is enabled if `"@angular/cli"` is listed in `"dependencies"` or `"devDependencies"` in `package.json`.
+
+## Default configuration
+
+If this plugin is enabled, the following configuration is added automatically:
+
+```json
+{
+  "angular": {
+    "config": ["angular.json"]
+  }
+}
+```
+
+Depending on local configuration, plugins may modify the defaults as shown.
+
+Custom `config` or `entry` options override default values, they are not merged.
+
+See [Plugins][1] for more details about plugins and their `entry` and `config` options.
+
+## Generated from source
+
+This page was generated from the [angular plugin source code][2].
+
+[1]: ../../explanations/plugins.md
+[2]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/angular/index.ts

package/src/docs/docs/reference/plugins/astro-db.md

@@ -0,0 +1,34 @@
+---
+title: Astro DB
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is enabled if `"@astrojs/db"` is listed in `"dependencies"` or `"devDependencies"` in `package.json`.
+
+## Default configuration
+
+If this plugin is enabled, the following configuration is added automatically:
+
+```json
+{
+  "astro-db": {
+    "entry": ["db/config.{js,ts}", "db/seed.{js,ts}"]
+  }
+}
+```
+
+Depending on local configuration, plugins may modify the defaults as shown.
+
+Custom `config` or `entry` options override default values, they are not merged.
+
+See [Plugins][1] for more details about plugins and their `entry` and `config` options.
+
+## Generated from source
+
+This page was generated from the [astro-db plugin source code][2].
+
+[1]: ../../explanations/plugins.md
+[2]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/astro-db/index.ts

package/src/docs/docs/reference/plugins/astro-og-canvas.md

@@ -0,0 +1,15 @@
+---
+title: astro-og-canvas
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is enabled if `"astro-og-canvas"` is listed in `"dependencies"` or `"devDependencies"` in `package.json`.
+
+## Generated from source
+
+This page was generated from the [astro-og-canvas plugin source code][1].
+
+[1]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/astro-og-canvas/index.ts

package/src/docs/docs/reference/plugins/astro.md

@@ -0,0 +1,44 @@
+---
+title: Astro
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is enabled if `"astro"` is listed in `"dependencies"` or `"devDependencies"` in `package.json`.
+
+## Default configuration
+
+If this plugin is enabled, the following configuration is added automatically:
+
+```json
+{
+  "astro": {
+    "config": ["astro.config.{js,cjs,mjs,ts,mts}"],
+    "entry": [
+      "src/content/config.ts",
+      "src/content.config.ts",
+      "src/pages/**/*.{astro,mdx,js,ts}",
+      "!src/pages/**/_*",
+      "!src/pages/**/_*/**",
+      "src/content/**/*.mdx",
+      "src/middleware.{js,ts}",
+      "src/actions/index.{js,ts}"
+    ]
+  }
+}
+```
+
+Depending on local configuration, plugins may modify the defaults as shown.
+
+Custom `config` or `entry` options override default values, they are not merged.
+
+See [Plugins][1] for more details about plugins and their `entry` and `config` options.
+
+## Generated from source
+
+This page was generated from the [astro plugin source code][2].
+
+[1]: ../../explanations/plugins.md
+[2]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/astro/index.ts

package/src/docs/docs/reference/plugins/ava.md

@@ -0,0 +1,46 @@
+---
+title: Ava
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is enabled if `"ava"` is listed in `"dependencies"` or `"devDependencies"` in `package.json`.
+
+## Default configuration
+
+If this plugin is enabled, the following configuration is added automatically:
+
+```json
+{
+  "ava": {
+    "config": ["ava.config.{js,cjs,mjs}", "package.json"],
+    "entry": [
+      "test.{js,cjs,mjs,ts}",
+      "{src,source}/test.{js,cjs,mjs,ts}",
+      "**/__tests__/**/*.{js,cjs,mjs,ts}",
+      "**/*.spec.{js,cjs,mjs,ts}",
+      "**/*.test.{js,cjs,mjs,ts}",
+      "**/test-*.{js,cjs,mjs,ts}",
+      "**/test/**/*.{js,cjs,mjs,ts}",
+      "**/tests/**/*.{js,cjs,mjs,ts}",
+      "!**/__tests__/**/__{helper,fixture}?(s)__/**/*",
+      "!**/test?(s)/**/{helper,fixture}?(s)/**/*"
+    ]
+  }
+}
+```
+
+Depending on local configuration, plugins may modify the defaults as shown.
+
+Custom `config` or `entry` options override default values, they are not merged.
+
+See [Plugins][1] for more details about plugins and their `entry` and `config` options.
+
+## Generated from source
+
+This page was generated from the [ava plugin source code][2].
+
+[1]: ../../explanations/plugins.md
+[2]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/ava/index.ts

package/src/docs/docs/reference/plugins/babel.md

@@ -0,0 +1,41 @@
+---
+title: Babel
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is enabled if there's a match in `"dependencies"` or `"devDependencies"` in `package.json`:
+
+- `^@babel\/`
+
+## Default configuration
+
+If this plugin is enabled, the following configuration is added automatically:
+
+```json
+{
+  "babel": {
+    "config": [
+      "babel.config.{json,js,cjs,mjs,cts,ts}",
+      ".babelrc.{json,js,cjs,mjs,cts}",
+      ".babelrc",
+      "package.json"
+    ]
+  }
+}
+```
+
+Depending on local configuration, plugins may modify the defaults as shown.
+
+Custom `config` or `entry` options override default values, they are not merged.
+
+See [Plugins][1] for more details about plugins and their `entry` and `config` options.
+
+## Generated from source
+
+This page was generated from the [babel plugin source code][2].
+
+[1]: ../../explanations/plugins.md
+[2]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/babel/index.ts

package/src/docs/docs/reference/plugins/biome.md

@@ -0,0 +1,34 @@
+---
+title: Biome
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is enabled if `"@biomejs/biome"` is listed in `"dependencies"` or `"devDependencies"` in `package.json`.
+
+## Default configuration
+
+If this plugin is enabled, the following configuration is added automatically:
+
+```json
+{
+  "biome": {
+    "config": ["biome.json", "biome.jsonc"]
+  }
+}
+```
+
+Depending on local configuration, plugins may modify the defaults as shown.
+
+Custom `config` or `entry` options override default values, they are not merged.
+
+See [Plugins][1] for more details about plugins and their `entry` and `config` options.
+
+## Generated from source
+
+This page was generated from the [biome plugin source code][2].
+
+[1]: ../../explanations/plugins.md
+[2]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/biome/index.ts

package/src/docs/docs/reference/plugins/bumpp.md

@@ -0,0 +1,41 @@
+---
+title: bumpp
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is enabled if `"bumpp"` is listed in `"dependencies"` or `"devDependencies"` in `package.json`.
+
+## Default configuration
+
+If this plugin is enabled, the following configuration is added automatically:
+
+```json
+{
+  "bumpp": {
+    "entry": [
+      "package.json",
+      ".bumprc",
+      ".config/bumprc",
+      ".bumprc.{json,jsonc,json5,yaml,yml,js,ts,mjs,cjs,mts,cts,toml}",
+      "bump.config.{js,ts,mjs,cjs,mts,cts}",
+      ".config/bumprc.{json,jsonc,json5,yaml,yml,js,ts,mjs,cjs,mts,cts,toml}"
+    ]
+  }
+}
+```
+
+Depending on local configuration, plugins may modify the defaults as shown.
+
+Custom `config` or `entry` options override default values, they are not merged.
+
+See [Plugins][1] for more details about plugins and their `entry` and `config` options.
+
+## Generated from source
+
+This page was generated from the [bumpp plugin source code][2].
+
+[1]: ../../explanations/plugins.md
+[2]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/bumpp/index.ts

package/src/docs/docs/reference/plugins/bun.md

@@ -0,0 +1,34 @@
+---
+title: Bun
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is enabled if `"bun"` is listed in `"dependencies"` or `"devDependencies"` in `package.json`.
+
+## Default configuration
+
+If this plugin is enabled, the following configuration is added automatically:
+
+```json
+{
+  "bun": {
+    "config": ["bunfig.toml"]
+  }
+}
+```
+
+Depending on local configuration, plugins may modify the defaults as shown.
+
+Custom `config` or `entry` options override default values, they are not merged.
+
+See [Plugins][1] for more details about plugins and their `entry` and `config` options.
+
+## Generated from source
+
+This page was generated from the [bun plugin source code][2].
+
+[1]: ../../explanations/plugins.md
+[2]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/bun/index.ts

package/src/docs/docs/reference/plugins/c8.md

@@ -0,0 +1,29 @@
+---
+title: c8
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is always enabled.
+
+## Shell commands
+
+This plugin adds argument parsing for the <code>c8</code>
+binary. Configuration:
+
+```
+args: (args          ) => args.filter(arg => arg !== 'check-coverage')
+boolean: ["all", "check-coverage", "clean", "exclude-after-remap", "per-file", "skip-full"]
+fromArgs: (parsed            , args          ) => (parsed._[0] ? argsFrom(args, parsed._[0]) : (parsed['--'] ?? []))
+```
+
+The configuration was generated from source code. Also see [Script Parser][1].
+
+## Generated from source
+
+This page was generated from the [c8 plugin source code][2].
+
+[1]: ../../features/script-parser.md
+[2]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/c8/index.ts

package/src/docs/docs/reference/plugins/capacitor.md

@@ -0,0 +1,36 @@
+---
+title: Capacitor
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is enabled if there's a match in `"dependencies"` or `"devDependencies"` in `package.json`:
+
+- `^@capacitor\/`
+
+## Default configuration
+
+If this plugin is enabled, the following configuration is added automatically:
+
+```json
+{
+  "capacitor": {
+    "config": ["capacitor.config.{json,ts}"]
+  }
+}
+```
+
+Depending on local configuration, plugins may modify the defaults as shown.
+
+Custom `config` or `entry` options override default values, they are not merged.
+
+See [Plugins][1] for more details about plugins and their `entry` and `config` options.
+
+## Generated from source
+
+This page was generated from the [capacitor plugin source code][2].
+
+[1]: ../../explanations/plugins.md
+[2]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/capacitor/index.ts

package/src/docs/docs/reference/plugins/changelogen.md

@@ -0,0 +1,41 @@
+---
+title: Changelogen
+sidebar:
+  hidden: true
+---
+
+## Enabled
+
+This plugin is enabled if `"changelogen"` is listed in `"dependencies"` or `"devDependencies"` in `package.json`.
+
+## Default configuration
+
+If this plugin is enabled, the following configuration is added automatically:
+
+```json
+{
+  "changelogen": {
+    "entry": [
+      "package.json",
+      ".changelogrc",
+      ".config/changelogrc",
+      ".changelogrc.{json,jsonc,json5,yaml,yml,js,ts,mjs,cjs,mts,cts,toml}",
+      "changelog.config.{js,ts,mjs,cjs,mts,cts}",
+      ".config/changelogrc.{json,jsonc,json5,yaml,yml,js,ts,mjs,cjs,mts,cts,toml}"
+    ]
+  }
+}
+```
+
+Depending on local configuration, plugins may modify the defaults as shown.
+
+Custom `config` or `entry` options override default values, they are not merged.
+
+See [Plugins][1] for more details about plugins and their `entry` and `config` options.
+
+## Generated from source
+
+This page was generated from the [changelogen plugin source code][2].
+
+[1]: ../../explanations/plugins.md
+[2]: https://github.com/webpro-nl/knip/blob/main/packages/knip/src/plugins/changelogen/index.ts