@icebreakers/commitlint-config 1.1.1 → 1.2.0

package/README.md

@@ -0,0 +1,67 @@
+# @icebreakers/commitlint-config
+
+`@icebreakers/commitlint-config` 是一个基于 `@commitlint/config-conventional` 的可配置 preset。我们在保留社区标准的基础上，提供了一套函数式 API，方便团队按需扩展类型、Scope、Subject 等规则，并同步更新 commit prompt 元数据。
+
+## 快速开始
+
+```bash
+pnpm add -D @icebreakers/commitlint-config
+```
+
+### 使用默认配置
+
+`commitlint.config.ts`
+
+```ts
+import { icebreaker } from '@icebreakers/commitlint-config'
+
+export default icebreaker()
+```
+
+### 自定义选项
+
+```ts
+import { icebreaker, RuleConfigSeverity } from '@icebreakers/commitlint-config'
+
+export default icebreaker({
+  types: {
+    definitions: [
+      {
+        value: 'deps',
+        title: 'Dependencies',
+        description: '依赖升级',
+        emoji: '📦',
+      },
+    ],
+  },
+  scopes: {
+    values: ['core', 'docs'],
+    required: true,
+  },
+  subject: {
+    forbidden: ['sentence-case', 'start-case'],
+    caseSeverity: RuleConfigSeverity.Warning,
+  },
+  header: {
+    maxLength: 100,
+  },
+})
+```
+
+## 导出的工具
+
+- `icebreaker(options?)`: 推荐使用的工厂函数，合并默认规则与自定义规则。
+- `createIcebreakerCommitlintConfig(options?)`: 与 `icebreaker` 等效的底层函数，便于需要显式命名的场景。
+- `RuleConfigSeverity`: Enum，用于声明 commitlint 规则的严重级别。
+- `CommitTypesOptions`、`CommitScopeOptions`、`CommitSubjectOptions`、`CommitHeaderOptions`: 细粒度配置类型。
+- `CommitlintUserConfig`: 对应 commitlint 的最终配置类型。
+
+## 测试
+
+```bash
+pnpm --filter @icebreakers/commitlint-config test
+```
+
+## 许可证
+
+MIT License。

package/dist/index.cjs

@@ -1,8 +1,10 @@
-"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
+"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
 var _configconventional = require('@commitlint/config-conventional'); var _configconventional2 = _interopRequireDefault(_configconventional);
+
+// src/types.ts
 var _types = require('@commitlint/types');
