このページの目次

このページの目次

依存関係の管理方針

5 つの問い

依存関係を追加する前に、次の 5 つの問いに順番に答えること。

  1. プロジェクト内にすでに使える実装があるか。
  2. フレームワーク、プラットフォーム、標準ツールチェーンのいずれかで解決できるか。
  3. その依存関係は実際の要件を満たすか。
  4. 保守コストに見合うか。
  5. 標準ツールチェーンと互換性があるか。

適用例:TypeScript プロジェクトで、実行時検証のために zod を追加する場合。

  1. プロジェクト:実行時検証の仕組みは存在しない。
  2. プラットフォーム:TypeScript の型はコンパイル時にしか存在せず、リクエストボディや環境変数は実行時には型付けされていない。
  3. 要件:外部入力は実行時の境界を越えるため、使用前に検証が必要である。
  4. 保守:単一用途のライブラリで API の規模が小さく、追跡すべき依存関係は 1 つである。
  5. ツールチェーン:ランタイム専用のライブラリであり、pnpm でインストールし、oxlint や oxfmt と競合しない。

判断:zod を追加する。

同じ問いで、不要な依存関係も見分けられる。truncate のような文字列ヘルパーライブラリは、問い 3 の条件を満たさない。3 行の明確なコードで実装できるため、依存関係は不要である。プラットフォームの fetch で要件をすでに満たせる場合、axios は問い 2 の条件を満たさない。

数行のコードで明確に書ける処理のために、ライブラリを追加してはならない。

ユーザーの明示的な承認なしに、標準化されたツールを別の依存関係に置き換えてはならない。

互換性の参照先

互換性は、必須ツールチェーンを基準に評価すること。

推奨ライブラリの選定については、フロントエンドフレームワークとPython API スタックを参照すること。

これらの規則を支える標準化の原則は、エンジニアリング基本原則で定められている。