{"_id":"@aa-standard/commitlint-config","_rev":"2-1f44c4001169ea729a541b18bc53959e","name":"@aa-standard/commitlint-config","dist-tags":{"latest":"1.0.2"},"versions":{"2.0.0":{"name":"@aa-standard/commitlint-config","version":"2.0.0","keywords":[],"author":"","license":"ISC","_id":"@aa-standard/commitlint-config@2.0.0","maintainers":[{"name":"runzhi.li","email":"lirunzhi5810@gmail.com"}],"dist":{"shasum":"e8b939c4fb2e52ac6faaf446d65c2473e34b84b8","tarball":"https://registry.npmjs.org/@aa-standard/commitlint-config/-/commitlint-config-2.0.0.tgz","fileCount":3,"integrity":"sha512-IigY4wjkLCHOMZnFlQxmaUB03+oY3X/fz1WSNeVL4kihXnvfLzuwovBO32Yc4eXXqhnpDi/WxrhPg9iKKn3nrg==","signatures":[{"sig":"MEQCIH2xgHuS+uOk5uKYvdkCCG/TpzvAJelh7s/dp8z9VWg3AiB8kRxZVBc5vhuvJJV/3ejQnH3A1bCp5PiFESZ6K6yWeQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":903},"main":"src/index.js","_from":"file:aa-standard-commitlint-config-2.0.0.tgz","scripts":{},"_npmUser":{"name":"runzhi.li","email":"lirunzhi5810@gmail.com"},"_resolved":"/private/var/folders/3b/j52nkt8d0nj_dkxjz6z5wtm00000gt/T/4afd08b9c21c7763a43f4c846b415acb/aa-standard-commitlint-config-2.0.0.tgz","_integrity":"sha512-IigY4wjkLCHOMZnFlQxmaUB03+oY3X/fz1WSNeVL4kihXnvfLzuwovBO32Yc4eXXqhnpDi/WxrhPg9iKKn3nrg==","_npmVersion":"9.8.1","description":"","directories":{},"_nodeVersion":"18.18.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"@commitlint/cli":"^19.3.0","@commitlint/config-conventional":"^19.2.2"},"_npmOperationalInternal":{"tmp":"tmp/commitlint-config_2.0.0_1718848108887_0.01755660876356835","host":"s3://npm-registry-packages"}},"2.0.1":{"name":"@aa-standard/commitlint-config","version":"2.0.1","keywords":[],"author":"","license":"ISC","_id":"@aa-standard/commitlint-config@2.0.1","maintainers":[{"name":"runzhi.li","email":"lirunzhi5810@gmail.com"}],"dist":{"shasum":"1e0e32116b3d3f29250ee0fd88702acc0e7c0cb0","tarball":"https://registry.npmjs.org/@aa-standard/commitlint-config/-/commitlint-config-2.0.1.tgz","fileCount":3,"integrity":"sha512-IrFS0yvDxf5lJiUXhZCbS4GftAhNpCj7r5XSPCUEUFF16RLOwar+kOKk7kKxtBqM5iOaMMTYnH8gGK3Pe2GhQA==","signatures":[{"sig":"MEYCIQCRtsqo1aIceuOVE+N6+NrE2l7mudP3B2+kE8IprKafEgIhAMO/fj2HCVbIV4N9WW9+at+0y0U4pg9QNxy6jtQpn1Ms","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":937},"main":"index.js","_from":"file:aa-standard-commitlint-config-2.0.1.tgz","scripts":{},"_npmUser":{"name":"runzhi.li","email":"lirunzhi5810@gmail.com"},"_resolved":"/private/var/folders/3b/j52nkt8d0nj_dkxjz6z5wtm00000gt/T/5a9af5504c4a0312a81d6342c8e613ea/aa-standard-commitlint-config-2.0.1.tgz","_integrity":"sha512-IrFS0yvDxf5lJiUXhZCbS4GftAhNpCj7r5XSPCUEUFF16RLOwar+kOKk7kKxtBqM5iOaMMTYnH8gGK3Pe2GhQA==","_npmVersion":"9.8.1","description":"","directories":{},"_nodeVersion":"18.18.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"@commitlint/cli":"^19.3.0","@commitlint/config-conventional":"^19.2.2"},"_npmOperationalInternal":{"tmp":"tmp/commitlint-config_2.0.1_1718865445074_0.6751710546932712","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@aa-standard/commitlint-config","version":"1.0.2","description":"## 规范意义 1. 在阅读代码时（code review），通过commit message了解到代码编写的背景和作用 2. 修复bug时可以通过浏览commit message快速定位相关的提交记录以及对应代码","main":"index.js","publishConfig":{"access":"public"},"keywords":[],"author":"","license":"ISC","peerDependencies":{"@commitlint/cli":"^19.3.0","@commitlint/config-conventional":"^19.2.2"},"scripts":{},"_id":"@aa-standard/commitlint-config@1.0.2","_integrity":"sha512-6JVi53xFut6ZYgMaMC+hQvpPU6IUcx/mLadUbY8rnfQGHAumTPHWPBsbiCfyJnu7ly/L+8//fItYKGsOyxbanA==","_resolved":"/private/var/folders/3b/j52nkt8d0nj_dkxjz6z5wtm00000gt/T/2d9816e5f5cff678d188574a792158c4/aa-standard-commitlint-config-1.0.2.tgz","_from":"file:aa-standard-commitlint-config-1.0.2.tgz","_nodeVersion":"18.18.0","_npmVersion":"9.8.1","dist":{"integrity":"sha512-6JVi53xFut6ZYgMaMC+hQvpPU6IUcx/mLadUbY8rnfQGHAumTPHWPBsbiCfyJnu7ly/L+8//fItYKGsOyxbanA==","shasum":"095f21b554af97bdc7caee3bfbe5b01a5add463c","tarball":"https://registry.npmjs.org/@aa-standard/commitlint-config/-/commitlint-config-1.0.2.tgz","fileCount":4,"unpackedSize":3922,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFmqN5nd1mDuErdBFlAZqkbDN8yYPxxZHZevK48TtUeJAiAGuzm6P7/zEeefbfTFVhj6lsw5hLAr4dtZMl8OBKiY9w=="}]},"_npmUser":{"name":"runzhi.li","email":"lirunzhi5810@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/commitlint-config_1.0.2_1719059097426_0.8403595162150679"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-20T01:48:28.747Z","modified":"2024-06-22T12:24:57.797Z","2.0.0":"2024-06-20T01:48:29.081Z","2.0.1":"2024-06-20T06:37:25.210Z","1.0.2":"2024-06-22T12:24:57.572Z"},"maintainers":[{"name":"runzhi.li","email":"lirunzhi5810@gmail.com"}],"keywords":[],"license":"ISC","readme":"# `@aa-standard/commitlint-config`\n\n## 规范意义\n1. 在阅读代码时（code review），通过commit message了解到代码编写的背景和作用\n2. 修复bug时可以通过浏览commit message快速定位相关的提交记录以及对应代码\n\n## 参考资料\n> 规范参考Angular(Conventional Commits 1.0.0)的git commit格式规范，并进行了一些扩展\n>\n> 阮一峰 Commit message 和 Change log 编写指南：[https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html](https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html)\n> \n>Angular git commit 规范原文：[https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.greljkmo14y0](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.greljkmo14y0)\n\n## 格式说明\n每次提交，Commit message 都包括三个部分：Header（必须），Body（可省略） 和 Footer（可省略）\n\n```\n<type, 必填>(<scope，可省略>): <subject，必填>\n// 空一行\n<body，可省略>\n// 空一行\n<footer，可省略>\n```\n\n\n1. type（必填）：用于说明 commit 的类别，只允许使用下面7个标识。\n      - feat：新功能（feature）\n      - fix：修补bug\n      - i18n：修改国际化相关\n      - UI：样式修改（不影响代码功能）\n      - docs：文档（documentation）\n      - style： 代码格式（不影响代码运行的变动）\n      - refactor：重构（即不是新增功能，也不是修改bug的代码变动）\n      - test：增加测试\n      - chore：构建过程或辅助工具的变动\n      - ...\n2. scope（可省略）：用于说明 commit 影响的范围，比如某个模块、某个功能。\n3. subject（必填）：是 commit 目的的简短描述（功能描述 + [#选填禅道号码]），不超过50个字符。\n4. body（可省略）：部分是对本次 commit 的详细描述，可以分成多行。\n5. footer（可省略）：部分只用于两种情况：不兼容变动、关闭 Issue。\n\n### 举例\n1. feat: 增加内容(#33)\n2. fix(H5): 新增验证 (#99)\n*// 注意 这里使用的\":\"是英文冒号*\n\n## 使用说明\n\n### 前置依赖\n1. `husky`\n2. `lint-stage`\n3. `@commitlint/cli`\n\n### 安装\n```\nnpm install @commitlint/cli @aa-standard/commitlint-config\n\n// or\n\nyarn add @commitlint/cli @aa-standard/commitlint-config --dev\n```\n\n### 配置\n执行 pnpm exec husky init 会生成.husky文件 文件下会有pre-commit 再创建commit-msg\n<!-- pre-commit文件内1 -->\n```js\n    pnpm exec lint-staged\n```\n<!-- commit-msg文件内1 -->\n```js\n    pnpm exec commitlint --edit $1\n```\n\n使用时搭配git hooks工具完成提交前对commit message格式的校验\n- 使用vue-cli启动的项目，在`package.json`中增加\n```json\n{\n  \"lint-staged\": {\n    \"*.{js,jsx,vue}\": [\n      \"pnpm exec eslint --fix\"\n    ],\n    \"*.{scss,less,styl,css,html,vue,jsx}\": [\n      \"pnpm exec stylelint --fix\"\n    ]\n  }\n}\n```\n","readmeFilename":"README.md","description":"## 规范意义 1. 在阅读代码时（code review），通过commit message了解到代码编写的背景和作用 2. 修复bug时可以通过浏览commit message快速定位相关的提交记录以及对应代码"}