-var DEFAULT_EXTENDS = ["@commitlint/config-conventional"];
-var DEFAULT_PARSER_PRESET = "conventional-changelog-conventionalcommits";
+
+// src/utils.ts
 function asArray(value) {
   if (value === void 0) {
     return [];
@@ -23,6 +25,8 @@ function mergeUnique(values) {
   }
   return result;
 }
+
+// src/builders.ts
 function resolveBaseTypeRule() {
   const rule = _optionalChain([_configconventional2.default, 'access', _ => _.rules, 'optionalAccess', _2 => _2["type-enum"]]);
   if (Array.isArray(rule)) {
@@ -158,6 +162,12 @@ function buildHeaderRules(options) {
   }
   return rules;
 }
+
+// src/constants.ts
+var DEFAULT_EXTENDS = ["@commitlint/config-conventional"];
+var DEFAULT_PARSER_PRESET = "conventional-changelog-conventionalcommits";
+
+// src/prompt.ts
 function mergePrompts(base, override) {
   if (!base && !override) {
     return void 0;
@@ -177,6 +187,8 @@ function mergePrompts(base, override) {
     }
   };
 }
+
+// src/index.ts
 function createIcebreakerCommitlintConfig(options = {}) {
   const { types, scopes, subject, header } = options;
   const extendsList = mergeUnique([
@@ -196,16 +208,19 @@ function createIcebreakerCommitlintConfig(options = {}) {
     ...rules,
     ..._nullishCoalesce(options.rules, () => ( {}))
   };
-  const hasRules = Object.keys(mergedRules).length > 0;
   const prompt = mergePrompts(typesConfig.prompt, options.prompt);
   return {
     extends: extendsList,
     parserPreset: DEFAULT_PARSER_PRESET,
-    ...hasRules ? { rules: mergedRules } : {},
+    ...Object.keys(mergedRules).length > 0 ? { rules: mergedRules } : {},
     ...prompt ? { prompt } : {}
   };
 }
+function icebreaker(options) {
+  return createIcebreakerCommitlintConfig(options);
+}
+
 
 
 
-exports.RuleConfigSeverity = _types.RuleConfigSeverity; exports.createIcebreakerCommitlintConfig = createIcebreakerCommitlintConfig;
+exports.RuleConfigSeverity = _types.RuleConfigSeverity; exports.createIcebreakerCommitlintConfig = createIcebreakerCommitlintConfig; exports.icebreaker = icebreaker;

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { RuleConfigCondition, RuleConfigSeverity, TargetCaseType, RulesConfig, UserPromptConfig, UserConfig } from '@commitlint/types';
+import { RulesConfig, RuleConfigCondition, RuleConfigSeverity, TargetCaseType, UserPromptConfig, UserConfig } from '@commitlint/types';
 export { UserConfig as CommitlintUserConfig, RuleConfigSeverity } from '@commitlint/types';
 
 interface CommitTypeDefinition {
@@ -43,6 +43,8 @@ interface IcebreakerCommitlintOptions {
     header?: CommitHeaderOptions;
     prompt?: UserPromptConfig;
 }
+
 declare function createIcebreakerCommitlintConfig(options?: IcebreakerCommitlintOptions): UserConfig;
+declare function icebreaker(options?: IcebreakerCommitlintOptions): UserConfig;
 
-export { type CommitHeaderOptions, type CommitScopeOptions, type CommitSubjectOptions, type CommitTypeDefinition, type CommitTypesOptions, type IcebreakerCommitlintOptions, createIcebreakerCommitlintConfig };
+export { type CommitHeaderOptions, type CommitScopeOptions, type CommitSubjectOptions, type CommitTypeDefinition, type CommitTypesOptions, type IcebreakerCommitlintOptions, createIcebreakerCommitlintConfig, icebreaker };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { RuleConfigCondition, RuleConfigSeverity, TargetCaseType, RulesConfig, UserPromptConfig, UserConfig } from '@commitlint/types';
+import { RulesConfig, RuleConfigCondition, RuleConfigSeverity, TargetCaseType, UserPromptConfig, UserConfig } from '@commitlint/types';
 export { UserConfig as CommitlintUserConfig, RuleConfigSeverity } from '@commitlint/types';
 
 interface CommitTypeDefinition {
@@ -43,6 +43,8 @@ interface IcebreakerCommitlintOptions {
     header?: CommitHeaderOptions;
     prompt?: UserPromptConfig;
 }
+
 declare function createIcebreakerCommitlintConfig(options?: IcebreakerCommitlintOptions): UserConfig;
+declare function icebreaker(options?: IcebreakerCommitlintOptions): UserConfig;
 
-export { type CommitHeaderOptions, type CommitScopeOptions, type CommitSubjectOptions, type CommitTypeDefinition, type CommitTypesOptions, type IcebreakerCommitlintOptions, createIcebreakerCommitlintConfig };
+export { type CommitHeaderOptions, type CommitScopeOptions, type CommitSubjectOptions, type CommitTypeDefinition, type CommitTypesOptions, type IcebreakerCommitlintOptions, createIcebreakerCommitlintConfig, icebreaker };

package/dist/index.mjs

@@ -1,8 +1,10 @@
-// src/index.ts
+// src/builders.ts
 import conventionalConfig from "@commitlint/config-conventional";
+
+// src/types.ts
 import { RuleConfigSeverity } from "@commitlint/types";
-var DEFAULT_EXTENDS = ["@commitlint/config-conventional"];
-var DEFAULT_PARSER_PRESET = "conventional-changelog-conventionalcommits";
+
+// src/utils.ts
 function asArray(value) {
   if (value === void 0) {
     return [];
@@ -23,6 +25,8 @@ function mergeUnique(values) {
   }
   return result;
 }
+
+// src/builders.ts
 function resolveBaseTypeRule() {
   const rule = conventionalConfig.rules?.["type-enum"];
   if (Array.isArray(rule)) {
@@ -158,6 +162,12 @@ function buildHeaderRules(options) {
   }
   return rules;
 }
+
+// src/constants.ts
+var DEFAULT_EXTENDS = ["@commitlint/config-conventional"];
+var DEFAULT_PARSER_PRESET = "conventional-changelog-conventionalcommits";
+
+// src/prompt.ts
 function mergePrompts(base, override) {
   if (!base && !override) {
     return void 0;
@@ -177,6 +187,8 @@ function mergePrompts(base, override) {
     }
   };
 }
+
+// src/index.ts
 function createIcebreakerCommitlintConfig(options = {}) {
   const { types, scopes, subject, header } = options;
   const extendsList = mergeUnique([
@@ -196,16 +208,19 @@ function createIcebreakerCommitlintConfig(options = {}) {
     ...rules,
     ...options.rules ?? {}
   };
-  const hasRules = Object.keys(mergedRules).length > 0;
   const prompt = mergePrompts(typesConfig.prompt, options.prompt);
   return {
     extends: extendsList,
     parserPreset: DEFAULT_PARSER_PRESET,
-    ...hasRules ? { rules: mergedRules } : {},
+    ...Object.keys(mergedRules).length > 0 ? { rules: mergedRules } : {},
     ...prompt ? { prompt } : {}
   };
 }
+function icebreaker(options) {
+  return createIcebreakerCommitlintConfig(options);
+}
 export {
   RuleConfigSeverity,
-  createIcebreakerCommitlintConfig
+  createIcebreakerCommitlintConfig,
+  icebreaker
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@icebreakers/commitlint-config",
   "type": "module",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "icebreaker's commitlint config",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",