{"id":22903367,"url":"https://github.com/walrusjs/commit","last_synced_at":"2025-07-11T03:02:47.051Z","repository":{"id":99009658,"uuid":"347880712","full_name":"walrusjs/commit","owner":"walrusjs","description":"采用交互的方式帮你生成规范的提交消息","archived":false,"fork":false,"pushed_at":"2021-03-18T06:26:06.000Z","size":191,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-20T12:08:37.696Z","etag":null,"topics":["commit","commit-message","git"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/walrusjs.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-15T07:51:02.000Z","updated_at":"2025-05-10T05:06:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"1c378e97-9e70-4844-9ab8-17f163adfb98","html_url":"https://github.com/walrusjs/commit","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/walrusjs/commit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/walrusjs%2Fcommit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/walrusjs%2Fcommit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/walrusjs%2Fcommit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/walrusjs%2Fcommit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/walrusjs","download_url":"https://codeload.github.com/walrusjs/commit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/walrusjs%2Fcommit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264719228,"owners_count":23653540,"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","commit-message","git"],"created_at":"2024-12-14T02:36:05.207Z","updated_at":"2025-07-11T03:02:47.012Z","avatar_url":"https://github.com/walrusjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e@walrus/commit\u003c/h1\u003e\n\n\u003e 采用交互的方式帮你生成规范的提交消息\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"600\" src=\"./docs/commit.svg\"\u003e\n\u003c/p\u003e\n\n本 demo 使用 [svg-term-cli](https://github.com/marionebl/svg-term-cli) 生成。\n\n## 📦 安装\n\n- npm 安装\n\n```bash\nnpm install @walrus/commit --dev --save\n```\n\n- yarn 安装\n\n```bash\nyarn add @walrus/commit --dev\n```\n\n## 🔨 使用\n\n```sh\nnpx commit\n```\n\n本工具支持使用配置文件修改配置，优先级：\n\n- commit.config.ts\n- commit.config.js\n- .commitrc.ts\n- .commitrc.js\n\n目前支持如下配置\n\n- types \n  - 描述：修改类型配置\n  - 类型：`{ name: string; emoji?: string; description: string }[]`\n- skipCommit\n  - 描述：跳过commit\n  - 类型：`boolean`\n- skipPush\n  - 描述：跳过push\n  - 类型：`boolean`\n\n## 内置的修改类型\n\n- 💥 feat: 新功能\n- 🐛 fix: 修复BUG\n- 🚑 quickfix: 重要补丁\n- 🚧 wip: 工作进行中\n- 💄 ui: 修改UI或者样式文件\n- 📖 docs: 文档相关\n- 🔧 config: 修改配置文件\n- 🏷️  types: 添加或更新类型(Flow, TypeScript).\n- ✏️ typo: 修改错别字\n- 🔨 refactor: 代码重构\n- ⏪ revert: 回退代码\n- 🚚 mv: 移动或重命名文件\n- 🔥 remove: 删除代码或文件\n- 🗑️  disuse: 废弃或删除\n- 🐎 perf: 性能优化\n- 🚀 deploy: 部署功能\n- 🔖 release: 发布版本\n- 🎨 style: 优化代码结构、格式\n- 👽 compat: 由于外部API更新导致更新代码\n- ✅ test: 添加测试\n- 🎬 demo: 演示及示例\n- 🚨 lint: 移除 linter 警告\n- 🌐 i18n: 国际化\n- 🎉 init: 初始化代码\n- 🐳 docker: Docker 相关\n- 📦 deps: 更新依赖\n- ➕ dep-add: 添加依赖\n- ➖ dep-rm: 删除依赖\n- ⬇️  downgrade: 降级依赖\n- ⬆️  upgrade: 升级依赖\n- 📌 pushpin: 锁定依赖\n- 👷 ci: 添加 CI 构建系统\n- 💚 fix-ci: 修复 CI 构建问题\n- 🔒 security: 修复安全问题\n- 🔀 merge: 分支合并\n- 🍎 osx: 修复 macOS 系统下的问题.\n- 🐧 linux: 修复 Linux 系统下的问题\n- 🏁 windows: 修复 Windows 系统下的问题\n- 🤖 android: 修复 Android 系统下的问题\n- 🍏 ios: 修复 IOS 系统下的问题\n- 📈 analytics: 添加分析或跟踪代码\n\n## commit message 格式如下\n\n```\n\u003ctype\u003e[optional scope]: \u003cdescription\u003e\n\n[optional body]\n\n[optional footer(s)]\n```\n\n完整示例\n\n```\n💥 feat(login): 完成登录功能\n\n添加登录表单\n联调登录接口\n...\n\nReviewed-by: Tom\nRefs #133\nClose #100\n```\n\n## 感谢\n\n- [emojify](https://github.com/mrowa44/emojify)\n- [git-commit-emoji-cn](https://github.com/liuchengxu/git-commit-emoji-cn)\n- [commitlint](https://github.com/conventional-changelog/commitlint)\n- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)\n- [cz-emoji](https://github.com/ngryman/cz-emoji)\n- [svg-term-cli](https://github.com/marionebl/svg-term-cli)\n- [asciinema](https://github.com/asciinema/asciinema)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwalrusjs%2Fcommit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwalrusjs%2Fcommit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwalrusjs%2Fcommit/lists"}