@walrus/commit

@walrus/commit

Usage no npm install needed!

<script type="module">
  import walrusCommit from 'https://cdn.skypack.dev/@walrus/commit';
</script>

README

@walrus/commit

采用交互的方式帮你生成规范的提交消息

本 demo 使用 svg-term-cli 生成。

📦 安装

  • npm 安装
npm install @walrus/commit --dev --save
  • yarn 安装
yarn add @walrus/commit --dev

🔨 使用

npx commit

本工具支持使用配置文件修改配置，优先级：

  • commit.config.ts
  • commit.config.js
  • .commitrc.ts
  • .commitrc.js

目前支持如下配置

  • types
    • 描述：修改类型配置
    • 类型：{ name: string; emoji?: string; description: string }[]
  • skipCommit
    • 描述：跳过 commit
    • 类型：boolean
  • skipPush
    • 描述：跳过 push
    • 类型：boolean

内置的修改类型

  • 💥 feat: 新功能
  • 🐛 fix: 修复 BUG
  • 🚑 quickfix: 重要补丁
  • 🚧 wip: 工作进行中
  • 💄 ui: 修改 UI 或者样式文件
  • 📖 docs: 文档相关
  • 🔧 config: 修改配置文件
  • 🏷️ types: 添加或更新类型(Flow, TypeScript).
  • ✏️ typo: 修改错别字
  • 🔨 refactor: 代码重构
  • ⏪ revert: 回退代码
  • 🚚 mv: 移动或重命名文件
  • 🔥 remove: 删除代码或文件
  • 🗑️ disuse: 废弃或删除
  • 🐎 perf: 性能优化
  • 🚀 deploy: 部署功能
  • 🔖 release: 发布版本
  • 🎨 style: 优化代码结构、格式
  • 👽 compat: 由于外部 API 更新导致更新代码
  • ✅ test: 添加测试
  • 🎬 demo: 演示及示例
  • 🚨 lint: 移除 linter 警告
  • 🌐 i18n: 国际化
  • 🎉 init: 初始化代码
  • 🐳 docker: Docker 相关
  • 📦 deps: 更新依赖
  • ➕ dep-add: 添加依赖
  • ➖ dep-rm: 删除依赖
  • ⬇️ downgrade: 降级依赖
  • ⬆️ upgrade: 升级依赖
  • 📌 pushpin: 锁定依赖
  • 👷 ci: 添加 CI 构建系统
  • 💚 fix-ci: 修复 CI 构建问题
  • 🔒 security: 修复安全问题
  • 🔀 merge: 分支合并
  • 🍎 osx: 修复 macOS 系统下的问题.
  • 🐧 linux: 修复 Linux 系统下的问题
  • 🏁 windows: 修复 Windows 系统下的问题
  • 🤖 android: 修复 Android 系统下的问题
  • 🍏 ios: 修复 IOS 系统下的问题
  • 📈 analytics: 添加分析或跟踪代码

commit message 格式如下

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

完整示例

💥 feat(login): 完成登录功能

添加登录表单
联调登录接口
...

Reviewed-by: Tom
Refs #133
Close #100

感谢