Angular .gitignore テンプレート解説

Angular.gitignore は Angular CLI プロジェクトのビルド結果とキャッシュを防ぐ。ルールのほとんどが / で始まり、ワークスペースルートにのみ適用される。

注意点は /package-lock.json と /yarn.lock を無視することである。npm は lockfile をソース管理に入れることを推奨しているため、アプリケーションならこの 2 行を削除するのが一般的である。

ルール別の解説

パターン	何を、なぜ無視するか
/dist//out-tsc//tmp/	ビルド結果ng build の結果、TypeScript コンパイルの中間出力、一時フォルダーである。
/.angular/.angular/	Angular CLI キャッシュAngular CLI がビルド高速化のために使うディスクキャッシュである。ルート固定のルールとあらゆる深さのルールを両方置き、サブプロジェクトのキャッシュも防ぐ。
/coverage//e2e/test-output/	テスト結果Karma・Jest のカバレッジと E2E テストの結果である。
/node_modules//package-lock.json/yarn.lock	依存関係と lockfilenode_modules は当然除外の対象だが、lockfile まで除外するとインストールのたびに依存関係のバージョンが変わるおそれがある。
/.env/.angular-cli.json/.ng/	環境・設定環境変数ファイルと、古い Angular CLI の設定ファイル・フォルダーである。
*.tsbuildinfonpm-debug.log*yarn-debug.log*yarn-error.log*	ログ・ビルド情報TypeScript のインクリメンタルビルド情報とパッケージマネージャーのログである。

実務での注意点

• ジェネレーターで Angular を選んだ後、追加ルールに !/package-lock.json を入れれば、テンプレートの原文を修正せずに lockfile を戻せる。
• src/environments/environment.ts には公開されてもよい値だけを置く。このファイルはビルド結果に含まれ、ブラウザに送られる。
• エディターの設定は VisualStudioCode・JetBrains テンプレートを併用する。

元のテンプレート

# Angular specific/dist//out-tsc//tmp//coverage//e2e/test-output//.angular/.angular/# Node modules and dependency files/node_modules//package-lock.json/yarn.lock# Environment files/.env# Angular CLI and build artefacts/.angular-cli.json/.ng/# TypeScript cache*.tsbuildinfo# Logsnpm-debug.log*yarn-debug.log*yarn-error.log*

一緒に使うテンプレート

ほかのテンプレートの解説