跳到主要内容

配置

2023年02月24日
柏拉文
越努力，越幸运

一、commitlint.config.js​

安装好Commitlint之后，就需要配置Commitlint，可以在根目录创建commitlint.config.js文件进行配置。

1.1 配置​

  1. 在comminlint.config.js中加入以下代码，表示使用config-conventional规范对提交说明进行检查。

1.2 代码​

module.exports = {
    extends: ['@commitlint/config-conventional'],
    rules: {
        'type-enum': [
            // type枚举
            2,
            'always',
            [
                'build', // 编译相关的修改，例如发布版本、对项目构建或者依赖的改动
                'feat', // 新功能
                'fix', // 修补bug
                'docs', // 文档修改
                'style', // 代码格式修改, 注意不是 css 修改
                'refactor', // 重构
                'perf', // 优化相关，比如提升性能、体验
                'test', // 测试用例修改
                'revert', // 代码回滚
                'ci', // 持续集成修改
                'config', // 配置修改
                'chore', // 其他改动
            ],
        ],
        'type-empty': [2, 'never'], // never: type不能为空; always: type必须为空
        'type-case': [0, 'always', 'lower-case'], // type必须小写，upper-case大写，camel-case小驼峰，kebab-case短横线，pascal-case大驼峰，等等
        'scope-empty': [0],
        'scope-case': [0],
        'subject-empty': [2, 'never'], // subject不能为空
        'subject-case': [0],
        'subject-full-stop': [0, 'never', '.'], // subject以.为结束标记
        'header-max-length': [2, 'always', 72], // header最长72
        'body-leading-blank': [0], // body换行
        'footer-leading-blank': [0, 'always'], // footer以空行开头
    },
};

1.3 命令​

在package.json新增scripts命令 "commitlint": "commitlint --config commitlint.config.js -e -V" 用于校验 commit 规范

"scripts": {
    "start": "vite",
    "tsc": "tsc --noEmit",
    "build": "tsc && vite build",
    "lint-staged": "lint-staged",
    "postinstall": "husky install",
    "prettier": "prettier --write src/**/*.{ts,tsx}",
    "stylelint-fix": "stylelint src/**/*.scss --fix",
    "eslint-fix": "eslint src --ext .jsx,.js,.ts,.tsx --fix",
    "commitlint": "commitlint --config commitlint.config.js -e -V"
},

1.4 效果​

根据配置,项目提交时Commit的规范为:

  • "feat(修改的文件): 修改信息": 新增功能规范