@icebreakers/commitlint-config 1.2.0 → 1.2.2

package/README.md

@@ -1,16 +1,20 @@
 # @icebreakers/commitlint-config
 
-`@icebreakers/commitlint-config` 是一个基于 `@commitlint/config-conventional` 的可配置 preset。我们在保留社区标准的基础上，提供了一套函数式 API，方便团队按需扩展类型、Scope、Subject 等规则，并同步更新 commit prompt 元数据。
+- [简体中文指南](./README.zh.md)
 
-## 快速开始
+## Overview
+
+`@icebreakers/commitlint-config` wraps `@commitlint/config-conventional`, exposes a typed factory API, and keeps commit prompts in sync with any custom types you add. Use it to enforce Conventional Commits across monorepos while tailoring type, scope, and subject rules per team.
+
+## Installation
 
 ```bash
-pnpm add -D @icebreakers/commitlint-config
+pnpm add -D @commitlint/cli @icebreakers/commitlint-config
 ```
 
-### 使用默认配置
+## Quick Start
 
-`commitlint.config.ts`
+Create `commitlint.config.ts` in the repository root:
 
 ```ts
 import { icebreaker } from '@icebreakers/commitlint-config'
@@ -18,50 +22,73 @@ import { icebreaker } from '@icebreakers/commitlint-config'
 export default icebreaker()
 ```
 
-### 自定义选项
+Add a script or Husky hook to run commitlint:
+
+```bash
+pnpm commitlint --from=HEAD~1
+```
+
+When you need explicit naming, use `createIcebreakerCommitlintConfig(options)`—it returns the same value as `icebreaker`.
+
+## Customising Rules
+
+The factory accepts targeted option groups so you can extend the default convention without re-implementing every rule:
 
 ```ts
-import { icebreaker, RuleConfigSeverity } from '@icebreakers/commitlint-config'
+import {
+  icebreaker,
+  RuleConfigSeverity,
+} from '@icebreakers/commitlint-config'
 
 export default icebreaker({
   types: {
     definitions: [
-      {
-        value: 'deps',
-        title: 'Dependencies',
-        description: '依赖升级',
-        emoji: '📦',
-      },
+      { value: 'docs', title: 'Docs', description: '文档更新', emoji: '📝' },
+      { value: 'deps', title: 'Dependencies', description: 'Bump deps' },
     ],
+    add: ['perf'],
   },
   scopes: {
-    values: ['core', 'docs'],
+    values: ['core', 'lint', 'website'],
     required: true,
+    case: ['kebab-case', 'lower-case'],
   },
   subject: {
     forbidden: ['sentence-case', 'start-case'],
     caseSeverity: RuleConfigSeverity.Warning,
+    fullStop: false,
   },
   header: {
     maxLength: 100,
   },
+  extends: ['@acme/commitlint-config'],
 })
 ```
 
-## 导出的工具
+- `types` – add new entries, merge prompt metadata, or tighten the `type-enum` rule.
+- `scopes` – whitelist scope values, enforce casing, or require scopes.
+- `subject` – forbid casing styles, configure punctuation, and allow empty subjects for merge commits when needed.
+- `header` – override maximum length or severity.
+- `extends` / `rules` – append extra commitlint configs or raw rule overrides.
+- `prompt` – merge additional prompt groups for interactive commit tools.
 
-- `icebreaker(options?)`: 推荐使用的工厂函数，合并默认规则与自定义规则。
-- `createIcebreakerCommitlintConfig(options?)`: 与 `icebreaker` 等效的底层函数，便于需要显式命名的场景。
-- `RuleConfigSeverity`: Enum，用于声明 commitlint 规则的严重级别。
-- `CommitTypesOptions`、`CommitScopeOptions`、`CommitSubjectOptions`、`CommitHeaderOptions`: 细粒度配置类型。
-- `CommitlintUserConfig`: 对应 commitlint 的最终配置类型。
+All rule severities use `RuleConfigSeverity` from `@commitlint/types`.
 
-## 测试
+## Prompt Synchronisation
 
-```bash
-pnpm --filter @icebreakers/commitlint-config test
-```
+The factory keeps commit prompts in sync with any custom type definitions. If you pass a `prompt` block, it deep merges with the conventional preset, so your CLI prompt automatically reflects newly added types or scopes.
+
+## Suggested Workflow
+
+1. Install Husky and configure a `commit-msg` hook:
+   ```bash
+   pnpm husky add .husky/commit-msg "pnpm commitlint --edit \"$1\""
+   ```
+2. Use `pnpm commit` (Changeset prompt) or your own CLI for guided commits.
+3. Add `pnpm lint` and `pnpm test` to CI so commits fail fast when rules change.
 
