本文已参与「新人创作礼」活动，一起开启掘金创作之路

本篇的主要内容是一些比较流行的可根据需要添加的配置项。所有的配置文件都建立在项目根目录下。

可选工程化配置文件

.editconfig

如果你的开发协作伙伴跟你使用的编辑器或者IDE不一样，那么EditorConfig（编辑器配置）可以帮助你。它有助于为跨各种编辑器和IDE处理同一项目的多个开发人员保持一致的编码风格，EditorConfig文件易于阅读，并且可以很好地与版本控制系统配合使用。

在项目根目录下创建.editconfig文件，并作如下配置（推荐）：

# http://editorconfig.org
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
insert_final_newline = false
trim_trailing_whitespace = false

README.md 和 CHANGELOG.md

这两个Markdown文件都属于项目规范的内容，用以帮助项目源码阅读人员和拯救之后的维护人员。

README.md

一般来说，我们会在该文件对项目做一些的介绍信息，并着重告诉读者如何将项目运行起来！

我们一般默认使用英文编写README.md文件，需要中文的话可以再添加一个README.zh-CN.md文件。

可以参考本项目

CHANGELOG.md

该部分属于自动化工程

在每次大变动或者添加全新的功能的时候请做好版本控制，并把改变的内容在此文件中列出。最后要的效果是在项目结束或者拿到某一个版本的时候，通过这个文件能知道当前版本都支持什么样的功能。

我们可以使用conventional-changelog来帮助我们自动生成CHANGLOG。

它的生态有几个重要的模块工具

这里我们只需要以标准化git commit信息的工具commitizen作为辅助，用全功能的命令行界面conventional-changelog-cli为我们生成更改日志。

commitizen 配置

我们先安装commitizen，使用他的git cz命令

pnpm install -D commitizen

通过键入以下内容初始化我们的项目以使用cz-conventional-changelog适配器

commitizen init cz-conventional-changelog --save-dev --s

在package.json文件中添加配置

...
  "config": {
    "commitizen": {
      "path": "cz-conventional-changelog"
    }
  }

这个配置一定要记得添加，不然会出现这种问题。没错，就是我犯得低级错误，hhhh ~

git add后，我们不再使用git commit，而是使用git cz

最后git push，完成一次规范的commitizen提交

conventional-changelog-cli 配置

安装conventional-changelog-cli

pnpm install -D conventional-changelog-cli

生成更改日志的命令（先不执行）

这个命令将覆盖任何以前的更改日志。

conventional-changelog -p angular -i CHANGELOG.md -s -r 0

为了方便运行该命令，我们在package.json中配置一个script脚本命令

"log": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"

pnpm log运行，生成我们的CHANGELOG更改日志

LICENSE

这里我们为自己的开源项目申请一个证书，值得一搞~

进入你项目的 git 仓库，点击Create new file创建新文件

输入LICENSE，后面会弹出license模板按钮

我们选择MIT License并提交

证书文件到手

最后，提交该文件到主分支即可

其他可能配置

gitpod为你的项目在云端创建自动化开发环境

deploy官网自动化部署

deployVite 自动化部署

（五）Vue3-huohuo-admin 工程配置 （Others）