Contents

What not to commit

使用pub工具GitHub或其他源代码管理系统将Dart源代码放入存储库时,不要包括IDE或代码编辑器,pub工具以及其他工具生成的大多数文件.

The rules

不要提交 pub创建的以下文件和目录:

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

不要提交 dartdoc创建的API文档目录:

doc/api/

不要提交其他开发环境创建的文件和目录. 例如,如果您的开发环境创建以下任何文件,请考虑将它们放在全局忽略文件中:

*.iml         // IntelliJ
*.ipr         // IntelliJ
*.iws         // IntelliJ
.idea/        // IntelliJ
.DS_Store     // Mac

有关更多详细信息,请继续阅读.

Details

通常,仅提交人们使用您的软件包或源代码存储库所需的文件. 如果公开了有关计算机设置的详细信息,则不需要包含其他文件,这可能适得其反,并且可能会对安全性产生影响. 在许多源代码存储库中,通常的做法是根本不提交生成的文件.

为避免提交特定于您的个人工作流程或设置的文件,请考虑使用全局忽略文件(例如.gitignore_global ).

当您从Git存储库中使用pub时,pub将忽略与Git相同的文件. 例如,如果您从Git keys.txt运行pub publish ,该keys.txt具有一个包含keys.txt.gitignore文件,那么您发布的包将不包含keys.txt文件.

有关.gitignore文件的更多信息,请参见GitHub帮助页面" 忽略文件".

.packages

.packages文件包含您的应用程序使用的依赖项列表. 您的代码用户应使用pub get生成自己的软件包信息.

pubspec.lock

pubspec.lock文件是一种特例,类似于Ruby的Gemfile.lock .

对于库包提交pubspec.lock文件.

对于应用程序包提交pubspec.lock . 对于非共享资源(例如应用程序)管理其依赖项,建议使用此文件.

by  ICOPY.SITE