git提交标准工具

npm工具

NPM是随同NodeJS一起安装的包管理工具，能解决NodeJS代码部署上的很多问题，常见的使用场景有以下几种：

允许用户从NPM服务器下载别人编写的第三方包到本地使用。
允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。
允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。

git提交标准工具是基于npm环境下的一类js包提供的功能。

以下为目前所用的package.json

{
  "name": "{项目名称}",
  "version": "{项目版本}",
  "description": "{项目描述}",
  "main": "index.js",
  "directories": {
    "doc": "doc"
  },
  "dependencies": {
    "commitizen": "^4.2.2",
    "conventional-changelog-cli": "^2.1.1",
    "conventional-gitlab-releaser": "^4.0.3",
    "cz-conventional-changelog": "^3.3.0",
    "npm-check-updates": "^10.2.5",
    "standard-changelog": "^2.0.27",
    "standard-version": "^9.0.0",
    "validate-commit-msg": "^2.14.0"
  },
  "scripts": {
    "release": "CONVENTIONAL_GITLAB_RELEASER_TOKEN=$TOKEN conventional-gitlab-releaser -p angular -u $GITLAB_URL -t $TOKEN",
    "version": "standard-version",
    "commit": "git cz",
    "update": "npm-check-updates -u ; npm update"
  },
  "author": "fulong",
  "license": "ISC",
  "repository": {
    "type": "git",
    "url": "git+{项目的git http链接}"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  }
}

如果不是使用gitlab的话，命令release为不可用。

环境准备

安装npm工具
填写package.json中需要填写的内容

使用方法

把package.json放到项目根目录中
工具包安装，运行npm install ,如果网络不好,可运行代理模式npm config set proxy=http://127.0.0.1:8087;npm install
提交工具更新，运行npm run update
代码本地提交，运行npm run commit
代码版本发布，运行npm run version
代码推送到gitlab服务器，运行GITLAB_URL=${gitlab url} TOKEN=${gitlab api token} npm run release

命令解析与效果

npm install/npm config set proxy=http://127.0.0.1:8087;npm install

proxy后面接的是代理地址

npm run update

运行命令后会自动更新package.json中的包

npm run commit

feat 代码提交的新的特性
fix 修复bug
docs 只修改了文档
style 只修改了样式，像更改了换行符，空格，格式等待
refactor 改的地方既不是bug也不是特性
perf 提升性能
test 增加测试用例

第一行：显示刚选择的项
第二行：这次修改的主题
第三行：这次修改的简易描述
第四行：这次修改的详细描述
第五行：是否这次修改会带来不兼容问题
第六行：是否这次会影响相关的issue,如果有影响的话一般有这几种类型,re #issue num 影响这个issue,fix #issue num ，修复这个issue bug，close #issue num ，关闭这个issue

以下为所有选择是的git commit效果