大規模プロジェクトでは TypeScript が厳密: 開発を停止せずに段階的に移行
なぜ厳密を有効にできないのですか?
数百のファイルを含むプロジェクトでは、"strict": true によって数千のエラーが発生します。 1 つのブランチで修正するということは、全員と矛盾する PR を何週間も保持することを意味し、誰も適切にレビューできません。この間に開発を止めることもできません。新しいコードはすぐに厳密に記述され、古いコードは部分的に翻訳されるスキームが必要です。
strict に含まれるもの
strict フラグは個別のチェックのセットであり、それぞれを個別に有効にすることができます。
noImplicitAny- 推論できない型のパラメータと変数は、anyではなくエラーになります。strictNullChecks-nullおよびundefinedは、どのタイプの有効な値でもなくなりました。通常、最も多くのエラーが発生し、最も多くの利点が得られます。strictFunctionTypes、strictBindCallApply、strictPropertyInitialization、noImplicitThis、alwaysStrict、useUnknownInCatchVariables。
strict に含まれていないもう 1 つの便利なフラグは noUncheckedIndexedAccess です。arr[i] および record[key] にアクセスすると T | undefined が返されます。これは、最後に別のステップとして含める必要があります。
戦略 1: 一度に 1 つずつフラグを立てる
中規模プロジェクト向けの最も単純なスキーム:
- 1.エラーがほとんど発生しないフラグを有効にします (
alwaysStrict、strictBindCallApply、noImplicitThis) - 通常、これは数十回の編集を意味します。 - 2.
noImplicitAny: 機械的エラー。部分的に自動的に迅速に修正されます。 - 3.
strictNullChecks- メインステージ。 2 番目の戦略を使用して実行する方が便利です。 - 4.
strict: trueを有効にし、個々のフラグを削除します。
各ステップは個別の小さな PR であり、簡単に入力できます。
戦略 2: 翻訳されたファイルの厳密な構成
メインの tsconfig.json は非厳密なもののままですが、その隣に厳密なものが表示され、翻訳された部分のみがチェックされます。
// tsconfig.strict.json
{
"extends": "./tsconfig.json",
"compilerOptions": { "strict": true, "noEmit": true },
"include": [
"src/shared/lib/**/*",
"src/entities/user/**/*",
"next-env.d.ts"
]
}ここに重要な罠があります。 tsc は、include からのファイルだけでなく、インポートされるすべてのファイルもチェックします。翻訳されたモジュールが未翻訳のモジュールをインポートすると、未翻訳のモジュールからのエラーも出力に表示されます。したがって、これらは下から上に変換され (最初にユーティリティとモデル、次にそれらを使用するもの)、出力は変換されたパスのリストに従ってフィルター処理されます。
// scripts/check-strict.mjs
import { execSync } from "node:child_process";
import { readFileSync } from "node:fs";
const cfg = JSON.parse(readFileSync("tsconfig.strict.json", "utf8"));
const prefixes = cfg.include.map((p) => p.replace(/\*\*.*$/, ""));
let out = "";
try {
execSync("npx tsc -p tsconfig.strict.json --pretty false", { encoding: "utf8" });
} catch (e) {
out = e.stdout ?? "";
}
const errors = out.split("\n").filter((l) => /error TS\d+/.test(l) && prefixes.some((p) => l.startsWith(p)));
for (const e of errors) console.error(e);
process.exit(errors.length ? 1 : 0);スクリプトは必須の検証とともに CI に送信されます。フォルダーを include に追加しました。このフォルダーは回帰から永久に保護されています。
逆ロジックを使用した同じアプローチのための既製のツールがあります。 typescript-strict-plugin を使用すると、未翻訳のファイルをコメント // @ts-strict-ignore でマークすることで、プロジェクト全体で strict を有効にすることができ、CI で tsc-strict コマンドを使用してこれを確認できます。すでに翻訳ファイルが半分以上ある場合に便利です。
戦略 3: エラー数によるラチェット
すべてをすぐに解決することよりも、状況の悪化を防ぐことが重要な場合は、完全な厳密実行のエラーをカウントし、その数が増加しないようにするだけで十分です。
COUNT=$(npx tsc -p tsconfig.strict-all.json --noEmit --pretty false | grep -c "error TS" || true) BASELINE=$(cat .strict-baseline) if [ "$COUNT" -gt "$BASELINE" ]; then echo "strict errors: $COUNT > baseline $BASELINE"; exit 1 fi echo "$COUNT" > .strict-baseline # закоммитьте уменьшение в том же PR
各 PR は数値を変更しないか、減少させます。 betterer ツールは、同じことをより巧妙な方法で実行します。バグの合計数だけでなく、ファイルごとにバグを追跡するため、ある場所の修正が別の場所の新しいバグを隠すことはありません。
悪化しないように修正する方法
目標は、赤い下線を削除することではなく、型を正確にすることです。
- `!` (非 null アサーション) はコンパイル エラーを実行時エラーに変換します。これは、本当に保証があり、説明できる場合にのみ許容されます。それ以外の場合 - 早期終了による明示的なチェック。
- `any` → `unknown` 外部データ (JSON、API 応答、
catch (e)) の場合、チェックまたは検証スキームによって絞り込みます。 - `@ts-ignore` の代わりに `@ts-expect-error`。 最初のエラーは、エラーが存在しなくなったときに発生し、一時的な抑制が永久に存続するのを防ぎます。常に理由をコメント付きで。
- モデル内のオプションのフィールド。 データベース内のフィールドが
NOT NULLである場合、テストでオブジェクトを初期化する方が簡単であるという理由だけで、その型を?にするべきではありません。
翻訳されたディレクトリのエラー モードの ESLint ルール @typescript-eslint/no-explicit-any および @typescript-eslint/no-non-null-assertion は、古い習慣が戻るのを防ぎます。
仕事の組織化
- 小さな PR を 1 つのフォルダーにまとめ、機能の変更を混入することなく、簡単に確認してロールバックできます。
- 新しいファイルはすぐに厳密なゾーンに送信されます。そうしないと、未翻訳部分は減少するよりも早く増加します。
- 金銭の取り扱い、アクセス権、外部データの解析など、エラーが最も発生しやすいコードから始めます。
やりすぎてはいけないとき
間もなく削除される移行スクリプト、ワンタイム ユーティリティ、およびプロトタイプは翻訳する必要はありません。これらは厳密ゾーンから除外します。また、プロジェクトがアクティブな開発を行わずにサポート モードにある場合は、ラチェットだけで十分です。別の移行プロジェクトを必要とせずに、事態の悪化を防ぐことができます。