uniapp 中 .gitgnore 的配置

859 阅读2分钟
# 忽略 HBuilderX 生成的项目文件夹
/local
/unpackage

# 忽略 npm/node_modules
node_modules/

# 忽略 HBuilderX 编辑器的配置文件
.project
.settings/
*.tmp
*.log

# 忽略 dist 编译目录(可以根据你的项目需要调整)
/dist/
/build/

# 忽略 UniCloud 云函数的本地日志、临时文件
cloudfunctions/**/node_modules/
cloudfunctions/**/unpackage/
cloudfunctions/**/.cloud
cloudfunctions/**/package-lock.json
cloudfunctions/**/dist/
cloudfunctions/**/.DS_Store
cloudfunctions/**/tmp/
cloudfunctions/**/log/

# 忽略 DCloud 云开发的本地临时文件
cloudbase/
unicloud/

# 忽略 Android 和 iOS 构建文件(针对 App 项目)
platforms/android/
platforms/ios/
*.keystore
*.jks

# 忽略 macOS 的系统文件
.DS_Store

# 忽略 Windows 的系统文件
Thumbs.db

各部分详解:

  1. HBuilderX 项目文件夹
    • /local/unpackage:这些文件夹是 HBuilderX 生成的本地项目文件,通常不需要上传到 Git 仓库。
  1. Node.js 相关文件
    • node_modules/:如果你在项目中使用 npm 包管理工具,node_modules 文件夹会存放所有安装的依赖库,通常不需要提交到 Git,因为依赖库可以通过 package.json 重新安装。
    • package-lock.json:云函数目录中的 package-lock.json 通常也不需要提交,除非你想锁定依赖版本。
  1. UniCloud 云函数相关文件
    • cloudfunctions/**/node_modules/:云函数中的 node_modules 文件夹也应该被忽略,跟前端项目类似,不需要提交到版本控制。
    • cloudfunctions/**/dist/:编译后的文件。
    • .cloud:云函数的临时文件夹,包含上传信息等。
    • .DS_StoreThumbs.db:分别是 macOS 和 Windows 的系统文件,通常没有必要提交到 Git。
  1. Android 和 iOS 构建文件
    • platforms/android/platforms/ios/:针对 App 项目,在构建原生 Android 或 iOS 应用时生成的文件不需要提交到 Git 仓库,因为这些文件可以通过构建工具自动生成。
    • *.keystore*.jks:是签名文件,属于敏感信息,不能提交到 Git 仓库中。
  1. 系统文件
    • .DS_StoreThumbs.db:这些是 macOS 和 Windows 系统生成的隐藏文件,不需要提交。

其他需要考虑的文件:

  • 环境变量或配置文件:如果你使用了 .env 文件或类似的配置文件来管理环境变量,确保这些文件中的敏感信息不会被上传到 Git。你可以在 .gitignore 中添加类似 *.env 的规则。
  • 其他编译生成的文件:根据你的项目需求,如果有其他编译生成的文件或临时文件,也可以在 .gitignore 中添加规则。

总结

定义 .gitignore 文件是为了确保将有用的代码和必要的配置提交到 Git 仓库,同时忽略不必要的文件(如依赖、临时文件、编译文件)。根据 UniApp + UniCloud 项目的结构和工具的特点,上述 .gitignore 文件能够帮助你过滤掉不需要提交的文件。