.gitignore 文件 - Node.js & JavaScript

什么是 .gitignore 文件?

.gitignore 文件是一个用于 Git 版本控制系统的配置文件，用于指定哪些文件或目录不应该被 Git 跟踪。在一个项目中，通常有一些文件不需要被共享或跟踪，例如日志文件、缓存文件等。将这些文件添加到 .gitignore 文件中可以防止它们被误入 Git 仓库和共享到其他开发者。

如何创建 .gitignore 文件?

创建 .gitignore 文件非常简单。只需要在项目根目录下创建一个名为 .gitignore 的文件，并将需要排除的文件和目录名称添加到其中即可。注意，.gitignore 文件只能在工程目录的根目录下执行。

.gitignore 文件的格式

.gitignore 文件是一个文本文件，每一行表示一个文件或目录规则。以下为一些常见的规则：

• file.txt - 忽略指定的文件
• dir/ - 忽略指定的目录
• *.txt - 忽略所有扩展名为 .txt 的文件
• !example.txt - 不忽略指定的文件（用于覆盖前面的规则）
• # - 注释符号，用于添加注释

常见的 Node.js & JavaScript .gitignore 规则

Node.js 项目

# Dependency directories
node_modules/
jspm_packages/

# Logs
logs
*.log
npm-debug.log*

# Debugging
.vscode
node-inspector

# Dist files
dist

# Cache
*.sass-cache/
bower_components
.tern-port

# Environment
.env
.env.local
.env.*.local
!.env.example

# Tests
coverage
testling

JavaScript 项目

# Logs
logs
*.log

# Node_modules
node_modules/

# Distribution
dist/
.DS_Store

# Windows
Thumbs.db

# React components
node_modules/
lib/
.eslintcache

# OS X files
.DS_Store

注意：以上规则仅作为参考，根据项目的实际需求，我们需要根据实际情况来添加忽略规则。

如何验证 .gitignore 是否生效？

当我们添加了 .gitignore 文件后，我们需要验证文件是否生效。我们可以使用以下命令：

git status --ignored
git ls-files --others --exclude-standard

上述命令可以分别查看被 Git 忽略的文件和未被 Git 管理的文件。

总结

.gitignore 文件是管理项目中需要被 Git 忽略的文件/目录的配置文件。忽略不必要的文件可以减小 Git 仓库的大小，并提高仓库的效率。为了避免不必要的问题，我们应该定期更新 .gitignore 文件，并验证它是否生效。