# @berenddeboer/nx-knip 中文文档

规范地址：https://npmcn.com/package/%40berenddeboer/nx-knip/

版本：1\.1\.0
npm 元数据更新时间：2026-03-02T21:52:14.569Z
中文译文更新时间：2026-11-07T22:53:51.471Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40berenddeboer/nx-knip
原文对照：https://npmcn.com/package/%40berenddeboer/nx-knip/?lang=original
项目主页：https://github.com/berenddeboer/nx-plugins
源码仓库：https://github.com/berenddeboer/nx-plugins

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：22.3 kB，20 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@nx/devkit ^20\.6\.4 \|\| ^21\.0\.0 \|\| ^22\.0\.0，knip ^5\.0\.0
- 首次发布：2025-12-23T21:40:06.535Z
- 最新版本发布：2026-03-02T21:52:14.268Z
- 近 30 天下载量：5944（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

Knip 的 Nx 自引出插件 - 找到未使用的依赖、 导出和文件

## 安装

```sh
npm install @berenddeboer/nx-knip
```

也可以使用：`pnpm add @berenddeboer/nx-knip`、`yarn add @berenddeboer/nx-knip`、`bun add @berenddeboer/nx-knip`

## README

# @berenddeboer/nx-knip (英语)

自导出 Nx 插件 [克尼普语Name](https://knip.dev/) - 在您的 JavaScript/ TypeScript 工程中找到未使用的依赖、 导出和文件 .

## 安装

安装插件和 knip :

无

```sh
npm install --save-dev @berenddeboer/nx-knip knip
```
小时

```sh
pnpm add --save-dev @berenddeboer/nx-knip knip
```
线条

```sh
yarn add --dev @berenddeboer/nx-knip knip
```
包头

```sh
bun add -D @berenddeboer/nx-knip knip
```

## 使用量

### 插件设置

将插件添加到您的 `nx.json`数字 :

```json
{
  "plugins": [
    {
      "plugin": "@berenddeboer/nx-knip",
      "options": {
        "targetName": "knip"
      }
    }
  ]
}
```

这将自动添加一个 `knip` 瞄准您工作空间中的所有项目.

### 运行 Knip

为单个项目运行 knip :

```bash
nx knip my-project
```

对所有受影响的项目运行 knip :

```bash
nx affected -t knip
```

或者运行它的所有项目:

```bash
nx run-many -t knip
```

## 执行器选项

### `strict`

启用 [严格模式](https://knip.dev/features/production-mode#strict-mode) (缩写: `--production`) (中文(简体) ). 默认为 `false`当启用时, knip 会:

-   校验隔离:工作空间应严格使用自己的依赖性
-   包含 `peerDependencies` 查找未使用或未列出的依赖关系时
-   报告列出的纯类型进口 `dependencies`

您可以通过插件选项在 `nx.json`数字 :

```json
{
  "plugins": [
    {
      "plugin": "@berenddeboer/nx-knip",
      "options": {
        "targetName": "knip",
        "strict": true
      }
    }
  ]
}
```

或每个项目在 `project.json`数字 :

```json
{
  "targets": {
    "knip": {
      "options": {
        "strict": true
      }
    }
  }
}
```

### `env`

设置 knip 进程的环境变量 。 当 knip 装入时此选项有用 `.ts` 投放缺失环境变量的文件 - 您可以提供假值, 这样 knip 可以不出错分析文件 .

通过 `targetDefaults` 内 `nx.json`数字 :

```json
{
  "targetDefaults": {
    "knip": {
      "options": {
        "env": {
          "SQLITE_DATABASE_PATH": "/tmp/knip-dummy.db",
          "PF_ORG": "examples/demo"
        }
      }
    }
  }
}
```

或每个项目在 `project.json`数字 :

```json
{
  "targets": {
    "knip": {
      "options": {
        "env": {
          "DATABASE_URL": "postgres://localhost/dummy"
        }
      }
    }
  }
}
```

提供的环境变量与当前变量合并 `process.env`,因此保留现有的变量,并添加或覆盖指定的变量.

## 如何运作

此插件运行 `knip --workspace {projectRoot}` 从每个工程的工作空间根。 这意味着:

1.  它使用 `--workspace` 以特定工作空间为重点的旗帜
2.  工作空间根 `knip.json` 使用配置
3.  若为 [阿宝](https://bun.sh/) 安装,插件自动使用 `knip-bun` 业绩显著改善

## 学习更多

-   [Knip 文档](https://knip.dev/)
-   [Nx 插件](https://nx.dev/concepts/nx-plugins)

## 常见问题

### @berenddeboer/nx-knip 是什么？

Knip 的 Nx 自引出插件 - 找到未使用的依赖、 导出和文件

### 如何安装 @berenddeboer/nx-knip？

在项目目录运行 npm install @berenddeboer/nx-knip，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@nx/devkit（^20\.6\.4 \|\| ^21\.0\.0 \|\| ^22\.0\.0）、knip（^5\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @berenddeboer/nx-knip 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @berenddeboer/nx-knip 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @berenddeboer/nx-knip 可以商用吗？

@berenddeboer/nx-knip 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @berenddeboer/nx-knip 的下载量有多少？

根据 npm 官方下载统计，@berenddeboer/nx-knip 在 2026/10/08 – 2026/11/06 这 30 天内被下载 5,944 次，日均约 198 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @berenddeboer/nx-knip 还在维护吗？

最新版本 1\.1\.0 发布于 2026/03/03（8 个月前）；至今共发布 7 个版本，其中过去 12 个月发布了 7 个；首次发布于 2025/12/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。