commitlint-config-hcl 0.0.3-alpha.0

package/LICENSE

@@ -0,0 +1 @@
+MIT

package/README.md

@@ -0,0 +1,42 @@
+# `commitlint-config-hcl`
+
+> 基础通用的Git Commitlint规范
+
+支持配套的 [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-hcl @commitlint/cli --save-dev
+```
+
+## 使用
+
+在 `commitlint.config.js` 中继承本包:
+
+```javascript
+module.exports = {
+  extends: ['commitlint-config-hcl'],
+};
+```
+
+## 设置 git hook
+
+可通过 [husky](https://www.npmjs.com/package/husky) 设置在 `git commit` 时触发 `commitlint`。
+
+首先安装 husky：
+
+```bash
+npm install husky --save-dev
+```
+
+然后手动在`.husky`目录下添加`commit-msg`文件:
+
+内容：
+```bash
+npx commitlint --edit $1
+```
+
+更多信息可参考 [commitlint 文档](https://commitlint.js.org/#/guides-local-setup?id=install-husky)。

package/index.js

@@ -0,0 +1,19 @@
+module.exports = {
+  parserPreset: {
+    name: 'conventional-changelog-conventionalcommits',
+  },
+  rules: {
+    'body-leading-blank': [1, 'always'],
+    'body-max-line-length': [2, 'always', 100],
+    'footer-leading-blank': [1, 'always'],
+    'footer-max-line-length': [2, 'always', 100],
+    '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'],
+    'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'style', 'test', 'refactor', 'chore', 'revert']],
+  },
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "commitlint-config-hcl",
+  "version": "0.0.3-alpha.0",
+  "description": "基于 commitlint 配置的基础通用的Git Commitlint规范",
+  "license": "ISC",
+  "author": "hechenglong <1104907547@qq.com>",
+  "main": "index.js",
+  "files": [
+    "index.js"
+  ],
+  "keywords": [
+    "commit",
+    "lint"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "homepage": "https://github.com/15272410401/front-end-coding-specification#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/15272410401/front-end-coding-specification.git"
+  },
+  "bugs": {
+    "url": "https://github.com/15272410401/front-end-coding-specification/issues"
+  },
+  "dependencies": {
+    "conventional-changelog-conventionalcommits": "^10.2.0"
+  },
+  "gitHead": "2cf5f56362c04886dc8f937985cabd5794615f4d"
+}