commitlint-config-tyler 1.0.1-alpha.0

package/README.md

@@ -0,0 +1,41 @@
+# `commitlint-config-tyler`
+
+> Git 规范
+
+支持配套的 [commitlint 配置](https://commitlint.js.org/#/concepts-shareable-config)，用于对 `git commit message` 进行校验。
+
+## 安装
+
+使用时，需要安装 [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli)：
+
+```bash
+npm install commitlint-config-tyler @commitlint/cli --save-dev
+```
+
+## 使用
+
+在 `commitlint.config.js` 中集成本包:
+
+```javascript
+module.exports = {
+  extends: ['encode'],
+};
+```
+
+## 设置 git hook
+
+可通过 [husky](https://www.npmjs.com/package/husky) 设置在 `git commit` 时触发 `commitlint`。
+
+首先安装 husky：
+
+```bash
+npm install husky --save-dev
+```
+
+然后执行添加`commit-msg`:
+
+```bash
+npx husky add .husky/commit-msg 'npx commitlint --edit $1'
+```
+
+更多信息可参考 [commitlint 文档](https://commitlint.js.org/#/guides-local-setup?id=install-husky)。

package/index.js

@@ -0,0 +1,29 @@
+module.exports = {
+  parserPreset: 'conventional-changelog-conventionalcommits',
+  rules: {
+    // 规定提交信息的身体部分必须以空行为开头。这里的1表示这是一个警告级别的规则（而不是错误级别），这意味着即使违反了这个规则，提交信息也不会被阻止，但是会发出警告提醒
+    'body-leading-blank': [1, 'always'],
+    // 这是限制提交信息主体部分的每行文本长度不能超过100个字符的规则。2表示这是一个错误级别的规则，如果违反了这个规则，提交信息会被阻止。
+    'body-max-line-length': [2, 'always', 100],
+    // 规定提交信息的底部部分必须以空行为开头，和主体部分的规则类似，这是一个警告级别的规则。
+    'footer-leading-blank': [1, 'always'],
+    // 限制提交信息的底部部分每行文本的长度不能超过100个字符。2表示这是一个错误级别的规则，如果违反了这个规则，提交信息会被阻止。
+    'footer-max-line-length': [2, 'always', 100],
+    // 限制提交信息的标题（即第一行）的长度不能超过100个字符。2表示这是一个错误级别的规则，如果违反了这个规则，提交信息会被阻止。
+    'header-max-length': [2, 'always', 100],
+    // 规定提交信息的作用域部分必须全部使用小写字母，这是一个错误级别的规则。
+    'scope-case': [2, 'always', 'lower-case'],
+    // 这个规则被禁用，意味着提交信息的主题部分的大小写没有特定的格式要求。
+    'subject-case': [0],
+    // 规定提交信息的主题部分不能为空，这是一个错误级别的规则。
+    'subject-empty': [2, 'never'],
+    // 规定提交信息的主题部分不能以句号（.）结尾，这是一个错误级别的规则。
+    'subject-full-stop': [2, 'never', '.'],
+    // 规定提交信息的类型部分必须全部使用小写字母，这是一个错误级别的规则。
+    'type-case': [2, 'always', 'lower-case'],
+    // 规定提交信息的类型部分不能为空，这是一个错误级别的规则。
+    'type-empty': [2, 'never'],
+    // 规定提交信息的类型部分必须是特定的值之一，比如feat（新功能）、fix（修复bug）等等，这是一个错误级别的规则。
+    'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'style', 'test', 'refactor', 'chore', 'revert']],
+  },
+};

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "commitlint-config-tyler",
+  "version": "1.0.1-alpha.0",
+  "main": "index.js",
+  "description": "Git规范",
+  "keywords": [
+    "tyler",
+    "commit",
+    "lint"
+  ],
+  "author": "tyler",
+  "homepage": "https://github.com/gaotianbin/tyler-fe-spec#readme",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gaotianbin/tyler-fe-spec.git"
+  },
+  "bugs": {
+    "url": "https://github.com/gaotianbin/tyler-fe-spec/issues"
+  },
+  "dependencies": {
+    "conventional-changelog-conventionalcommits": "^9.1.0"
+  },
+  "gitHead": "36fbdd062ef22de7415f0075597c2a91075d3d74"
+}