@knip/mcp 0.0.4 → 0.0.6

package/docs/docs/index.mdx

@@ -0,0 +1,160 @@
+---
+title: Declutter your JavaScript & TypeScript projects
+description: Project linter to find unused dependencies, exports and files
+template: splash
+hero:
+  title: Knip
+  tagline: Declutter your JavaScript & TypeScript projects
+  image:
+    file: ../../assets/logo.svg
+  actions:
+    - text: Let's Get Started
+      link: ./overview/getting-started
+      icon: right-arrow
+      variant: primary
+    - text: 'NEW: Knip for Editors & Agents'
+      link: /blog/for-editors-and-agents
+      icon: rocket
+      variant: secondary
+    - text: View on GitHub
+      link: https://github.com/webpro-nl/knip
+      icon: external
+      variant: minimal
+---
+
+import { Card, CardGrid } from '@astrojs/starlight/components';
+import { YouTube } from '@astro-community/astro-embed-youtube';
+import Posts from '../../components/Posts.astro';
+import Sponsors from '../../components/Sponsors.astro';
+import Projects from '../../components/Projects.astro';
+import Contributors from '../../components/Contributors.astro';
+
+:::section{.badges}
+
+[![NPM Version][2]][1] [![NPM Downloads][3]][1] [![GitHub Repo   stars][5]][4]
+
+:::
+
+:::div{.sponsor}
+
+[Sponsor Me][6] / [Hire Me][7]
+
+:::
+
+:a[Sponsored by:]{.sponsors-intro href="/sponsors"}
+
+<Sponsors showAll={false} />
+
+<CardGrid>
+  <Card title="Why use Knip?" icon="approve-check">
+    Knip finds and fixes unused dependencies, exports and files. Use it for
+    enhanced code and dependency management.
+  </Card>
+
+  <Card title="How does it work?" icon="setting">
+    Advanced analysis starting from fine-grained entry points based on the
+    actual frameworks and tooling in (mono)repos for accurate and actionable
+    results.
+  </Card>
+
+  <Card title="Battle-tested" icon="approve-check">
+    Thousands of projects are already using Knip!
+  </Card>
+
+  <Card title="Plugins" icon="open-book">
+    Knip comes with [100+ plugins][8] for tools and frameworks like Astro,
+    Cypress, ESLint, Jest, GitHub Actions, Next.js, Nx, Remix, Storybook,
+    Svelte, Vite, Vitest, Webpack and many, many more.
+  </Card>
+
+  <Card title="Playground" icon="rocket">
+    Try Knip on the [playground][9].
+  </Card>
+
+  <Card title="Troubleshooting" icon="warning">
+    Need help? [Start troubleshooting][10].
+  </Card>
+</CardGrid>
+
+## Trusted by the world's best software teams
+
+:::section{.projects}
+
+<Projects />
+
+:::
+
+## Introduction video
+
+[James Shopland][11] has a great introduction and overview of Knip (thanks
+James!):
+
+<YouTube id="uhEkgWt-pUM" />
+
+## Created by awesome contributors
+
+Special thanks to the wonderful people who have contributed to this project:
+
+<Contributors />
+
+## Articles about Knip
+
+A curated selection of articles about Knip, most recent first:
+
+- Tom McWright: [How to keep package.json under control][12] (2025-09-11)
+- Mohammed Farmaan: [Declutter Your JavaScript and TypeScript Projects][13]
+  (2025-08-13)
+- dip Engineer Blog: [Knipで安心してデッドコードを撲滅する][14]
+  (2025-04-04/Japanese 🇯🇵)
+- Tom MacWright: [Knip: good software for cleaning up TypeScript tech debt][15]
+  (2024-10-25)
+- Neng Apichet: [มาทำความสะอาด Project โค้ดของเราด้วย Knip กัน][16]
+  (2024-10-22/Thai 🇹🇭)
+- Anthony Pena: [Knip: l'ultime outil pour faire le ménage dans vos
+  projets!][17] (2024-10-08/French 🇫🇷)
+- Taro: [TypeScript/JavaScriptの不要なコードを削除するツール「Knip」の紹介][18]
+  (2024-07-25/Japanese 🇯🇵)
+- Kevin Bailey: [Delete Code with Knip][19] (2025-10-31)
+- Maddy Miller: [Using Knip to find dead code in a high-traffic git repo][20]
+  (2023-09-17)
+- Josh Goldberg: [Speeding Up Centered Part 4: Unused Code Bloat][21]
+  (2023-08-21)
+- Smashing Magazine: [Knip: An Automated Tool For Finding Unused Files, Exports,
+  And Dependencies][22] (2023-08-14)
+- Effective TypeScript: [Recommendation Update: ✂️ Use knip to detect dead code
+  and types][23] (2023-07-29)
+
+## Don't just take our word for it
+
+<Posts />
+
+## Read More
+
+- [Unused dependencies][24]
+- [Unused exports][25]
+
+[1]: https://www.npmjs.com/package/knip
+[2]: https://img.shields.io/npm/v/knip?color=f56e0f
+[3]: https://img.shields.io/npm/dm/knip?color=f56e0f
+[4]: https://github.com/webpro-nl/knip
+[5]: https://img.shields.io/github/stars/webpro-nl/knip?style=flat&color=f56e0f
+[6]: ./sponsors
+[7]: https://webpro.nl/hire-me
+[8]: ./reference/plugins.md
+[9]: ./playground
+[10]: ./guides/troubleshooting.md
+[11]: https://www.jamesshopland.com
+[12]: https://blog.val.town/gardening-dependencies
+[13]: https://farmaan.dev/writing/using-knip
+[14]: https://developer.dip-net.co.jp/entry/2025/04/04/Knipで安心してデッドコードを撲滅する
+[15]: https://macwright.com/2024/10/25/good-software-knip
+[16]: https://engineering.thinknet.co.th/มาทำความสะอาด-project-โค้ดของเราด้วย-knip-กัน-20dbd65f6b58
+[17]: https://k49.fr.nf/knip-l-ultime-outil-pour-faire-le-menage-dans-vos-projets/
+[18]: https://tech.basemachina.jp/entry/introduction-knip
+[19]: https://kevinabailey.com/delete-code-with-knip
+[20]: https://madelinemiller.dev/blog/knip-dead-code/
+[21]: https://www.joshuakgoldberg.com/blog/speeding-up-centered-part-4-unused-code-bloat/
+[22]: https://www.smashingmagazine.com/2023/08/knip-automated-tool-find-unused-files-exports-dependencies/
+[23]: https://effectivetypescript.com/2023/07/29/knip/
+[24]: ./typescript/unused-dependencies.md
+[25]: ./typescript/unused-exports.md

