內容

不要提交的內容

當您將 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 upgradepubspec.yaml 中的更改而導致依賴項更改時,鎖定檔案中的差異將很明顯。