@fespec/commitlint-config

前端工程化规范 - Commitlint 配置

简介

本包提供了前端项目的 Commitlint 配置，用于规范化 Git 提交信息格式，确保提交信息清晰、一致、可追溯。

安装

# 使用 npm
npm install -D @fespec/commitlint-config @commitlint/cli

# 使用 yarn
yarn add -D @fespec/commitlint-config @commitlint/cli

# 使用 pnpm
pnpm add -D @fespec/commitlint-config @commitlint/cli

使用方法

在项目根目录创建 .commitlintrc.js 或 commitlint.config.js 文件，并添加以下内容：

module.exports = {
  extends: ['@fespec/commitlint-config']
};

配合 husky 使用

为了在每次提交前自动检查提交信息格式，建议配合 husky 使用：

# 安装 husky
pnpm add -D husky

# 初始化 husky
npx husky install

# 添加 commit-msg hook
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'

提交信息格式规范

本配置基于 conventional-changelog，提交信息应遵循以下格式：

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Type

• feat: 新增功能
• fix: 修复 bug
• docs: 文档相关的变更
• style: 不影响代码功能的变更（如格式化、空格等）
• refactor: 代码重构，不新增功能也不修复 bug
• perf: 性能优化
• test: 添加或修改测试代码
• build: 构建系统或外部依赖的变更
• ci: CI 配置的变更
• chore: 其他不修改源代码或测试代码的变更
• revert: 回滚之前的提交

示例

feat(user): 添加用户登录功能

添加了用户登录页面和登录 API 集成

Closes #123