@lx-frontend/knip-config

一份可复用的 knip 配置生成器，用于统一 entry、ignoreBinaries、ignoreDependencies、ignoreFiles 等规则，减少每个仓库重复维护配置的成本。

要求

node >=22.0.0

knip >=6.25.0

安装

pnpm add -D knip @lx-frontend/knip-config

快速上手

在项目根目录新建 knip.config.ts，然后导出配置：

import { defineConfig } from '@lx-frontend/knip-config'

export default defineConfig({})

之后运行：

pnpm knip

API

defineConfig(options, extraConfig?)

生成并返回 KnipConfig。

• options
  • taro：是否为 Taro 项目。为 true 时会追加 Taro 相关的 entry 与 ignoreDependencies。
• extraConfig（可选）：用于在默认规则基础上做追加/覆盖（全部为“追加”语义）。
  • entry：追加到 entry
  • ignoreBinaries：追加到 ignoreBinaries
  • ignoreDependencies：追加到 ignoreDependencies
  • ignoreFiles：追加到 ignoreFiles

注意：该包默认会设置：

• tags：['-lintignore']
• ignoreBinaries：包含 lxnpm、only-allow

Taro 项目用法

import { defineConfig } from '@lx-frontend/knip-config'

export default defineConfig({ taro: true })

自定义追加（extraConfig）

import { defineConfig } from '@lx-frontend/knip-config'

export default defineConfig(
  { taro: false },
  {
    entry: ['src/index.ts', 'scripts/**/*.ts'],
    ignoreFiles: ['**/*.test.ts', '**/__fixtures__/**'],
    ignoreDependencies: ['@types/jest'],
    ignoreBinaries: ['my-custom-cli'],
  }
)

License

MIT