0.1.0 • Published 3 years ago

y-commit v0.1.0

Weekly downloads
1
License
MIT
Repository
github
Last release
3 years ago

y-commit

npm package

包名地址描述
yorkienpm package增强 git commit(类似 husky)
lint-stagednpm package只校验提交的代码
commitizennpm package可视化的选择 commit 信息
cz-conventional-changelognpm package生成日志
conventional-changelog-clinpm package日志 CLI
@commitlint/clinpm packagecommitlint 规范
@commitlint/config-conventionalnpm packagecommitlint 配置

提交规范合集, 安装了以上所有依赖。

使用 / use

$ yarn cz  # 相当于 git add . && git commit -m'feat: commit msg'

以后想要 commit 代码,只需要使用这个命令即可。

$ yarn log # 添加日志

按照版本号自动生成 CHANGELOG.md 到你的工作根目录。

安装 / Install

$ yarn add y-commit --dev

配置 / Config

$ npx y-commit

安装好插件之后,只需要跑一下这个命令,就会增量的,添加以下配置到你的项目 package.json中。

{
  "scripts": {
    "cz": "git add . && git cz",
     "log": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md"
  },
  "gitHooks": {
    "pre-commit": "lint-staged",
    "commit-msg": "commitlint -E GIT_PARAMS"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  }
}

并拷贝 commitlint.config.js 文件到 package.json 文件夹相同目录。