在 WebStorm 中配置 .gitignore 文件的方法

1. 确保项目启用了 Git

在配置 .gitignore 文件之前，必须确保项目已使用 Git 举行版本控制。如果未初始化 Git，可以在 WebStorm 中举行以下操作：

• 打开 WebStorm，加载你的项目。
  
• 在菜单栏选择 VCS > Enable Version Control Integration。
  
• 在弹出的窗口中选择 Git，然后点击 OK。
  

---

2. 创建或编辑 .gitignore 文件

方法 1：手动创建 .gitignore 文件

• 在项目的根目录下，右键单击空白区域，选择 New > File。
  
• 命名文件为 .gitignore（确保文件名前带点）。
  
• 打开 .gitignore 文件，添加需要忽略的文件或目录。例如：
  1. # 忽略 node_modules 目录
  2. node_modules/
  4. # 忽略日志文件
  5. *.log
  7. # 忽略编译生成的文件
  8. dist/

  复制代码

方法 2：通过 WebStorm 内置功能添加 .gitignore

• 打开 Project 视图，右键需要忽略的文件或目录。
  
• 选择 Git > Add to .gitignore。
  
• 如果项目中没有 .gitignore 文件，WebStorm 会自动创建一个。
  

---

3. 验证 .gitignore 是否生效

• 在 .gitignore 文件中添加需要忽略的文件或目录。
  
• 打开 Version Control 工具窗口（可以通过快捷键 Cmd + 9 或 Ctrl + 9 打开）。
  
• 确保被忽略的文件未出现在 Unversioned Files 列表中。
  

---

4. 配置 .gitignore 的代码高亮和自动补全

WebStorm 提供了 .gitignore 文件的高亮和自动补全功能：

• 确保安装了 Git Integration 插件（WebStorm 默认启用）。
  
• 如果没有自动高亮 .gitignore，可以手动指定文件范例：
  
  
  
  • 右键 .gitignore 文件。
    
  • 选择 Associate with File Type。
    
  • 选择 Ignore files 范例。
    
  
  

---

5. 使用全局 .gitignore（可选）

如果渴望某些文件或目录对所有 Git 项目生效，可以配置全局 .gitignore 文件：

• 创建或编辑全局 .gitignore 文件：
  1. git config --global core.excludesfile ~/.gitignore_global

  复制代码
• 打开 ~/.gitignore_global 文件，添加全局忽略规则：
  1. # 忽略 macOS 的 .DS_Store 文件
  2. .DS_Store
  4. # 忽略 Windows 的缩略图缓存文件
  5. Thumbs.db

  复制代码

---

6. 忽略已被跟踪的文件（特别情况）

如果某些文件已经被 Git 跟踪，需要使用以下命令让 Git 停止跟踪这些文件，即使它们已经在 .gitignore 中：

• 停止跟踪文件：
  1. git rm --cached <file>

  复制代码
• 提交更改：
  1. git commit -m "Stop tracking <file>"

  复制代码

---

示例 .gitignore 配置

适用于常见项目（如 Node.js、Python 或 Java 项目）的示例：

1. # Node.js
2. node_modules/
3. dist/
4. npm-debug.log*
5. yarn-debug.log*
6. yarn-error.log*
8. # Python
9. __pycache__/
10. *.pyc
11. *.pyo
13. # Java
14. *.class
15. *.jar
16. *.war
17. *.ear
18. *.iml
20. # macOS
21. .DS_Store
23. # IDE 文件
24. .idea/
25. *.iml

复制代码

---

总结

在 WebStorm 中配置 .gitignore 文件的完整流程包罗：

• 确保项目启用了 Git。
  
• 手动或通过内置功能创建和编辑 .gitignore 文件。
  
• 验证忽略规则是否生效。
  
• 配置文件范例高亮和补全以提拔开辟体验。
  
• 可选地配置全局 .gitignore 或停止跟踪已提交的文件。
  

---

参考资料

• Git 官方文档 - .gitignore 文件
  
• JetBrains 官方文档 - Version Control Integration
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。