knip-deadcode

Community Knip のデッドコード検出のベストプラクティス

Knip を使用して JavaScript および TypeScript プロジェクトのデッドコードを検出・削除するための包括的なガイドです。8 つのカテゴリにわたる 43 のルールを収録し、影響度に基づいて優先順位を付け、設定、CI 統合、クリーンアップのワークフローを案内します。

適用するタイミング

次の場合に、これらのガイドラインを参照してください。

• 新しいプロジェクトやモノレポ向けに Knip を設定するとき
• 誤検出や検出漏れを調査するとき
• デッドコードの再発を防ぐ CI パイプラインを設定するとき
• 自動修正を使って未使用コードをクリーンアップするとき
• 大規模なコードベースで Knip のパフォーマンスを最適化するとき

優先度別のルールカテゴリ

優先度	カテゴリ	影響度	プレフィックス
1	設定の基盤	CRITICAL	config-
2	エントリーポイント戦略	CRITICAL	entry-
3	ワークスペースとモノレポ	HIGH	workspace-
4	依存関係の分析	HIGH	deps-
5	エクスポートの検出	MEDIUM-HIGH	exports-
6	CI 統合	MEDIUM	ci-
7	自動修正のワークフロー	MEDIUM	fix-
8	パフォーマンスの最適化	LOW-MEDIUM	perf-

クイックリファレンス

1. 設定の基盤（CRITICAL）

• config-avoid-broad-ignore - 広範な無視パターンを避ける
• config-configure-path-aliases - Knip でパスエイリアスを設定する
• config-enable-plugins-explicitly - フレームワークプラグインを明示的に有効にする
• config-run-without-config - まず設定ファイルなしで実行し、ベースラインを確認する
• config-separate-entry-project - エントリーファイルとプロジェクトファイルを分ける
• config-use-json-schema - 設定の検証に JSON Schema を使用する
• config-use-negation-patterns - 除外には否定パターンを使用する
• config-use-production-mode - 出荷するコードの分析には本番モードを使用する

2. エントリーポイント戦略（CRITICAL）

• entry-add-dynamic-imports - 動的インポートの対象をエントリーポイントとして追加する
• entry-exclude-test-files - テストファイルを本番用エントリーポイントから除外する
• entry-include-all-entry-points - すべてのアプリケーションのエントリーポイントを含める
• entry-include-bin-scripts - バイナリスクリプトをエントリーポイントとして含める
• entry-use-compilers - 標準以外のファイル形式にはコンパイラーを使用する
• entry-use-plugin-entries - フレームワークではプラグインのエントリーポイントを使用する
• entry-verify-with-debug - デバッグモードでエントリーポイントを検証する

3. ワークスペースとモノレポ（HIGH）

• workspace-configure-root-workspace - ルートワークスペースを明示的に設定する
• workspace-ignore-specific - 必要に応じて特定のワークスペースを無視する
• workspace-isolate-for-strict - 厳密な依存関係チェックのためにワークスペースを分離する
• workspace-list-cross-deps - ワークスペース間の依存関係を明示的に列挙する
• workspace-per-workspace-plugins - ワークスペースごとにプラグインを設定する
• workspace-use-workspace-globs - 一貫した設定のためにワークスペースの glob パターンを使用する

4. 依存関係の分析（HIGH）

• deps-add-unlisted-deps - package.json に未記載の依存関係を追加します
• deps-avoid-transitive-reliance - 推移的依存関係への依存を避けます
• deps-configure-plugin-deps - ツール固有の依存関係に合わせてプラグインを設定します
• deps-fix-files-first - 依存関係を修正する前に未使用ファイルを修正します
• deps-ignore-conditional-deps - 条件付きで読み込まれる依存関係を無視します
• deps-remove-obsolete-types - 古い型定義パッケージを削除します

5. エクスポートの検出（MEDIUM-HIGH）

• exports-check-class-members - クラスメンバーに未使用コードがないか確認します
• exports-enable-entry-exports - プライベートパッケージでエントリーのエクスポートチェックを有効にします
• exports-handle-reexports - バレルファイル内の再エクスポートを処理します
• exports-ignore-same-file - 同じファイル内で使われているエクスポートを無視します
• exports-tag-public-api - JSDoc でパブリック API のエクスポートにタグを付けます
• exports-trace-usage - 削除前にエクスポートの使用状況を追跡します
• exports-use-include-libs - 型ベースの利用に include libs を使用します

6. CI との統合（MEDIUM）

• ci-add-to-pipeline - Knip を CI パイプラインに追加します
• ci-separate-production-check - 本番モードとデフォルトモードのチェックを分けます
• ci-use-cache - CI の実行を高速化するためにキャッシュを有効にします
• ci-use-max-issues - 段階的に導入するために max issues を使用します
• ci-use-reporters - CI の出力に適したレポーターを使用します
• ci-watch-mode-local - ローカル開発でウォッチモードを使用します

7. 自動修正のワークフロー（MEDIUM）

• fix-allow-remove-files - ファイル削除を明示的に許可します
• fix-format-after-fix - 自動修正の後にコードをフォーマットします
• fix-review-before-commit - コミット前に自動修正による変更を確認します
• fix-update-deps-after - 依存関係の修正後にパッケージマネージャーを更新します
• fix-use-fix-type - 対象を絞ったクリーンアップに fix type を使用します

8. パフォーマンスの最適化（LOW-MEDIUM）

• perf-filter-issue-types - 分析対象を絞るために問題の種類をフィルタリングします
• perf-limit-output - 大規模なコードベースで出力を制限します
• perf-profile-performance - 分析が遅い場合にパフォーマンスをプロファイリングします
• perf-use-bun-runtime - 分析を高速化するために Bun ランタイムを使用します
• perf-use-cache-flag - 繰り返しの分析でキャッシュを有効にします
• perf-use-workspace-filter - モノレポ分析を高速化するためにワークスペースをフィルタリングします

使用方法

詳しい説明とコード例については、各リファレンスファイルをお読みください。

• セクションの定義 - カテゴリーの構成と影響度
• ルールのテンプレート - 新しいルールを追加するためのテンプレート

リファレンスファイル

ファイル	説明
references/_sections.md	カテゴリーの定義と順序
assets/templates/_template.md	新しいルール用のテンプレート
metadata.json	バージョンとリファレンス情報