hygiene

衛生チェック

VS Code では、git のコミット前フックとして衛生チェックを実行します。衛生チェックに失敗すると、コミットは拒否されます。

衛生チェックの実行

作業を完了とする前に、必ずコミット前の衛生チェックを実行してください。 コミットを妨げる問題を検出できます。

ステージングしたファイルに対して衛生チェックを実行するには、次のコマンドを実行します。

npm run precommit

このコマンドは node --experimental-strip-types build/hygiene.ts を実行し、git diff --cached の結果を使ってステージング済みのファイルのみをスキャンします。

ファイルをステージングせずに直接チェックするには、次のコマンドを実行します。

node --experimental-strip-types build/hygiene.ts path/to/file.ts

チェック項目

衛生チェック用リンターは、ステージング済みのファイルをスキャンし、次のような問題（これらに限定されません）を検出します。

• Unicode 文字：ASCII 以外の文字（em ダッシュ、曲がった引用符、絵文字など）は拒否されます。コメントとコードでは ASCII の代替文字を使用してください。// allow-any-unicode-next-line または // allow-any-unicode-comment-file を使って抑制できます。
• 二重引用符で囲まれた文字列：外部化（ローカライズ）された文字列に限り "二重引用符" を使用してください。それ以外ではすべて '単一引用符' を使用してください。
• 著作権ヘッダー：すべてのファイルに Microsoft の著作権ヘッダーを含める必要があります。
• インデント：タブのみを使用し、インデントにスペースを使わないでください。
• フォーマット：TypeScript ファイルはフォーマッターの出力と一致する必要があります（修正するには Format Document を実行してください）。
• ESLint：TypeScript ファイルは ESLint でリントされます。
• Stylelint：CSS ファイルは stylelint でリントされます。