package/docs/docs/overview/configuration.md

@@ -0,0 +1,104 @@
+---
+title: Configuration
+description: config
+---
+
+## Defaults
+
+Knip has good defaults and aims for "zero config". Here's a simplified version
+of the default `entry` and `project` values:
+
+```json
+{
+  "entry": ["index.{js,ts}", "src/index.{js,ts}"],
+  "project": ["**/*.{js,ts}"]
+}
+```
+
+Entry files are the starting point for Knip to find more source files and
+external dependencies.
+
+## Location
+
+By default, Knip will look for a configuration file with the following names:
+
+- `knip.json`
+- `knip.jsonc`
+- `.knip.json`
+- `.knip.jsonc`
+- `knip.ts`
+- `knip.js`
+- `knip.config.ts`
+- `knip.config.js`
+- `package.json` (in the `"knip"` property)
+
+If you want to use a custom file name or path, use the `--config` flag:
+
+```sh
+knip --config path/to/knip.json
+```
+
+## Customize
+
+Your project structure may not match the default `entry` and `project` files.
+Here's an example custom configuration to include `.js` files in the `scripts`
+folder:
+
+```json title="knip.json"
+{
+  "$schema": "https://unpkg.com/knip@5/schema.json",
+  "entry": ["src/index.ts", "scripts/{build,create}.js"],
+  "project": ["src/**/*.ts", "scripts/**/*.js"]
+}
+```
+
+If you override the `entry` file patterns, you may also want to override
+`project` file patterns. The set of project files is used to determine what
+files are unused. The `project` patterns can also be negated to exclude files
+from the analysis. See [configuring project files][1] for details.
+
+The values you set override the default values, they are not merged.
+
+:::tip
+
+Be specific with `entry` files. Minimize the number of entry files and wildcards
+for better results.
+
+Plugins are enabled automatically, and set entry files for you. Such as for
+Next.js, Astro, Remix, Vitest, Playwright and many more.
+
+:::
+
+Knip looks for entry files in many places. Learn more in the next page about
+[entry files][2].
+
+## Configuration Options
+
+See [configuration file options][3].
+
+Use JavaScript or TypeScript in a [dynamic configuration file][4].
+
+## What's next?
+
+The best way to understand Knip and what it can do for you is to read the pages
+in the "Understanding Knip" sections, starting with [entry files][2].
+
+Want to learn more about some of the main features?
+
+- Working with [monorepos & workspaces][5].
+- Learn more about [production mode][6].
+
+Having trouble configuring Knip?
+
+- [Configuring project files][1]
+- [Troubleshooting][7]
+
+Search this website using the bar at the top (`Ctrl+K` or `⌘+K`).
+
+[1]: ../guides/configuring-project-files.md
+[2]: ../explanations/entry-files.md
+[3]: ../reference/configuration.md
+[4]: ../reference/dynamic-configuration.mdx
+[5]: ../features/monorepos-and-workspaces.md
+[6]: ../features/production-mode.md
+[7]: ../guides/troubleshooting.md

