hs-code-standard v1.0.1

hs-code-standard

• 代码规范生成工具, 需 node > 14
• 推荐使用自动配置方式
• 若 .git 与 package.json 不在同层目录建议手动配置, 并修改 husky 相关路径配置
• 开始配置前请先保存所有更改确保工作区是干净的

自动配置

在项目中 package.json 目录下执行以下命令

npx hs-code-standard

手动自行配置

配置 husky

在项目中 package.json 目录下执行以下命令

npm install husky --save-dev
npm set-script prepare "husky install"
npm run prepare

配置 commitlint

• 复制 commitlint.config.js 到项目中 确保 与package.json 位于同一目录

• 复制 commit-msg 到项目中 确保与 package.json 位于同一目录

• 安装依赖

npm i @commitlint/cli @commitlint/config-conventional --save-dev

配置 changelog-cli

采用基于 conventional-changelog 的自定义 changelog

• 安装依赖

npm i @release-it/conventional-changelog conventional-changelog-cli conventional-changelog-hs-config --save-dev

• package.json 中增加 changelog 配置

"changelog": {
  "bugsUrl": "填写实际bugsUrl(例如: https://hesung.coding.net/p/dreo-app/iterations/10926/issues/)",
  "emojis": true
}

• 若在现有项目中导入此规范, 且想生成历史changelog, 需运行以下命令

npm set-script changelogInitial "conventional-changelog -p hs-config -i CHANGELOG.md -s -r 0"
npm run changelogInitial

配置 release-it

• 安装依赖

npm i release-it -g

• 设置 script 命令

npm set-script release "release-it"

• 复制配置文件 .release-it.js 到项目中 确保与 package.json 位于同一目录