-## 许可证
+## Troubleshooting
 
-MIT License。
+- If commitlint cannot find the config file, ensure it is named `commitlint.config.ts` (or `.cjs`) at the repository root.
+- For workspaces that ship custom prompts, pass a `prompt` object instead of re-building the schema by hand.
+- To disable commits in scripts (e.g. release bots), set `COMMITLINT_DISABLED=true` and skip the hook execution.

package/README.zh.md

@@ -0,0 +1,92 @@
+# @icebreakers/commitlint-config
+
+## 概览
+
+`@icebreakers/commitlint-config` 在保留 `@commitlint/config-conventional` 的基础上提供了类型完备的工厂 API，可以按团队需求扩展类型、Scope、Subject 等规则，并自动同步 Commit Prompt 的选项。它非常适合在 Monorepo 中统一 Conventional Commits。
+
+## 安装
+
+```bash
+pnpm add -D @commitlint/cli @icebreakers/commitlint-config
+```
+
+## 快速开始
+
+在仓库根目录创建 `commitlint.config.ts`：
+
+```ts
+import { icebreaker } from '@icebreakers/commitlint-config'
+
+export default icebreaker()
+```
+
+在脚本或 Husky 钩子中调用：
+
+```bash
+pnpm commitlint --from=HEAD~1
+```
+
+如果需要显式函数名，也可以使用 `createIcebreakerCommitlintConfig(options)`，返回值与 `icebreaker` 完全一致。
+
+## 自定义规则
+
+工厂函数按类别接收配置，方便针对性地覆盖默认约束：
+
+```ts
+import {
+  icebreaker,
+  RuleConfigSeverity,
+} from '@icebreakers/commitlint-config'
+
+export default icebreaker({
+  types: {
+    definitions: [
+      { value: 'docs', title: 'Docs', description: '文档更新', emoji: '📝' },
+      { value: 'deps', title: 'Dependencies', description: '依赖升级' },
+    ],
+    add: ['perf'],
+  },
+  scopes: {
+    values: ['core', 'lint', 'website'],
+    required: true,
+    case: ['kebab-case', 'lower-case'],
+  },
+  subject: {
+    forbidden: ['sentence-case', 'start-case'],
+    caseSeverity: RuleConfigSeverity.Warning,
+    fullStop: false,
+  },
+  header: {
+    maxLength: 100,
+  },
+  extends: ['@acme/commitlint-config'],
+})
+```
+
+- `types`：新增类型、补充 Prompt 元数据或强化 `type-enum` 规则。
+- `scopes`：限定 Scope 值、设置大小写规则或强制 Scope 必填。
+- `subject`：限制 Subject 大小写、控制末尾标点、允许空 Subject。
+- `header`：修改头部长度或告警级别。
+- `extends` / `rules`：叠加额外的 commitlint 配置或自定义规则。
+- `prompt`：在保留原有交互式提示的前提下合并自定义菜单。
+
+所有严重级别均使用 `@commitlint/types` 暴露的 `RuleConfigSeverity`。
+
+## Prompt 同步
+
+工厂函数会将自定义类型合并进 commit Prompt。若传入 `prompt` 字段，会与默认配置深度合并，确保交互式命令自动展示新增的类型、Scope 或描述信息。
+
+## 推荐流程
+
+1. 安装 Husky 并配置 `commit-msg` 钩子：
+   ```bash
+   pnpm husky add .husky/commit-msg "pnpm commitlint --edit \"$1\""
+   ```
+2. 通过 `pnpm commit`（Changeset）或自定义的 CLI 引导书写 Commit。
+3. 在 CI 中运行 `pnpm lint`、`pnpm test`，并在发布脚本中保留 commitlint 校验。
+
+## 常见问题
+
+- commitlint 找不到配置时，请确认文件名为 `commitlint.config.ts`（或 `.cjs`），且位于仓库根目录。
+- 如需扩展交互式提示，直接传入 `prompt` 即可，无需手动拼装 Schema。
+- 若需在某些脚本中临时关闭校验，可在环境变量中设置 `COMMITLINT_DISABLED=true` 并跳过钩子。

package/dist/index.cjs

@@ -1,6 +1,9 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }// src/builders.ts
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }// src/index.ts
 var _configconventional = require('@commitlint/config-conventional'); var _configconventional2 = _interopRequireDefault(_configconventional);
 
+// src/builders.ts
+
+
 // src/types.ts
 var _types = require('@commitlint/types');
 
@@ -164,7 +167,7 @@ function buildHeaderRules(options) {
 }
 
 // src/constants.ts