package/docs/docs/overview/features.md

@@ -0,0 +1,66 @@
+---
+title: Features
+---
+
+Overview of capabilities in support of the core feature: find many [types of
+issues][1].
+
+Also see [related tooling][2].
+
+## Overview
+
+| Name                         | Description or example                                                |
+| :--------------------------- | :-------------------------------------------------------------------- |
+| [Auto-fix][3]                | Use `--fix` to auto-fix issues                                        |
+| [Cache][4]                   | Use `--cache` to speed up consecutive runs                            |
+| Catalog                      | Report & fix unused catalog entries                                   |
+| [CommonJS][5]                | CommonJS is still widely used & supported, but conditions apply       |
+| [Compilers][6]               | Support for Astro, MDX, Svelte, Vue and custom compilers              |
+| Configuration hints          | Display configuration hints to keep `knip.json` tidy                  |
+| [Debug][7]                   | Use `--debug` for troubleshooting                                     |
+| [Filters][8]                 | Exclude or focus on specific issue types                              |
+| [Format][9]                  | Add `--format` to `--fix` and auto-format modified files              |
+| [JSDoc tags][10]             | Tag and exclude specific exports from the report                      |
+| [Memory usage][11]           | Use `--memory` for detailed memory usage insights                     |
+| [Monorepos][12]              | Workspaces are first-class citizen                                    |
+| [Performance][13]            | Use `--performance` for detailed timing insights                      |
+| [Plugins][14]                | Over 100 plugins with custom entry paths and config parsing           |
+| [Plugins: inputs][15]        | Inputs are an affective mechanism to add entries, dependencies & more |
+| [Plugins: CLI arguments][16] | Tool-specific CLI argument parsing make plugins go the extra mile     |
+| [Preprocessors][17]          | Preprocess issues before being reported                               |
+| [Production mode][18]        | Use `--production` to lint only production code                       |
+| [Reporters][19]              | Choose from many built-in reporters or use your own                   |
+| [Rules][20]                  | Exclude or focus on specific issue types                              |
+| [Script parser][21]          | Shell scripts and `package.json` contain entry paths and dependencies |
+| [Source mapping][22]         | Map `dist` files back to `src` files                                  |
+| [Strict mode][23]            | Use `--strict` to isolate workspaces and consider only `dependencies` |
+| [Trace][24]                  | Trace exports to find where they are used                             |
+| [Watch mode][25]             | Use `--watch` for live updates of unused files and exports            |
+| [Workspace][26]              | Use `--workspace` to lint a single workspace in a monorepo            |
+
+[1]: ../reference/issue-types.md
+[2]: ../reference/related-tooling.md
+[3]: ../features/auto-fix.mdx
+[4]: ../reference/cli.md#--cache
+[5]: ../guides/working-with-commonjs.md
+[6]: ../features/compilers.md
+[7]: ../guides/troubleshooting.md#issues-reported-by-knip
+[8]: ../features/rules-and-filters.md#filters
+[9]: ../features/auto-fix.mdx#format
+[10]: ../reference/jsdoc-tsdoc-tags.md
+[11]: ../reference/cli.md#--memory
+[12]: ../features/monorepos-and-workspaces.md
+[13]: ../reference/cli.md#--performance
+[14]: ../explanations/plugins.md
+[15]: ../writing-a-plugin/inputs.md
+[16]: ../writing-a-plugin/argument-parsing.md
+[17]: ../features/reporters.md#preprocessors
+[18]: ../features/production-mode.md
+[19]: ../features/reporters.md
+[20]: ../features/rules-and-filters.md#rules
+[21]: ../features/script-parser.md
+[22]: ../features/source-mapping.md
+[23]: ../features/production-mode.md#strict-mode
+[24]: ../guides/troubleshooting.md#trace
+[25]: ../reference/cli.md#--watch
+[26]: ../features/monorepos-and-workspaces#lint-a-single-workspace

