@berenddeboer/nx-knip (英语)

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

安装

安装插件和 knip :

npm install --save-dev @berenddeboer/nx-knip knip

pnpm add --save-dev @berenddeboer/nx-knip knip

yarn add --dev @berenddeboer/nx-knip knip

bun add -D @berenddeboer/nx-knip knip

使用量

插件设置

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

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

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

运行 Knip

为单个项目运行 knip :

nx knip my-project

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

nx affected -t knip

或者运行它的所有项目:

nx run-many -t knip

执行器选项

strict

启用 严格模式 (缩写: --production) (中文(简体) ). 默认为 false当启用时, knip 会:

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

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

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

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

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

env

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

通过 targetDefaults 内 nx.json数字 :

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

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

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

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

如何运作

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

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

学习更多

• Knip 文档
• Nx 插件