-var DEFAULT_EXTENDS = ["@commitlint/config-conventional"];
+var DEFAULT_EXTENDS = [];
 var DEFAULT_PARSER_PRESET = "conventional-changelog-conventionalcommits";
 
 // src/prompt.ts
@@ -193,9 +196,13 @@ function createIcebreakerCommitlintConfig(options = {}) {
   const { types, scopes, subject, header } = options;
   const extendsList = mergeUnique([
     ...DEFAULT_EXTENDS,
-    ...mergeUnique(_nullishCoalesce(options.extends, () => ( [])))
+    ...asArray(
+      _configconventional2.default.extends
+    ),
+    ...asArray(options.extends)
   ]);
   const rules = {
+    ..._nullishCoalesce(_configconventional2.default.rules, () => ( {})),
     ...buildScopeRules(scopes),
     ...buildSubjectRules(subject),
     ...buildHeaderRules(header)
@@ -208,10 +215,11 @@ function createIcebreakerCommitlintConfig(options = {}) {
     ...rules,
     ..._nullishCoalesce(options.rules, () => ( {}))
   };
-  const prompt = mergePrompts(typesConfig.prompt, options.prompt);
+  const promptBase = _nullishCoalesce(typesConfig.prompt, () => ( _configconventional2.default.prompt));
+  const prompt = mergePrompts(promptBase, options.prompt);
   return {
-    extends: extendsList,
-    parserPreset: DEFAULT_PARSER_PRESET,
+    ...extendsList.length > 0 ? { extends: extendsList } : {},
+    parserPreset: _nullishCoalesce(_configconventional2.default.parserPreset, () => ( DEFAULT_PARSER_PRESET)),
     ...Object.keys(mergedRules).length > 0 ? { rules: mergedRules } : {},
     ...prompt ? { prompt } : {}
   };

package/dist/index.mjs

@@ -1,3 +1,6 @@
+// src/index.ts
+import conventionalConfig2 from "@commitlint/config-conventional";
+
 // src/builders.ts
 import conventionalConfig from "@commitlint/config-conventional";
 
@@ -164,7 +167,7 @@ function buildHeaderRules(options) {
 }
 
 // src/constants.ts
-var DEFAULT_EXTENDS = ["@commitlint/config-conventional"];
+var DEFAULT_EXTENDS = [];
 var DEFAULT_PARSER_PRESET = "conventional-changelog-conventionalcommits";
 
 // src/prompt.ts
@@ -193,9 +196,13 @@ function createIcebreakerCommitlintConfig(options = {}) {
   const { types, scopes, subject, header } = options;
   const extendsList = mergeUnique([
     ...DEFAULT_EXTENDS,
-    ...mergeUnique(options.extends ?? [])
+    ...asArray(
+      conventionalConfig2.extends
+    ),
+    ...asArray(options.extends)
   ]);
   const rules = {
+    ...conventionalConfig2.rules ?? {},
     ...buildScopeRules(scopes),
     ...buildSubjectRules(subject),
     ...buildHeaderRules(header)
@@ -208,10 +215,11 @@ function createIcebreakerCommitlintConfig(options = {}) {
     ...rules,
     ...options.rules ?? {}
   };
-  const prompt = mergePrompts(typesConfig.prompt, options.prompt);
+  const promptBase = typesConfig.prompt ?? conventionalConfig2.prompt;
+  const prompt = mergePrompts(promptBase, options.prompt);
   return {
-    extends: extendsList,
-    parserPreset: DEFAULT_PARSER_PRESET,
+    ...extendsList.length > 0 ? { extends: extendsList } : {},
+    parserPreset: conventionalConfig2.parserPreset ?? DEFAULT_PARSER_PRESET,
     ...Object.keys(mergedRules).length > 0 ? { rules: mergedRules } : {},
     ...prompt ? { prompt } : {}
   };

package/package.json

@@ -1,19 +1,23 @@
 {
   "name": "@icebreakers/commitlint-config",
   "type": "module",
-  "version": "1.2.0",
-  "description": "icebreaker's commitlint config",
+  "version": "1.2.2",
+  "description": "Commitlint preset from Icebreaker's dev-configs",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/sonofmagic/eslint-config.git",
+    "url": "git+https://github.com/sonofmagic/dev-configs.git",
     "directory": "packages/commitlint"
   },
   "bugs": {
-    "url": "https://github.com/sonofmagic/eslint-config/issues"
+    "url": "https://github.com/sonofmagic/dev-configs/issues"
   },
-  "keywords": [],
+  "keywords": [
+    "commitlint",
+    "dev-configs",
+    "icebreakers"
+  ],
   "sideEffects": false,
   "exports": {
     ".": {