前端工程 .gitignore 常用配置项及其解析

782 阅读1分钟

当创建一个前端项目时,通常需要一个 .gitignore 文件来指定哪些文件和目录应该被 Git 忽略。下面是一个常见的前端项目的 .gitignore 文件示例,以及每一项的详细解析:

# Dependency directories
/node_modules
/.pnp
.pnp.js

# Build output
/dist
/build
/out

# Editor directories and files
/.vscode
/.idea
/.DS_Store
*.sublime-project
*.sublime-workspace

# Logs and debugging
/logs
/debug.log
/coverage

# Environment variables
.env.local
.env.development.local
.env.test.local
.env.production.local

# Cache and compiled files
/.cache
/.sass-cache
*.css.map
*.js.map

# Miscellaneous
.DS_Store
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

解析如下:

  • /node_modules:忽略项目的依赖文件夹,因为它们可以通过package.jsonpackage-lock.jsonyarn.lock重新安装。
  • /.pnp.pnp.js:忽略PnP(Plug'n'Play)相关的文件。
  • /dist/build:忽略构建输出目录,因为这些文件可以通过构建脚本重新生成。
  • /.vscode/.idea:忽略编辑器相关的配置文件夹,例如VS Code和IntelliJ IDEA。
  • /.DS_Store:忽略Mac OS系统生成的.DS_Store文件。
  • *.sublime-project*.sublime-workspace:忽略Sublime Text相关的项目和工作区文件。
  • /logs/debug.log:忽略日志文件和调试日志。
  • /coverage:忽略代码覆盖率报告。
  • .env.local.env.development.local.env.test.local.env.production.local:忽略本地环境变量文件,这些文件通常用于存储开发、测试和生产环境的配置。
  • /.cache/.sass-cache:忽略缓存文件夹。
  • *.css.map*.js.map:忽略CSS和JavaScript的源映射文件。
  • .DS_Store:忽略Mac OS系统生成的.DS_Store文件。
  • *.lognpm-debug.log*yarn-debug.log*yarn-error.log*:忽略日志文件。