{"id":26335023,"url":"https://github.com/hengg/commit-msg-checker","last_synced_at":"2025-03-16T00:34:04.325Z","repository":{"id":39711831,"uuid":"249985995","full_name":"hengg/commit-msg-checker","owner":"hengg","description":"git commit message 校验器","archived":false,"fork":false,"pushed_at":"2022-05-27T07:12:27.000Z","size":24,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-07T08:05:47.204Z","etag":null,"topics":["commit-message","git"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hengg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-25T13:29:07.000Z","updated_at":"2024-04-09T01:48:52.000Z","dependencies_parsed_at":"2022-09-18T00:21:17.440Z","dependency_job_id":null,"html_url":"https://github.com/hengg/commit-msg-checker","commit_stats":null,"previous_names":["hengg/commit-msg-cli"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hengg%2Fcommit-msg-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hengg%2Fcommit-msg-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hengg%2Fcommit-msg-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hengg%2Fcommit-msg-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hengg","download_url":"https://codeload.github.com/hengg/commit-msg-checker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243809827,"owners_count":20351404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commit-message","git"],"created_at":"2025-03-16T00:33:59.773Z","updated_at":"2025-03-16T00:34:04.315Z","avatar_url":"https://github.com/hengg.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# commit-msg-checker\n校验git commit message 是否符合规范，需要Node 8 及以上版本\n\n默认的commit message规范为\u003ctype\u003e(\u003cscope\u003e):\u003csubject\u003e\n说明如下\n- type代表commit类型\n    ```bash\n    feat：新功能\n    fix：修复缺陷\n    docs：文档\n    style： 格式（不影响代码运行的变动）\n    refactor：重构（即不是新增功能，也不是修改bug的代码变动）\n    test：增加测试\n    chore：构建过程或辅助工具的变动\n    ci:CI工具相关变动\n    build:构建\n    perf:优化相关的变动\n    ```\n- scope为可选项，说明本次commit的变更范围\n- subject为本次变更的描述\n\n例如`docs(README):update changelog`和`fix:fix issue-3`都是符合规范的commit message\n\n## 安装\n```bash\nnpm i commit-msg-checker -D\n```\n## 使用\n在工程根目录下执行`checker-init`即可为项目添加检查\n\n也可以在package.json中添加自定义配置\n```json\n//package.json\n{\n    ...\n    \"msgChecker\":{\n        \"ignore\": \"^v([1-9])\", // 配置此项可忽略某些提交信息(lerna自动发包信息)\n        \"reg\": \"/\\s/\", // 配置此项可以自定义用于校验的正则表达式\n        \"check\":true // 可以通过将此项设置为false以关闭检查器\n    }\n    ...\n}\n```\n## TODO\n- ✅自定义校验规则\n- ✅帮助\n- ✅关闭检查功能\n- ✅提权\n- 单测覆盖\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhengg%2Fcommit-msg-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhengg%2Fcommit-msg-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhengg%2Fcommit-msg-checker/lists"}