package/docs/docs/overview/getting-started.mdx

@@ -0,0 +1,195 @@
+---
+title: Getting Started
+sidebar:
+  order: 1
+---
+
+import { Tabs, TabItem } from '@astrojs/starlight/components';
+
+## Requirements
+
+Knip v5 requires at least Node.js v18.18.0. Or Bun.
+
+Want to try Knip without installation? Visit [the playground][1].
+
+## Installation
+
+This is the easiest and recommended way to install Knip:
+
+<Tabs syncKey="pm">
+  <TabItem label="npm">
+    ```shell
+    npm init @knip/config
+    ```
+  </TabItem>
+
+  <TabItem label="pnpm">
+    ```shell
+    pnpm create @knip/config
+    ```
+  </TabItem>
+
+  <TabItem label="bun">
+    ```shell
+    bun create @knip/config
+    ```
+  </TabItem>
+
+  <TabItem label="yarn">
+    ```shell
+    yarn create @knip/config
+    ```
+  </TabItem>
+</Tabs>
+
+Now you can run Knip to lint your project:
+
+<Tabs syncKey="pm">
+  <TabItem label="npm">
+    ```shell
+    npm run knip
+    ```
+  </TabItem>
+
+  <TabItem label="pnpm">
+    ```shell
+    pnpm knip
+    ```
+  </TabItem>
+
+  <TabItem label="bun">
+    ```shell
+    bun knip
+    ```
+  </TabItem>
+
+  <TabItem label="yarn">
+    ```shell
+    yarn knip
+    ```
+  </TabItem>
+</Tabs>
+
+Knip will lint your project and report unused dependencies, exports and files.
+
+If the output makes sense to you, feel free to go to the next page:
+[configuration][2].
+
+## Too Much?
+
+In large or complex codebases the output might be overwhelming. Start by
+limiting the number of shown issues per type:
+
+<Tabs syncKey="pm">
+  <TabItem label="npm">
+    ```shell
+    npm run knip -- --max-show-issues 5
+    ```
+  </TabItem>
+
+  <TabItem label="pnpm">
+    ```shell
+    pnpm knip --max-show-issues 5
+    ```
+  </TabItem>
+
+  <TabItem label="bun">
+    ```shell
+    bun knip --max-show-issues 5
+    ```
+  </TabItem>
+
+  <TabItem label="yarn">
+    ```shell
+    yarn knip --max-show-issues 5
+    ```
+  </TabItem>
+</Tabs>
+
+The output is easier to digest and may include some configuration hints to get
+an idea of what's left to configure. Many unused files? Go to [configuration][2]
+and follow up with [troubleshooting][3] if needed.
+
+:::tip
+
+Do not use the `ignore` option just to get rid of unwanted output. Read
+[Configuring Project Files][4] to get the most out of Knip.
+
+:::
+
+## Manual
+
+Alternatively, manually install Knip using your package manager:
+
+<Tabs syncKey="pm">
+  <TabItem label="npm">
+    ```shell
+    npm install -D knip typescript @types/node
+    ```
+  </TabItem>
+
+  <TabItem label="pnpm">
+    ```shell
+    pnpm add -D knip typescript @types/node
+    ```
+  </TabItem>
+
+  <TabItem label="bun">
+    ```shell
+    bun add -D knip typescript @types/node
+    ```
+  </TabItem>
+
+  <TabItem label="yarn">
+    ```shell
+    yarn add -D knip typescript @types/node
+    ```
+  </TabItem>
+</Tabs>
+
+Knip uses `typescript` and ` @types/node` as peer dependencies to increase
+compatibility with your project. No worries, they're probably in your
+`node_modules` already.
+
+Then add a `knip` script to your `package.json`:
+
+```json title="package.json"
+{
+  "name": "my-project",
+  "scripts": {
+    "knip": "knip"
+  }
+}
+```
+
+## Without installation
+
+To run Knip without adding it to your project:
+
+<Tabs syncKey="pm">
+  <TabItem label="npm">
+    ```shell
+    npx knip
+    ```
+  </TabItem>
+
+  <TabItem label="pnpm">
+    ```shell
+    pnpm dlx knip
+    ```
+  </TabItem>
+
+  <TabItem label="bun">
+    ```shell
+    bunx knip
+    ```
+  </TabItem>
+</Tabs>
+
+In this scenario `typescript` and `@types/node` are expected to be installed
+already.
+
+[1]: /playground
+[2]: ./configuration.md
+[3]: ../guides/troubleshooting.md
+[4]: ../guides/configuring-project-files.md

