型生成
型安全な翻訳キーのための自動生成TypeScript定義と完全なIDEオートコンプリート。
仕組み
i1n pull を実行すると、CLI はプロジェクト内のすべての翻訳キーの TypeScript 型定義を含む i1n.d.ts ファイルを生成します。
このファイルは、すべての翻訳キーをドット表記のパスにマッピングし、コンパイル時の検証と完全なIDEオートコンプリートを提供します。
メリット
型安全な翻訳キーは、タイポやキーの欠落による実行時エラーを排除します。IDEは入力中に利用可能なすべてのキーを表示し、オートコンプリートの候補を表示します。
リファクタリングは安全です。ソースファイルでキーの名前を変更すると、コードベース全体でコンパイル時に検出されます。
使用方法
生成された i1n.d.ts ファイルは、TypeScript コンパイルに自動的に含まれます。このファイルを直接編集しないでください。i1n のプルごとに再生成されます。
型安全なキー定数を i1n.d.ts からインポートし、翻訳関数で使用することで、確実な正しさを保証します。
i1n.d.ts
export const common = {
greeting: "common.greeting",
errors: {
not_found: "common.errors.not_found"
}
} as const;