メインコンテンツにスキップ

コミットしないもの

Dart ソースコードをリポジトリ(pub ツールGitHub、またはその他のソースコード管理システムを使用)に含める場合、IDE やコードエディタ、pub ツール、その他のツールが生成するほとんどのファイルを含めないでください。

ルール

#

pub によって作成された以下のファイルおよびディレクトリはコミットしないでください

.dart_tool/
build/
pubspec.lock  # Except for application packages

dart doc によって作成された API ドキュメントディレクトリはコミットしないでください

doc/api/

他の開発環境によって作成されたファイルおよびディレクトリはコミットしないでください。たとえば、開発環境が以下のいずれかのファイルを作成する場合、グローバル無視ファイルに含めることを検討してください。

# IntelliJ
*.iml
*.ipr
*.iws
.idea/

# Mac
.DS_Store

詳細については、以下をお読みください。

詳細

#

原則として、パッケージやソースコードリポジトリを使用するために人々が必要とするファイルのみをコミットしてください。追加のファイルを含めることは不要であり、逆効果になる可能性があり、マシンのセットアップの詳細を公開した場合、セキュリティ上の問題を引き起こす可能性があります。多くのソースコードリポジトリでは、生成されたファイルを一切コミットしないのが一般的です。

個人のワークフローやセットアップに固有のファイルをコミットすることを避けるために、グローバル無視ファイル(例: .gitignore_global)の使用を検討してください。

Git リポジトリ内で pub を使用する場合、pub は Git が無視するのと同じファイルを無視します。たとえば、keys.txt を含む .gitignore ファイルがある Git リポジトリから pub publish を実行した場合、公開されるパッケージに keys.txt ファイルは含まれません。

.gitignore ファイルに関する詳細については、GitHub のヘルプページ「ファイルを無視する」を参照してください。

.dart_tool/

#

.dart_tool/ ディレクトリには、さまざまな Dart ツールが使用するファイルが含まれています。

pubspec.lock

#

pubspec.lock ファイルは、Ruby の Gemfile.lock に似た特別なケースです。

通常のパッケージでは、pubspec.lock ファイルをコミットしないでくださいpubspec.lock ファイルを再生成することで、パッケージを依存関係の最新の互換性のあるバージョンでテストできます。

アプリケーションパッケージでは、pubspec.lock ファイルをコミットすることをお勧めします。pubspec.lock ファイルをバージョン管理することで、推移的な依存関係の変更が明示的になります。dart pub upgrade または pubspec.yaml の変更により依存関係が変更されるたびに、ロックファイルに違いが表示されます。