package/docs/docs/overview/screenshots-videos.md

@@ -0,0 +1,42 @@
+---
+title: Screenshots & videos
+---
+
+## Watch & auto-fix
+
+This video demonstrates using the `--watch` and `--fix` options inside Visual
+Studio Code:
+
+<video controls width="500">
+  <source src="/screenshots/watch-fix.mp4" type="video/mp4" />
+
+  <source src="/screenshots/watch-fix.webm" type="video/webm" />
+</video>
+
+This works in any terminal. See [--watch][1] and [auto-fix][2] for more details.
+
+## Trace
+
+Here's an example screenshot that traces the `mapIterator` export in the
+TypeScript codebase:
+
+<img src="/screenshots/trace-export.png" alt="trace export" class="mw500" />
+
+Inspect complicated import and re-export chains at a glance:
+
+<img src="/screenshots/trace-file.png" alt="trace file" class="mw500" />
+
+See [Trace][3] for more details.
+
+## Performance
+
+An example screenshot showing `--performance` output for the Knip codebase:
+
+<img src="/screenshots/performance.png" alt="performance" class="mw500" />
+
+Also see [--performance][4].
+
+[1]: ../reference/cli.md#--watch
+[2]: ../features/auto-fix.mdx
+[3]: ../guides/troubleshooting.md#trace
+[4]: ../reference/cli.md#--performance

package/docs/docs/playground.mdx

@@ -0,0 +1,38 @@
+---
+title: 'Playground'
+description: 'Playground for Knip'
+template: splash
+---
+
+Welcome to the Knip playground. The codebases below have linting issues on
+purpose in the codebases, so Knip will report various types of issues.
+
+Feel free to play around! There are currently two playgrounds:
+
+- [Basic][1]
+- [Monorepo][2]
+
+Shoutout to <a href="https://stackblitz.com">StackBlitz</a> for generously
+providing these free dev containers.
+
+## Basic
+
+Visit this [Knip playground on StackBlitz][3] to try out Knip:
+
+<div class="playground">
+  <iframe src="https://stackblitz.com/github/webpro-nl/knip/tree/main/templates/playground/basic?file=README.md&view=editor" />
+</div>
+
+## Monorepo
+
+Visit this [Knip playground on StackBlitz][4] to try out Knip in a monorepo
+setting:
+
+<div class="playground">
+  <iframe src="https://stackblitz.com/github/webpro-nl/knip/tree/main/templates/playground/monorepo?file=README.md&view=editor" />
+</div>
+
+[1]: #basic
+[2]: #monorepo
+[3]: https://stackblitz.com/github/webpro-nl/knip/tree/main/templates/playground/basic?file=README.md&view=editor
+[4]: https://stackblitz.com/github/webpro-nl/knip/tree/main/templates/playground/monorepo?file=README.md&view=editor