What Not to CommitSend feedback
When you put Dart source code in a repository—using the pub tool, GitHub, or another source code management system—don’t include most of the files that your IDE or code editor, the pub tool, and other tools generate.
Don’t commit the following files and directories created by pub:
build/ pubspec.lock // Except for application packages .packages .pub/
Don’t commit the API documentation directory created by dartdoc:
Don’t commit files and directories created by other development environments. For example, if your development environment creates any of the following files, consider putting them in a global ignore file:
*.iml // IntelliJ *.ipr // IntelliJ *.iws // IntelliJ .idea/ // IntelliJ .DS_Store // Mac
For more details, read on.
As a rule, commit only the files that people need to use your package or source code repository. Including additional files is unnecessary, could be counterproductive, and might have security implications if you expose details about your machine’s setup. In many source code repositories, the common practice is not to commit generated files, at all.
To avoid committing files that are
specific to your personal workflow or setup,
consider using a global ignore file
When you use pub from within a Git repo,
pub ignores the same files that Git does.
For example, if you run
pub publish from a Git repo
that has a
.gitignore file containing
then your published package won’t contain
For more information on
see the GitHub help page
.packages file contains a list of dependencies used by your application.
Users of your code should generate their own packages information
using pub get.
pubspec.lock file is a special case,
similar to Ruby’s
For library packages, do not commit the
For application packages, do commit
This file is the recommended way for non-shared resources
such as applications to manage their dependencies.
Calling dart2js without any flags generates
out.js, but the
tools that invoke dart2js often specify an output name, such as:
dart2js -o main.dart.js main.dart