內容

不應提交的內容

當您將 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 中的變更而變更時,差異將會在鎖定檔案中顯示。