2.0.2 • Published 8 months ago

@2030/commitlint-config v2.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

:sparkles:@2030/commitlint-config

npm NPM GitHub top language npm bundle size npm

代码提交规则标准规范

:fire:风格说明

  • 标题不能为空且不得超过108个字符
  • Scope可选
  • 规范标准提交类型
  • 可配合插件 seatonjiang.gitmoji-vscode 使用
  • 默认提交类型
    [
      'init',               // 初次提交
      'work',               // 工作进行中
      'feat',               // 添加新功能
      'fix',                // 修复BUG
      'typos',              // 修改错别字
      'style',              // 改进项目结构/代码格式
      'docs',               // 添加/更新文档
      'config',             // 添加/修改配置文件
      'comments',           // 添加/更新注释
      'rename',             // 移动/重命名文件/路径
      'chore',              // 添加/删除代码/文件
      'perf',               // 优化性能
      'log',                // 添加/更新日志
      'refactor',           // 重构代码
      'test',               // 添加/修改测试用例
      'build',              // 构建/部署流程
      'release',            // 发布新版本
      'i18n',               // 国际化
      'revert',             // 回滚提交
      'merge',              // 合并分支
      'contributor',        // 添加贡献者
      'types',              // 类型声明或修改
      'ci',                 // 持续集成
    ]

:bulb:使用说明

1. 安装

  • npm 安装:
    > npm i -D @commitlint/cli @2030/commitlint-config
  • yarn 安装:
    > yarn add -D @commitlint/cli @2030/commitlint-config
  • pnpm 安装:
    > pnpm add -D @commitlint/cli @2030/commitlint-config

2. 项目根目录配置

  • @2030 基本规则
  • @2030/commitlint-config-emoji 强制使用emoji规则
  • .commitlintrc.json 配置:
    {
      "extends": ["@2030/commitlint-config"],
    }
  • .commitlintrc.yml 配置:
    extends: "@2030/commitlint-config"
  • .commitlintrc.js 配置:
    module.exports = {
      extends: ["@2030/commitlint-config"]
    }

3. VScode配置(推荐插件搭配使用)

  • 安装插件:
    # 安装插件
    code --install-extension seatonjiang.gitmoji-vscode
  • 配置 settings.json 文件:
    {
      "gitmoji.addCustomEmoji": [
        {
          "description": "初次提交",
          "emoji": "init:"
        },
        {
          "description": "工作进行中",
          "emoji": "work:"
        },
        {
          "description": "添加新功能",
          "emoji": "feat:"
        },
        {
          "description": "修复BUG",
          "emoji": "fix:"
        },
        {
          "description": "修复拼写错误/错别字",
          "emoji": "typos:"
        },
        {
          "description": "改进项目结构/代码格式",
          "emoji": "style:"
        },
        {
          "description": "添加/更新文档",
          "emoji": "docs:"
        },
        {
          "description": "添加/修改配置文件",
          "emoji": "config:"
        },
        {
          "description": "添加/更新注释",
          "emoji": "comment:"
        },
        {
          "description": "移动/重命名文件/路径",
          "emoji": "rename:"
        },
        {
          "description": "添加/删除代码/文件",
          "emoji": "chore:"
        },
        {
          "description": "优化性能",
          "emoji": "perf:"
        },
        {
          "description": "添加/更新日志",
          "emoji": "log:"
        },
        {
          "description": "重构代码",
          "emoji": "refactor:"
        },
        {
          "description": "添加/更新测试用例",
          "emoji": "test:"
        },
        {
          "description": "构建/部署功能",
          "emoji": "build:"
        },
        {
          "description": "发行版本标签",
          "emoji": "release:"
        },
        {
          "description": "国际化",
          "emoji": "i18n:"
        },
        {
          "description": "回滚提交",
          "emoji": "revert:"
        },
        {
          "description": "合并分支",
          "emoji": "merge:"
        },
        {
          "description": "添加/更新贡献者",
          "emoji": "contributor:"
        },
        {
          "description": "添加/更新类型声明文件",
          "emoji": "types:"
        },
        {
          "description": "持续集成",
          "emoji": "ci:"
        }
      ],
      "gitmoji.onlyUseCustomEmoji": true
    }

4. 添加校验钩子

  • Husky(V9+ 支持)

    # husky初始化
    pnpm add husky -D
    pnpm exec husky init
    • 添加 commit-msg 钩子
      echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg
  • simple-git-hooks

    # 添加simple-git-hooks依赖
    pnpm add simple-git-hooks -D
    • 添加 package.jsonprepare 脚本
    {
      "scripts": {
        "prepare": "simple-git-hooks"
      }
    }
    • 添加 package.json 钩子
    {
      "simple-git-hooks": {
        "commit-msg": "pnpm commitlint --edit $1",
      }
    }

:key:License

MIT License © 2024 ZiJun

2.0.2

8 months ago

2.0.1

10 months ago

2.0.0-beta.2

10 months ago

2.0.0

10 months ago

1.0.1

3 years ago

1.0.0

3 years ago

0.0.7

3 years ago

0.0.6

3 years ago

0.0.6-beta.15

3 years ago

0.0.6-beta.13

3 years ago

0.0.6-beta.11

3 years ago

0.0.5

3 years ago

0.0.4-beta.2

3 years ago

0.0.4-beta.1

3 years ago

0.0.4-beta.0

3 years ago

0.0.3

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago