導入: なぜ今、Knipが必要なのか
開発期間が数年におよぶプロジェクトでは、機能の廃止や仕様変更に伴い、「どこからも参照されていないコード」や「インストールしたものの使われていないnpmパッケージ」が蓄積していきます。これらは単なる無駄ではなく、ビルド時間の増大、CI/CDパイプラインの遅延、そして新規参画者がコードを読み解く際の認知負荷を高める「技術的負債」の温床です。Knipは、プロジェクト内の静的解析を行うことで、これらの不要な要素を自動的に特定し、安全な断捨離を支援する強力なツールです。
基礎知識: Knipとは何か
Knipは、Node.jsベースのプロジェクトを解析し、未使用のファイル、エクスポート、依存関係をレポートする静的解析ツールです。eslintやtsc（TypeScript）のような静的解析ツールと異なり、「プロジェクト全体を横断して、何が使われ、何が放置されているか」を可視化することに特化しています。依存関係グラフを構築し、エントリーポイントから到達できないコードを論理的に判別するため、手作業でのgrep検索よりも圧倒的に正確です。
実装/解決策: Knipの導入と実行手順
まずは対象のプロジェクトのルートディレクトリで、以下のコマンドを実行してインストールを行います。
npm install knip –save-dev
設定ファイルを作成することで、特定のディレクトリを除外したり、特殊なエントリーポイント（特定のビルドツールのみが読み込むファイルなど）を指定したりすることが可能です。
サンプルプログラム: 基本的な設定ファイル（knip.json）
プロジェクトのルートに以下のファイルを作成してください。
{
“$schema”: “https://unpkg.com/knip@next/schema.json”,
“entry”: [
“src/index.ts”, // メインのエントリーポイント
“src/pages//.tsx” // ページコンポーネント
],
“project”: [
“src//.ts”, // ソースコード全体を解析対象にする
“src//.tsx”
],
“ignore”: [
“src/types/custom.d.ts” // 解析対象外にするファイルやディレクトリ
],
“ignoreDependencies”: [
“eslint-plugin-prettier” // 依存関係として検知させたくないパッケージを指定
]
}
設定後、以下のコマンドで実行します。
npx knip
実行すると、ターミナル上に「未使用の依存関係」「未使用のエクスポート」「未使用のファイル」がカテゴリ別に一覧表示されます。
応用・注意点: 運用上の落とし穴を避ける
Knipは非常に強力ですが、以下の点に注意してください。
1. 動的な参照の考慮
動的なrequireやimport()、あるいは特定のフレームワークによる暗黙的な依存関係は、Knipが自動で検知できない場合があります。その場合は、設定ファイルのignoreオプションで除外設定を行う必要があります。
2. 段階的な削除
Knipで「未使用」と判定されたからといって、いきなり全てを削除するのは危険です。特にCI/CDで動的に参照される設定ファイルなどは誤検知の可能性があります。まずは「未使用のパッケージ」から削除し、次に「明らかに不要なファイル」を削除するという手順で、段階的に安全性を担保しながら進めましょう。
3. CIへの組み込み
開発者のローカル環境だけで実行するのではなく、GitHub ActionsなどのCIパイプラインに組み込むことを推奨します。これにより、コードレビューの段階で「新しく追加されたが使われていないコード」を検知でき、プロジェクトの肥大化を未然に防ぐことができます。
コメント