@icebreakers/commitlint-config 1.0.4 → 1.1.1

package/dist/index.cjs

@@ -1,87 +1,211 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});// 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/index.ts
+var _configconventional = require('@commitlint/config-conventional'); var _configconventional2 = _interopRequireDefault(_configconventional);
 var _types = require('@commitlint/types');
-
-// ../../node_modules/.pnpm/defu@6.1.4/node_modules/defu/dist/defu.mjs
-function isPlainObject(value) {
-  if (value === null || typeof value !== "object") {
-    return false;
+var DEFAULT_EXTENDS = ["@commitlint/config-conventional"];
+var DEFAULT_PARSER_PRESET = "conventional-changelog-conventionalcommits";
+function asArray(value) {
+  if (value === void 0) {
+    return [];
   }
-  const prototype = Object.getPrototypeOf(value);
-  if (prototype !== null && prototype !== Object.prototype && Object.getPrototypeOf(prototype) !== null) {
-    return false;
-  }
-  if (Symbol.iterator in value) {
-    return false;
+  return Array.isArray(value) ? value : [value];
+}
+function mergeUnique(values) {
+  const seen = /* @__PURE__ */ new Set();
+  const result = [];
+  for (const value of values) {
+    if (value === void 0 || value === null) {
+      continue;
+    }
+    if (!seen.has(value)) {
+      seen.add(value);
+      result.push(value);
+    }
   }
-  if (Symbol.toStringTag in value) {
-    return Object.prototype.toString.call(value) === "[object Module]";
+  return result;
+}
+function resolveBaseTypeRule() {
+  const rule = _optionalChain([_configconventional2.default, 'access', _ => _.rules, 'optionalAccess', _2 => _2["type-enum"]]);
+  if (Array.isArray(rule)) {
+    const severity = _nullishCoalesce(rule[0], () => ( _types.RuleConfigSeverity.Error));
+    const condition = _nullishCoalesce(rule[1], () => ( "always"));
+    const values = _nullishCoalesce(rule[2], () => ( []));
+    return {
+      severity,
+      condition,
+      values: [...values]
+    };
   }
-  return true;
+  return {
+    severity: _types.RuleConfigSeverity.Error,
+    condition: "always",
+    values: []
+  };
 }
-function _defu(baseObject, defaults, namespace = ".", merger) {
-  if (!isPlainObject(defaults)) {
-    return _defu(baseObject, {}, namespace, merger);
+function buildTypesConfig(options) {
+  if (!options) {
+    return {};
   }
-  const object = Object.assign({}, defaults);
-  for (const key in baseObject) {
-    if (key === "__proto__" || key === "constructor") {
-      continue;
+  const baseRule = resolveBaseTypeRule();
+  const additional = mergeUnique([
+    ...baseRule.values,
+    ...mergeUnique(_nullishCoalesce(options.add, () => ( []))),
+    ...mergeUnique((_nullishCoalesce(options.definitions, () => ( []))).map((definition) => definition.value))
+  ]);
+  let rule;
+  if (additional.length > 0) {
+    rule = [
+      _nullishCoalesce(options.severity, () => ( baseRule.severity)),
+      _nullishCoalesce(options.condition, () => ( baseRule.condition)),
+      additional
+    ];
+  }
+  if (!_optionalChain([options, 'access', _3 => _3.definitions, 'optionalAccess', _4 => _4.length])) {
+    return { rule };
+  }
+  const basePromptType = _optionalChain([_configconventional2.default, 'access', _5 => _5.prompt, 'optionalAccess', _6 => _6.questions, 'optionalAccess', _7 => _7.type]);
+  const mergedEnum = {
+    ..._nullishCoalesce(_optionalChain([basePromptType, 'optionalAccess', _8 => _8.enum]), () => ( {}))
+  };
+  for (const definition of options.definitions) {
+    const { value, title, description, emoji } = definition;
+    mergedEnum[value] = {
+      ..._nullishCoalesce(mergedEnum[value], () => ( {})),
+      title,
+      description,
+      emoji
+    };
+  }
+  const prompt = {
+    ..._nullishCoalesce(_configconventional2.default.prompt, () => ( {})),
+    questions: {
+      ..._nullishCoalesce(_optionalChain([_configconventional2.default, 'access', _9 => _9.prompt, 'optionalAccess', _10 => _10.questions]), () => ( {})),
+      type: {
+        ..._nullishCoalesce(basePromptType, () => ( {})),
+        enum: mergedEnum
+      }
     }
-    const value = baseObject[key];
-    if (value === null || value === void 0) {
-      continue;
+  };
+  return { rule, prompt };
+}
+function buildScopeRules(options) {
+  if (!options) {
+    return {};
+  }
+  const rules = {};
+  const severity = _nullishCoalesce(options.severity, () => ( _types.RuleConfigSeverity.Error));
+  const scopeValues = mergeUnique(asArray(options.values));
+  if (scopeValues.length > 0) {
+    rules["scope-enum"] = [severity, "always", scopeValues];
+  }
+  if (options.required !== void 0) {
+    if (options.required) {
+      rules["scope-empty"] = [severity, "never"];
+    } else {
+      rules["scope-empty"] = [_types.RuleConfigSeverity.Disabled];
     }
-    if (merger && merger(object, key, value, namespace)) {
-      continue;
+  }
+  const scopeCases = mergeUnique(asArray(options.case));
+  if (scopeCases.length > 0) {
+    rules["scope-case"] = [severity, "always", scopeCases];
+  }
+  return rules;
+}
+function buildSubjectRules(options) {
+  if (!options) {
+    return {};
+  }
+  const rules = {};
+  const forbiddenCases = mergeUnique(asArray(options.forbidden));
+  if (forbiddenCases.length > 0) {
+    rules["subject-case"] = [
+      _nullishCoalesce(options.caseSeverity, () => ( _types.RuleConfigSeverity.Error)),
+      _nullishCoalesce(options.caseCondition, () => ( "never")),
+      forbiddenCases
+    ];
+  }
+  if (options.allowEmpty !== void 0) {
+    if (options.allowEmpty) {
+      rules["subject-empty"] = [_types.RuleConfigSeverity.Disabled];
+    } else {
+      rules["subject-empty"] = [
+        _nullishCoalesce(options.allowEmptySeverity, () => ( _types.RuleConfigSeverity.Error)),
+        "never"
+      ];
     }
-    if (Array.isArray(value) && Array.isArray(object[key])) {
-      object[key] = [...value, ...object[key]];
-    } else if (isPlainObject(value) && isPlainObject(object[key])) {
-      object[key] = _defu(
-        value,
-        object[key],
-        (namespace ? `${namespace}.` : "") + key.toString(),
-        merger
-      );
+  }
+  if (options.fullStop !== void 0) {
+    if (options.fullStop) {
+      rules["subject-full-stop"] = [
+        _nullishCoalesce(options.fullStopSeverity, () => ( _types.RuleConfigSeverity.Error)),
+        "always",
+        _nullishCoalesce(options.fullStopCharacter, () => ( "."))
+      ];
     } else {
-      object[key] = value;
+      rules["subject-full-stop"] = [_types.RuleConfigSeverity.Disabled];
     }
   }
-  return object;
+  return rules;
 }
-function createDefu(merger) {
-  return (...arguments_) => (
-    // eslint-disable-next-line unicorn/no-array-reduce
-    arguments_.reduce((p, c) => _defu(p, c, "", merger), {})
-  );
+function buildHeaderRules(options) {
+  if (!options) {
+    return {};
+  }
+  const rules = {};
+  const severity = _nullishCoalesce(options.severity, () => ( _types.RuleConfigSeverity.Error));
+  const condition = _nullishCoalesce(options.condition, () => ( "always"));
+  if (options.maxLength !== void 0) {
+    rules["header-max-length"] = [severity, condition, options.maxLength];
+  }
+  return rules;
 }
-var defu = createDefu();
-var defuFn = createDefu((object, key, currentValue) => {
-  if (object[key] !== void 0 && typeof currentValue === "function") {
-    object[key] = currentValue(object[key]);
-    return true;
-  }
-});
-var defuArrayFn = createDefu((object, key, currentValue) => {
-  if (Array.isArray(object[key]) && typeof currentValue === "function") {
-    object[key] = currentValue(object[key]);
-    return true;
-  }
-});
-
-// src/index.ts
-function icebreaker(config) {
-  return defu(config, {
-    extends: ["@commitlint/config-conventional"]
-  });
+function mergePrompts(base, override) {
+  if (!base && !override) {
+    return void 0;
+  }
+  if (!base) {
+    return override;
+  }
+  if (!override) {
+    return base;
+  }
+  return {
+    ...base,
+    ...override,
+    questions: {
+      ..._nullishCoalesce(base.questions, () => ( {})),
+      ..._nullishCoalesce(override.questions, () => ( {}))
+    }
+  };
+}
+function createIcebreakerCommitlintConfig(options = {}) {
+  const { types, scopes, subject, header } = options;
+  const extendsList = mergeUnique([
+    ...DEFAULT_EXTENDS,
+    ...mergeUnique(_nullishCoalesce(options.extends, () => ( [])))
+  ]);
+  const rules = {
+    ...buildScopeRules(scopes),
+    ...buildSubjectRules(subject),
+    ...buildHeaderRules(header)
+  };
+  const typesConfig = buildTypesConfig(types);
+  if (typesConfig.rule) {
+    rules["type-enum"] = typesConfig.rule;
+  }
+  const mergedRules = {
+    ...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 } : {},
+    ...prompt ? { prompt } : {}
+  };
 }
 
 
 
-
-
-exports.RuleConfigCondition = _types.RuleConfigCondition; exports.RuleConfigSeverity = _types.RuleConfigSeverity; exports.TargetCaseType = _types.TargetCaseType; exports.icebreaker = icebreaker;
+exports.RuleConfigSeverity = _types.RuleConfigSeverity; exports.createIcebreakerCommitlintConfig = createIcebreakerCommitlintConfig;

package/dist/index.d.cts

@@ -1,6 +1,48 @@
-import { UserConfig } from '@commitlint/types';
-export { RuleConfigCondition, RuleConfigSeverity, TargetCaseType, UserConfig } from '@commitlint/types';
+import { RuleConfigCondition, RuleConfigSeverity, TargetCaseType, RulesConfig, UserPromptConfig, UserConfig } from '@commitlint/types';
+export { UserConfig as CommitlintUserConfig, RuleConfigSeverity } from '@commitlint/types';
 
-declare function icebreaker(config?: UserConfig): UserConfig;
+interface CommitTypeDefinition {
+    value: string;
+    title?: string;
+    description?: string;
+    emoji?: string;
+}
+interface CommitTypesOptions {
+    add?: string[];
+    definitions?: CommitTypeDefinition[];
+    condition?: RuleConfigCondition;
+    severity?: RuleConfigSeverity;
+}
+interface CommitScopeOptions {
+    values?: string[];
+    required?: boolean;
+    case?: TargetCaseType | TargetCaseType[];
+    severity?: RuleConfigSeverity;
+}
+interface CommitSubjectOptions {
+    forbidden?: TargetCaseType | TargetCaseType[];
+    caseCondition?: RuleConfigCondition;
+    caseSeverity?: RuleConfigSeverity;
+    allowEmpty?: boolean;
+    allowEmptySeverity?: RuleConfigSeverity;
+    fullStop?: boolean;
+    fullStopSeverity?: RuleConfigSeverity;
+    fullStopCharacter?: string;
+}
+interface CommitHeaderOptions {
+    maxLength?: number;
+    condition?: RuleConfigCondition;
+    severity?: RuleConfigSeverity;
+}
+interface IcebreakerCommitlintOptions {
+    extends?: string[];
+    rules?: Partial<RulesConfig>;
+    types?: CommitTypesOptions;
+    scopes?: CommitScopeOptions;
+    subject?: CommitSubjectOptions;
+    header?: CommitHeaderOptions;
+    prompt?: UserPromptConfig;
+}
+declare function createIcebreakerCommitlintConfig(options?: IcebreakerCommitlintOptions): UserConfig;
 
-export { icebreaker };
+export { type CommitHeaderOptions, type CommitScopeOptions, type CommitSubjectOptions, type CommitTypeDefinition, type CommitTypesOptions, type IcebreakerCommitlintOptions, createIcebreakerCommitlintConfig };

package/dist/index.d.ts

@@ -1,6 +1,48 @@
-import { UserConfig } from '@commitlint/types';
-export { RuleConfigCondition, RuleConfigSeverity, TargetCaseType, UserConfig } from '@commitlint/types';
+import { RuleConfigCondition, RuleConfigSeverity, TargetCaseType, RulesConfig, UserPromptConfig, UserConfig } from '@commitlint/types';
+export { UserConfig as CommitlintUserConfig, RuleConfigSeverity } from '@commitlint/types';
 
-declare function icebreaker(config?: UserConfig): UserConfig;
+interface CommitTypeDefinition {
+    value: string;
+    title?: string;
+    description?: string;
+    emoji?: string;
+}
+interface CommitTypesOptions {
+    add?: string[];
+    definitions?: CommitTypeDefinition[];
+    condition?: RuleConfigCondition;
+    severity?: RuleConfigSeverity;
+}
+interface CommitScopeOptions {
+    values?: string[];
+    required?: boolean;
+    case?: TargetCaseType | TargetCaseType[];
+    severity?: RuleConfigSeverity;
+}
+interface CommitSubjectOptions {
+    forbidden?: TargetCaseType | TargetCaseType[];
+    caseCondition?: RuleConfigCondition;
+    caseSeverity?: RuleConfigSeverity;
+    allowEmpty?: boolean;
+    allowEmptySeverity?: RuleConfigSeverity;
+    fullStop?: boolean;
+    fullStopSeverity?: RuleConfigSeverity;
+    fullStopCharacter?: string;
+}
+interface CommitHeaderOptions {
+    maxLength?: number;
+    condition?: RuleConfigCondition;
+    severity?: RuleConfigSeverity;
+}
+interface IcebreakerCommitlintOptions {
+    extends?: string[];
+    rules?: Partial<RulesConfig>;
+    types?: CommitTypesOptions;
+    scopes?: CommitScopeOptions;
+    subject?: CommitSubjectOptions;
+    header?: CommitHeaderOptions;
+    prompt?: UserPromptConfig;
+}
+declare function createIcebreakerCommitlintConfig(options?: IcebreakerCommitlintOptions): UserConfig;
 
-export { icebreaker };
+export { type CommitHeaderOptions, type CommitScopeOptions, type CommitSubjectOptions, type CommitTypeDefinition, type CommitTypesOptions, type IcebreakerCommitlintOptions, createIcebreakerCommitlintConfig };

package/dist/index.mjs

@@ -1,87 +1,211 @@
 // src/index.ts
-import {
-  RuleConfigCondition,
-  RuleConfigSeverity,
-  TargetCaseType
-} from "@commitlint/types";
-
-// ../../node_modules/.pnpm/defu@6.1.4/node_modules/defu/dist/defu.mjs
-function isPlainObject(value) {
-  if (value === null || typeof value !== "object") {
-    return false;
-  }
-  const prototype = Object.getPrototypeOf(value);
-  if (prototype !== null && prototype !== Object.prototype && Object.getPrototypeOf(prototype) !== null) {
-    return false;
+import conventionalConfig from "@commitlint/config-conventional";
+import { RuleConfigSeverity } from "@commitlint/types";
+var DEFAULT_EXTENDS = ["@commitlint/config-conventional"];
+var DEFAULT_PARSER_PRESET = "conventional-changelog-conventionalcommits";
+function asArray(value) {
+  if (value === void 0) {
+    return [];
   }
-  if (Symbol.iterator in value) {
-    return false;
+  return Array.isArray(value) ? value : [value];
+}
+function mergeUnique(values) {
+  const seen = /* @__PURE__ */ new Set();
+  const result = [];
+  for (const value of values) {
+    if (value === void 0 || value === null) {
+      continue;
+    }
+    if (!seen.has(value)) {
+      seen.add(value);
+      result.push(value);
+    }
   }
-  if (Symbol.toStringTag in value) {
-    return Object.prototype.toString.call(value) === "[object Module]";
+  return result;
+}
+function resolveBaseTypeRule() {
+  const rule = conventionalConfig.rules?.["type-enum"];
+  if (Array.isArray(rule)) {
+    const severity = rule[0] ?? RuleConfigSeverity.Error;
+    const condition = rule[1] ?? "always";
+    const values = rule[2] ?? [];
+    return {
+      severity,
+      condition,
+      values: [...values]
+    };
   }
-  return true;
+  return {
+    severity: RuleConfigSeverity.Error,
+    condition: "always",
+    values: []
+  };
 }
-function _defu(baseObject, defaults, namespace = ".", merger) {
-  if (!isPlainObject(defaults)) {
-    return _defu(baseObject, {}, namespace, merger);
+function buildTypesConfig(options) {
+  if (!options) {
+    return {};
   }
-  const object = Object.assign({}, defaults);
-  for (const key in baseObject) {
-    if (key === "__proto__" || key === "constructor") {
-      continue;
+  const baseRule = resolveBaseTypeRule();
+  const additional = mergeUnique([
+    ...baseRule.values,
+    ...mergeUnique(options.add ?? []),
+    ...mergeUnique((options.definitions ?? []).map((definition) => definition.value))
+  ]);
+  let rule;
+  if (additional.length > 0) {
+    rule = [
+      options.severity ?? baseRule.severity,
+      options.condition ?? baseRule.condition,
+      additional
+    ];
+  }
+  if (!options.definitions?.length) {
+    return { rule };
+  }
+  const basePromptType = conventionalConfig.prompt?.questions?.type;
+  const mergedEnum = {
+    ...basePromptType?.enum ?? {}
+  };
+  for (const definition of options.definitions) {
+    const { value, title, description, emoji } = definition;
+    mergedEnum[value] = {
+      ...mergedEnum[value] ?? {},
+      title,
+      description,
+      emoji
+    };
+  }
+  const prompt = {
+    ...conventionalConfig.prompt ?? {},
+    questions: {
+      ...conventionalConfig.prompt?.questions ?? {},
+      type: {
+        ...basePromptType ?? {},
+        enum: mergedEnum
+      }
     }
-    const value = baseObject[key];
-    if (value === null || value === void 0) {
-      continue;
+  };
+  return { rule, prompt };
+}
+function buildScopeRules(options) {
+  if (!options) {
+    return {};
+  }
+  const rules = {};
+  const severity = options.severity ?? RuleConfigSeverity.Error;
+  const scopeValues = mergeUnique(asArray(options.values));
+  if (scopeValues.length > 0) {
+    rules["scope-enum"] = [severity, "always", scopeValues];
+  }
+  if (options.required !== void 0) {
+    if (options.required) {
+      rules["scope-empty"] = [severity, "never"];
+    } else {
+      rules["scope-empty"] = [RuleConfigSeverity.Disabled];
     }
-    if (merger && merger(object, key, value, namespace)) {
-      continue;
+  }
+  const scopeCases = mergeUnique(asArray(options.case));
+  if (scopeCases.length > 0) {
+    rules["scope-case"] = [severity, "always", scopeCases];
+  }
+  return rules;
+}
+function buildSubjectRules(options) {
+  if (!options) {
+    return {};
+  }
+  const rules = {};
+  const forbiddenCases = mergeUnique(asArray(options.forbidden));
+  if (forbiddenCases.length > 0) {
+    rules["subject-case"] = [
+      options.caseSeverity ?? RuleConfigSeverity.Error,
+      options.caseCondition ?? "never",
+      forbiddenCases
+    ];
+  }
+  if (options.allowEmpty !== void 0) {
+    if (options.allowEmpty) {
+      rules["subject-empty"] = [RuleConfigSeverity.Disabled];
+    } else {
+      rules["subject-empty"] = [
+        options.allowEmptySeverity ?? RuleConfigSeverity.Error,
+        "never"
+      ];
     }
-    if (Array.isArray(value) && Array.isArray(object[key])) {
-      object[key] = [...value, ...object[key]];
-    } else if (isPlainObject(value) && isPlainObject(object[key])) {
-      object[key] = _defu(
-        value,
-        object[key],
-        (namespace ? `${namespace}.` : "") + key.toString(),
-        merger
-      );
+  }
+  if (options.fullStop !== void 0) {
+    if (options.fullStop) {
+      rules["subject-full-stop"] = [
+        options.fullStopSeverity ?? RuleConfigSeverity.Error,
+        "always",
+        options.fullStopCharacter ?? "."
+      ];
     } else {
-      object[key] = value;
+      rules["subject-full-stop"] = [RuleConfigSeverity.Disabled];
     }
   }
-  return object;
+  return rules;
+}
+function buildHeaderRules(options) {
+  if (!options) {
+    return {};
+  }
+  const rules = {};
+  const severity = options.severity ?? RuleConfigSeverity.Error;
+  const condition = options.condition ?? "always";
+  if (options.maxLength !== void 0) {
+    rules["header-max-length"] = [severity, condition, options.maxLength];
+  }
+  return rules;
 }
-function createDefu(merger) {
-  return (...arguments_) => (
-    // eslint-disable-next-line unicorn/no-array-reduce
-    arguments_.reduce((p, c) => _defu(p, c, "", merger), {})
-  );
+function mergePrompts(base, override) {
+  if (!base && !override) {
+    return void 0;
+  }
+  if (!base) {
+    return override;
+  }
+  if (!override) {
+    return base;
+  }
+  return {
+    ...base,
+    ...override,
+    questions: {
+      ...base.questions ?? {},
+      ...override.questions ?? {}
+    }
+  };
 }
-var defu = createDefu();
-var defuFn = createDefu((object, key, currentValue) => {
-  if (object[key] !== void 0 && typeof currentValue === "function") {
-    object[key] = currentValue(object[key]);
-    return true;
-  }
-});
-var defuArrayFn = createDefu((object, key, currentValue) => {
-  if (Array.isArray(object[key]) && typeof currentValue === "function") {
-    object[key] = currentValue(object[key]);
-    return true;
-  }
-});
-
-// src/index.ts
-function icebreaker(config) {
-  return defu(config, {
-    extends: ["@commitlint/config-conventional"]
-  });
+function createIcebreakerCommitlintConfig(options = {}) {
+  const { types, scopes, subject, header } = options;
+  const extendsList = mergeUnique([
+    ...DEFAULT_EXTENDS,
+    ...mergeUnique(options.extends ?? [])
+  ]);
+  const rules = {
+    ...buildScopeRules(scopes),
+    ...buildSubjectRules(subject),
+    ...buildHeaderRules(header)
+  };
+  const typesConfig = buildTypesConfig(types);
+  if (typesConfig.rule) {
+    rules["type-enum"] = typesConfig.rule;
+  }
+  const mergedRules = {
+    ...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 } : {},
+    ...prompt ? { prompt } : {}
+  };
 }
 export {
-  RuleConfigCondition,
   RuleConfigSeverity,
-  TargetCaseType,
-  icebreaker
+  createIcebreakerCommitlintConfig
 };

package/package.json

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