@icebreakers/commitlint-config 1.0.4 → 1.1.0

package/dist/index.cjs

@@ -1,87 +1,392 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/index.ts
-
-
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); 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/config.ts
 
 
 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;
+// src/constants.ts
+var DEFAULT_PARSER_PRESET = "conventional-changelog-conventionalcommits";
+var DEFAULT_HEADER_MAX_LENGTH = 100;
+var DEFAULT_BODY_MAX_LINE_LENGTH = 100;
+var DEFAULT_FOOTER_MAX_LINE_LENGTH = 100;
+var DEFAULT_FULL_STOP = ".";
+var DEFAULT_SUBJECT_FORBIDDEN_CASES = [
+  "sentence-case",
+  "start-case",
+  "pascal-case",
+  "upper-case"
+];
+var DEFAULT_COMMIT_TYPES = [
+  {
+    value: "build",
+    title: "Builds",
+    description: "Changes that affect the build system or external dependencies (example scopes: pnpm, webpack, docker)",
+    emoji: "\u{1F6E0}"
+  },
+  {
+    value: "chore",
+    title: "Chores",
+    description: "Other changes that don't modify src or test files",
+    emoji: "\u267B\uFE0F"
+  },
+  {
+    value: "ci",
+    title: "Continuous Integrations",
+    description: "Changes to our CI configuration files and scripts (example scopes: GitHub Actions, Travis, Circle)",
+    emoji: "\u2699\uFE0F"
+  },
+  {
+    value: "docs",
+    title: "Documentation",
+    description: "Documentation only changes",
+    emoji: "\u{1F4DA}"
+  },
+  {
+    value: "feat",
+    title: "Features",
+    description: "A new feature",
+    emoji: "\u2728"
+  },
+  {
+    value: "fix",
+    title: "Bug Fixes",
+    description: "A bug fix",
+    emoji: "\u{1F41B}"
+  },
+  {
+    value: "perf",
+    title: "Performance Improvements",
+    description: "A code change that improves performance",
+    emoji: "\u{1F680}"
+  },
+  {
+    value: "refactor",
+    title: "Code Refactoring",
+    description: "A code change that neither fixes a bug nor adds a feature",
+    emoji: "\u{1F4E6}"
+  },
+  {
+    value: "revert",
+    title: "Reverts",
+    description: "Reverts a previous commit",
+    emoji: "\u{1F5D1}"
+  },
+  {
+    value: "style",
+    title: "Styles",
+    description: "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)",
+    emoji: "\u{1F48E}"
+  },
+  {
+    value: "test",
+    title: "Tests",
+    description: "Adding missing tests or correcting existing tests",
+    emoji: "\u{1F6A8}"
   }
-  const prototype = Object.getPrototypeOf(value);
-  if (prototype !== null && prototype !== Object.prototype && Object.getPrototypeOf(prototype) !== null) {
-    return false;
+];
+var DEFAULT_TYPES = DEFAULT_COMMIT_TYPES.map((type) => type.value);
+var DEFAULT_PROMPT_SCOPE_DESCRIPTION = "What is the scope of this change (e.g. component or file name)";
+var DEFAULT_PROMPT_TYPE_DESCRIPTION = "Select the type of change that you're committing";
+var DEFAULT_PROMPT_SUBJECT_DESCRIPTION = "Write a short, imperative tense description of the change";
+var DEFAULT_PROMPT_BODY_DESCRIPTION = "Provide a longer description of the change";
+var DEFAULT_PROMPT_IS_BREAKING_DESCRIPTION = "Are there any breaking changes?";
+var DEFAULT_PROMPT_BREAKING_BODY_DESCRIPTION = "A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself";
+var DEFAULT_PROMPT_BREAKING_DESCRIPTION = "Describe the breaking changes";
+var DEFAULT_PROMPT_IS_ISSUE_AFFECTED_DESCRIPTION = "Does this change affect any open issues?";
+var DEFAULT_PROMPT_ISSUES_BODY_DESCRIPTION = "If issues are closed, the commit requires a body. Please enter a longer description of the commit itself";
+var DEFAULT_PROMPT_ISSUES_DESCRIPTION = 'Add issue references (e.g. "fix #123", "re #123".)';
+var DEFAULT_EXTENDS = ["@commitlint/config-conventional"];
+
+// src/utils.ts
+function toArray(value) {
+  if (value === void 0) {
+    return [];
+  }
+  return Array.isArray(value) ? value : [value];
+}
+function unique(values) {
+  const seen = /* @__PURE__ */ new Set();
+  const result = [];
+  for (const value of values) {
+    if (!seen.has(value)) {
+      seen.add(value);
+      result.push(value);
+    }
   }
-  if (Symbol.iterator in value) {
-    return false;
+  return result;
+}
+function toTitleCase(value) {
+  return value.split(/[-_/]/g).filter(Boolean).map((segment) => segment.charAt(0).toUpperCase() + segment.slice(1)).join(" ");
+}
+function createDefaultCommitTypeDefinition(value) {
+  return {
+    value,
+    title: toTitleCase(value),
+    description: "Custom change type"
+  };
+}
+function mergeTypeDefinitions(defaults, overrides = []) {
+  const map = /* @__PURE__ */ new Map();
+  for (const definition of defaults) {
+    map.set(definition.value, definition);
   }
-  if (Symbol.toStringTag in value) {
-    return Object.prototype.toString.call(value) === "[object Module]";
+  for (const definition of overrides) {
+    map.set(definition.value, definition);
   }
-  return true;
+  return map;
+}
+function isPlainObject(value) {
+  return Boolean(
+    value && typeof value === "object" && !Array.isArray(value) && Object.prototype.toString.call(value) === "[object Object]"
+  );
 }
-function _defu(baseObject, defaults, namespace = ".", merger) {
-  if (!isPlainObject(defaults)) {
-    return _defu(baseObject, {}, namespace, merger);
+function mergeDeep(base, override) {
+  if (!override) {
+    return base;
   }
-  const object = Object.assign({}, defaults);
-  for (const key in baseObject) {
-    if (key === "__proto__" || key === "constructor") {
+  const output = { ...base };
+  for (const [key, value] of Object.entries(override)) {
+    if (value === void 0) {
       continue;
     }
-    const value = baseObject[key];
-    if (value === null || value === void 0) {
+    const baseValue = output[key];
+    if (isPlainObject(baseValue) && isPlainObject(value)) {
+      output[key] = mergeDeep(baseValue, value);
       continue;
     }
-    if (merger && merger(object, key, value, namespace)) {
+    if (Array.isArray(value)) {
+      output[key] = [...value];
       continue;
     }
-    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
-      );
-    } else {
-      object[key] = value;
-    }
+    output[key] = value;
+  }
+  return output;
+}
+function removeUndefined(value) {
+  const entries = Object.entries(value).filter(([, item]) => item !== void 0);
+  return Object.fromEntries(entries);
+}
+
+// src/config.ts
+function resolveExtends(entries) {
+  if (!entries) {
+    return [...DEFAULT_EXTENDS];
   }
-  return object;
+  const values = toArray(entries);
+  return unique([...DEFAULT_EXTENDS, ...values]);
 }
-function createDefu(merger) {
-  return (...arguments_) => (
-    // eslint-disable-next-line unicorn/no-array-reduce
-    arguments_.reduce((p, c) => _defu(p, c, "", merger), {})
+function resolveTypeSettings(options) {
+  let severity = _types.RuleConfigSeverity.Error;
+  let condition = "always";
+  let overrides = [];
+  let values;
+  if (!options) {
+    values = [...DEFAULT_TYPES];
+  } else if (Array.isArray(options)) {
+    values = unique(options);
+  } else {
+    severity = _nullishCoalesce(options.severity, () => ( severity));
+    condition = _nullishCoalesce(options.condition, () => ( condition));
+    overrides = _nullishCoalesce(options.definitions, () => ( []));
+    const base = options.values ? toArray(options.values) : DEFAULT_TYPES;
+    const additions = options.add ? toArray(options.add) : [];
+    values = unique([...base, ...additions]);
+  }
+  if (values.length === 0) {
+    return {
+      definitions: [],
+      rule: [_types.RuleConfigSeverity.Disabled]
+    };
+  }
+  const definitionsMap = mergeTypeDefinitions(DEFAULT_COMMIT_TYPES, overrides);
+  const definitions = values.map(
+    (value) => _nullishCoalesce(definitionsMap.get(value), () => ( createDefaultCommitTypeDefinition(value)))
   );
+  return {
+    definitions,
+    rule: [severity, condition, values]
+  };
+}
+function asCaseArray(value) {
+  if (!value) {
+    return [];
+  }
+  return toArray(value);
 }
-var defu = createDefu();
-var defuFn = createDefu((object, key, currentValue) => {
-  if (object[key] !== void 0 && typeof currentValue === "function") {
-    object[key] = currentValue(object[key]);
-    return true;
+function resolveScopeRules(options) {
+  if (!options) {
+    return {};
+  }
+  const rules = {};
+  const values = Array.isArray(options) ? unique(options) : unique([
+    ...toArray(_nullishCoalesce(options.values, () => ( []))),
+    ...toArray(_nullishCoalesce(options.add, () => ( [])))
+  ]);
+  const baseSeverity = !Array.isArray(options) ? _nullishCoalesce(options.severity, () => ( _types.RuleConfigSeverity.Error)) : _types.RuleConfigSeverity.Error;
+  if (values.length > 0) {
+    rules["scope-enum"] = [baseSeverity, "always", values];
   }
-});
-var defuArrayFn = createDefu((object, key, currentValue) => {
-  if (Array.isArray(object[key]) && typeof currentValue === "function") {
-    object[key] = currentValue(object[key]);
-    return true;
+  const allowEmpty = Array.isArray(options) ? true : _nullishCoalesce(options.allowEmpty, () => ( !options.required));
+  if (allowEmpty) {
+    rules["scope-empty"] = [_types.RuleConfigSeverity.Disabled];
+  } else {
+    rules["scope-empty"] = [baseSeverity, "never"];
   }
-});
+  if (!Array.isArray(options) && options.case) {
+    const scopeCaseValues = asCaseArray(options.case);
+    if (scopeCaseValues.length > 0) {
+      const caseSeverity = _nullishCoalesce(options.caseSeverity, () => ( baseSeverity));
+      rules["scope-case"] = [caseSeverity, "always", scopeCaseValues];
+    }
+  }
+  return rules;
+}
+function resolveSubjectRules(options) {
+  const rules = {};
+  const forbiddenCases = asCaseArray(_optionalChain([options, 'optionalAccess', _ => _.forbidden]));
+  const subjectCases = forbiddenCases.length > 0 ? forbiddenCases : DEFAULT_SUBJECT_FORBIDDEN_CASES;
+  const caseSeverity = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _2 => _2.caseSeverity]), () => ( _types.RuleConfigSeverity.Error));
+  rules["subject-case"] = [caseSeverity, "never", subjectCases];
+  if (_optionalChain([options, 'optionalAccess', _3 => _3.allowEmpty])) {
+    rules["subject-empty"] = [_types.RuleConfigSeverity.Disabled];
+  } else {
+    const emptySeverity = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _4 => _4.emptySeverity]), () => ( _types.RuleConfigSeverity.Error));
+    rules["subject-empty"] = [emptySeverity, "never"];
+  }
+  if (_optionalChain([options, 'optionalAccess', _5 => _5.fullStop]) === false) {
+    rules["subject-full-stop"] = [_types.RuleConfigSeverity.Disabled];
+  } else {
+    const fullStopSeverity = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _6 => _6.fullStopSeverity]), () => ( _types.RuleConfigSeverity.Error));
+    const fullStop = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _7 => _7.fullStop]), () => ( DEFAULT_FULL_STOP));
+    rules["subject-full-stop"] = [fullStopSeverity, "never", fullStop];
+  }
+  return rules;
+}
+function resolveHeaderRules(options) {
+  const severity = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _8 => _8.severity]), () => ( _types.RuleConfigSeverity.Error));
+  const maxLength = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _9 => _9.maxLength]), () => ( DEFAULT_HEADER_MAX_LENGTH));
+  return {
+    "header-max-length": [severity, "always", maxLength]
+  };
+}
+function createBaseRules() {
+  return {
+    "body-leading-blank": [_types.RuleConfigSeverity.Warning, "always"],
+    "body-max-line-length": [
+      _types.RuleConfigSeverity.Error,
+      "always",
+      DEFAULT_BODY_MAX_LINE_LENGTH
+    ],
+    "footer-leading-blank": [_types.RuleConfigSeverity.Warning, "always"],
+    "footer-max-line-length": [
+      _types.RuleConfigSeverity.Error,
+      "always",
+      DEFAULT_FOOTER_MAX_LINE_LENGTH
+    ],
+    "header-trim": [_types.RuleConfigSeverity.Error, "always"],
+    "type-case": [_types.RuleConfigSeverity.Error, "always", "lower-case"],
+    "type-empty": [_types.RuleConfigSeverity.Error, "never"]
+  };
+}
+function buildTypeEnum(definitions) {
+  return definitions.reduce(
+    (accumulator, definition) => {
+      accumulator[definition.value] = {
+        description: definition.description,
+        title: definition.title,
+        emoji: definition.emoji
+      };
+      return accumulator;
+    },
+    {}
+  );
+}
+function createBasePrompt(definitions) {
+  return {
+    questions: {
+      type: {
+        description: DEFAULT_PROMPT_TYPE_DESCRIPTION,
+        enum: buildTypeEnum(definitions)
+      },
+      scope: {
+        description: DEFAULT_PROMPT_SCOPE_DESCRIPTION
+      },
+      subject: {
+        description: DEFAULT_PROMPT_SUBJECT_DESCRIPTION
+      },
+      body: {
+        description: DEFAULT_PROMPT_BODY_DESCRIPTION
+      },
+      isBreaking: {
+        description: DEFAULT_PROMPT_IS_BREAKING_DESCRIPTION
+      },
+      breakingBody: {
+        description: DEFAULT_PROMPT_BREAKING_BODY_DESCRIPTION
+      },
+      breaking: {
+        description: DEFAULT_PROMPT_BREAKING_DESCRIPTION
+      },
+      isIssueAffected: {
+        description: DEFAULT_PROMPT_IS_ISSUE_AFFECTED_DESCRIPTION
+      },
+      issuesBody: {
+        description: DEFAULT_PROMPT_ISSUES_BODY_DESCRIPTION
+      },
+      issues: {
+        description: DEFAULT_PROMPT_ISSUES_DESCRIPTION
+      }
+    }
+  };
+}
+function resolvePrompt(definitions, overrides) {
+  const base = createBasePrompt(definitions);
+  return mergeDeep(base, overrides);
+}
+function createIcebreakerCommitlintConfig(options = {}) {
+  const extendsField = resolveExtends(options.extends);
+  const typeSettings = resolveTypeSettings(options.types);
+  const scopeRules = resolveScopeRules(options.scopes);
+  const subjectRules = resolveSubjectRules(options.subject);
+  const headerRules = resolveHeaderRules(options.header);
+  const baseRules = createBaseRules();
+  const rules = {
+    ...baseRules,
+    "type-enum": typeSettings.rule,
+    ...scopeRules,
+    ...subjectRules,
+    ...headerRules,
+    ...options.rules
+  };
+  const prompt = resolvePrompt(typeSettings.definitions, options.prompt);
+  return removeUndefined({
+    extends: extendsField,
+    formatter: options.formatter,
+    parserPreset: _nullishCoalesce(options.parserPreset, () => ( DEFAULT_PARSER_PRESET)),
+    rules,
+    ignores: options.ignores,
+    defaultIgnores: options.defaultIgnores,
+    plugins: options.plugins,
+    helpUrl: options.helpUrl,
+    prompt
+  });
+}
 
 // src/index.ts
-function icebreaker(config) {
-  return defu(config, {
-    extends: ["@commitlint/config-conventional"]
-  });
+
+function createCommitlintConfig(options) {
+  return createIcebreakerCommitlintConfig(options);
+}
+function icebreaker(options) {
+  return createIcebreakerCommitlintConfig(options);
 }
 
 
 
 
 
-exports.RuleConfigCondition = _types.RuleConfigCondition; exports.RuleConfigSeverity = _types.RuleConfigSeverity; exports.TargetCaseType = _types.TargetCaseType; exports.icebreaker = icebreaker;
+
+
+
+
+
+
+exports.DEFAULT_COMMIT_TYPES = DEFAULT_COMMIT_TYPES; exports.DEFAULT_EXTENDS = DEFAULT_EXTENDS; exports.DEFAULT_SUBJECT_FORBIDDEN_CASES = DEFAULT_SUBJECT_FORBIDDEN_CASES; exports.DEFAULT_TYPES = DEFAULT_TYPES; exports.RuleConfigCondition = _types.RuleConfigCondition; exports.RuleConfigSeverity = _types.RuleConfigSeverity; exports.TargetCaseType = _types.TargetCaseType; exports.createCommitlintConfig = createCommitlintConfig; exports.createIcebreakerCommitlintConfig = createIcebreakerCommitlintConfig; exports.icebreaker = icebreaker;

package/dist/index.d.cts

@@ -1,6 +1,82 @@
-import { UserConfig } from '@commitlint/types';
-export { RuleConfigCondition, RuleConfigSeverity, TargetCaseType, UserConfig } from '@commitlint/types';
+import { RuleConfigSeverity, RuleConfigCondition, TargetCaseType, UserConfig, UserPromptConfig } from '@commitlint/types';
+export { RuleConfigCondition, RuleConfigSeverity, TargetCaseType } from '@commitlint/types';
 
-declare function icebreaker(config?: UserConfig): UserConfig;
+interface CommitTypeDefinition {
+    value: string;
+    title: string;
+    description: string;
+    emoji?: string;
+}
+interface TypeRuleOptions {
+    /**
+     * Replace the default set of commit types.
+     */
+    values?: string | string[];
+    /**
+     * Extend the existing commit types without replacing them.
+     */
+    add?: string | string[];
+    /**
+     * Provide metadata for commit types, primarily used by the prompt.
+     */
+    definitions?: CommitTypeDefinition[];
+    severity?: RuleConfigSeverity;
+    condition?: RuleConfigCondition;
+}
+interface ScopeRuleOptions {
+    values?: string | string[];
+    add?: string | string[];
+    case?: TargetCaseType | TargetCaseType[];
+    /**
+     * Require scopes on every commit message. Equivalent to disallowing empty scopes.
+     */
+    required?: boolean;
+    /**
+     * Explicitly allow empty scopes. Takes precedence over `required` when set.
+     */
+    allowEmpty?: boolean;
+    severity?: RuleConfigSeverity;
+    caseSeverity?: RuleConfigSeverity;
+}
+interface SubjectRuleOptions {
+    forbidden?: TargetCaseType | TargetCaseType[];
+    caseSeverity?: RuleConfigSeverity;
+    /**
+     * Control the trailing character check. Set to `false` to disable the rule entirely.
+     */
+    fullStop?: string | false;
+    fullStopSeverity?: RuleConfigSeverity;
+    allowEmpty?: boolean;
+    emptySeverity?: RuleConfigSeverity;
+}
+interface HeaderRuleOptions {
+    maxLength?: number;
+    severity?: RuleConfigSeverity;
+}
+interface IcebreakerCommitlintOptions {
+    extends?: string | string[];
+    types?: TypeRuleOptions | string[];
+    scopes?: ScopeRuleOptions | string[];
+    subject?: SubjectRuleOptions;
+    header?: HeaderRuleOptions;
+    rules?: UserConfig['rules'];
+    parserPreset?: UserConfig['parserPreset'];
+    formatter?: UserConfig['formatter'];
+    ignores?: UserConfig['ignores'];
+    defaultIgnores?: UserConfig['defaultIgnores'];
+    plugins?: UserConfig['plugins'];
+    helpUrl?: UserConfig['helpUrl'];
+    prompt?: UserPromptConfig;
+}
 
-export { icebreaker };
+declare function createIcebreakerCommitlintConfig(options?: IcebreakerCommitlintOptions): UserConfig;
+
+declare const DEFAULT_SUBJECT_FORBIDDEN_CASES: TargetCaseType[];
+declare const DEFAULT_COMMIT_TYPES: CommitTypeDefinition[];
+declare const DEFAULT_TYPES: string[];
+declare const DEFAULT_EXTENDS: string[];
+
+declare function createCommitlintConfig(options?: IcebreakerCommitlintOptions): UserConfig;
+declare function icebreaker(options?: IcebreakerCommitlintOptions): UserConfig;
+
+export { type CommitTypeDefinition, DEFAULT_COMMIT_TYPES, DEFAULT_EXTENDS, DEFAULT_SUBJECT_FORBIDDEN_CASES, DEFAULT_TYPES, type HeaderRuleOptions, type IcebreakerCommitlintOptions, type ScopeRuleOptions, type SubjectRuleOptions, type TypeRuleOptions, createCommitlintConfig, createIcebreakerCommitlintConfig, icebreaker };

package/dist/index.d.ts

@@ -1,6 +1,82 @@
-import { UserConfig } from '@commitlint/types';
-export { RuleConfigCondition, RuleConfigSeverity, TargetCaseType, UserConfig } from '@commitlint/types';
+import { RuleConfigSeverity, RuleConfigCondition, TargetCaseType, UserConfig, UserPromptConfig } from '@commitlint/types';
+export { RuleConfigCondition, RuleConfigSeverity, TargetCaseType } from '@commitlint/types';
 
-declare function icebreaker(config?: UserConfig): UserConfig;
+interface CommitTypeDefinition {
+    value: string;
+    title: string;
+    description: string;
+    emoji?: string;
+}
+interface TypeRuleOptions {
+    /**
+     * Replace the default set of commit types.
+     */
+    values?: string | string[];
+    /**
+     * Extend the existing commit types without replacing them.
+     */
+    add?: string | string[];
+    /**
+     * Provide metadata for commit types, primarily used by the prompt.
+     */
+    definitions?: CommitTypeDefinition[];
+    severity?: RuleConfigSeverity;
+    condition?: RuleConfigCondition;
+}
+interface ScopeRuleOptions {
+    values?: string | string[];
+    add?: string | string[];
+    case?: TargetCaseType | TargetCaseType[];
+    /**
+     * Require scopes on every commit message. Equivalent to disallowing empty scopes.
+     */
+    required?: boolean;
+    /**
+     * Explicitly allow empty scopes. Takes precedence over `required` when set.
+     */
+    allowEmpty?: boolean;
+    severity?: RuleConfigSeverity;
+    caseSeverity?: RuleConfigSeverity;
+}
+interface SubjectRuleOptions {
+    forbidden?: TargetCaseType | TargetCaseType[];
+    caseSeverity?: RuleConfigSeverity;
+    /**
+     * Control the trailing character check. Set to `false` to disable the rule entirely.
+     */
+    fullStop?: string | false;
+    fullStopSeverity?: RuleConfigSeverity;
+    allowEmpty?: boolean;
+    emptySeverity?: RuleConfigSeverity;
+}
+interface HeaderRuleOptions {
+    maxLength?: number;
+    severity?: RuleConfigSeverity;
+}
+interface IcebreakerCommitlintOptions {
+    extends?: string | string[];
+    types?: TypeRuleOptions | string[];
+    scopes?: ScopeRuleOptions | string[];
+    subject?: SubjectRuleOptions;
+    header?: HeaderRuleOptions;
+    rules?: UserConfig['rules'];
+    parserPreset?: UserConfig['parserPreset'];
+    formatter?: UserConfig['formatter'];
+    ignores?: UserConfig['ignores'];
+    defaultIgnores?: UserConfig['defaultIgnores'];
+    plugins?: UserConfig['plugins'];
+    helpUrl?: UserConfig['helpUrl'];
+    prompt?: UserPromptConfig;
+}
 
-export { icebreaker };
+declare function createIcebreakerCommitlintConfig(options?: IcebreakerCommitlintOptions): UserConfig;
+
+declare const DEFAULT_SUBJECT_FORBIDDEN_CASES: TargetCaseType[];
+declare const DEFAULT_COMMIT_TYPES: CommitTypeDefinition[];
+declare const DEFAULT_TYPES: string[];
+declare const DEFAULT_EXTENDS: string[];
+
+declare function createCommitlintConfig(options?: IcebreakerCommitlintOptions): UserConfig;
+declare function icebreaker(options?: IcebreakerCommitlintOptions): UserConfig;
+
+export { type CommitTypeDefinition, DEFAULT_COMMIT_TYPES, DEFAULT_EXTENDS, DEFAULT_SUBJECT_FORBIDDEN_CASES, DEFAULT_TYPES, type HeaderRuleOptions, type IcebreakerCommitlintOptions, type ScopeRuleOptions, type SubjectRuleOptions, type TypeRuleOptions, createCommitlintConfig, createIcebreakerCommitlintConfig, icebreaker };

package/dist/index.mjs

@@ -1,87 +1,392 @@
-// src/index.ts
+// src/config.ts
 import {
-  RuleConfigCondition,
-  RuleConfigSeverity,
-  TargetCaseType
+  RuleConfigSeverity
 } 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;
+// src/constants.ts
+var DEFAULT_PARSER_PRESET = "conventional-changelog-conventionalcommits";
+var DEFAULT_HEADER_MAX_LENGTH = 100;
+var DEFAULT_BODY_MAX_LINE_LENGTH = 100;
+var DEFAULT_FOOTER_MAX_LINE_LENGTH = 100;
+var DEFAULT_FULL_STOP = ".";
+var DEFAULT_SUBJECT_FORBIDDEN_CASES = [
+  "sentence-case",
+  "start-case",
+  "pascal-case",
+  "upper-case"
+];
+var DEFAULT_COMMIT_TYPES = [
+  {
+    value: "build",
+    title: "Builds",
+    description: "Changes that affect the build system or external dependencies (example scopes: pnpm, webpack, docker)",
+    emoji: "\u{1F6E0}"
+  },
+  {
+    value: "chore",
+    title: "Chores",
+    description: "Other changes that don't modify src or test files",
+    emoji: "\u267B\uFE0F"
+  },
+  {
+    value: "ci",
+    title: "Continuous Integrations",
+    description: "Changes to our CI configuration files and scripts (example scopes: GitHub Actions, Travis, Circle)",
+    emoji: "\u2699\uFE0F"
+  },
+  {
+    value: "docs",
+    title: "Documentation",
+    description: "Documentation only changes",
+    emoji: "\u{1F4DA}"
+  },
+  {
+    value: "feat",
+    title: "Features",
+    description: "A new feature",
+    emoji: "\u2728"
+  },
+  {
+    value: "fix",
+    title: "Bug Fixes",
+    description: "A bug fix",
+    emoji: "\u{1F41B}"
+  },
+  {
+    value: "perf",
+    title: "Performance Improvements",
+    description: "A code change that improves performance",
+    emoji: "\u{1F680}"
+  },
+  {
+    value: "refactor",
+    title: "Code Refactoring",
+    description: "A code change that neither fixes a bug nor adds a feature",
+    emoji: "\u{1F4E6}"
+  },
+  {
+    value: "revert",
+    title: "Reverts",
+    description: "Reverts a previous commit",
+    emoji: "\u{1F5D1}"
+  },
+  {
+    value: "style",
+    title: "Styles",
+    description: "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)",
+    emoji: "\u{1F48E}"
+  },
+  {
+    value: "test",
+    title: "Tests",
+    description: "Adding missing tests or correcting existing tests",
+    emoji: "\u{1F6A8}"
+  }
+];
+var DEFAULT_TYPES = DEFAULT_COMMIT_TYPES.map((type) => type.value);
+var DEFAULT_PROMPT_SCOPE_DESCRIPTION = "What is the scope of this change (e.g. component or file name)";
+var DEFAULT_PROMPT_TYPE_DESCRIPTION = "Select the type of change that you're committing";
+var DEFAULT_PROMPT_SUBJECT_DESCRIPTION = "Write a short, imperative tense description of the change";
+var DEFAULT_PROMPT_BODY_DESCRIPTION = "Provide a longer description of the change";
+var DEFAULT_PROMPT_IS_BREAKING_DESCRIPTION = "Are there any breaking changes?";
+var DEFAULT_PROMPT_BREAKING_BODY_DESCRIPTION = "A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself";
+var DEFAULT_PROMPT_BREAKING_DESCRIPTION = "Describe the breaking changes";
+var DEFAULT_PROMPT_IS_ISSUE_AFFECTED_DESCRIPTION = "Does this change affect any open issues?";
+var DEFAULT_PROMPT_ISSUES_BODY_DESCRIPTION = "If issues are closed, the commit requires a body. Please enter a longer description of the commit itself";
+var DEFAULT_PROMPT_ISSUES_DESCRIPTION = 'Add issue references (e.g. "fix #123", "re #123".)';
+var DEFAULT_EXTENDS = ["@commitlint/config-conventional"];
+
+// src/utils.ts
+function toArray(value) {
+  if (value === void 0) {
+    return [];
   }
-  const prototype = Object.getPrototypeOf(value);
-  if (prototype !== null && prototype !== Object.prototype && Object.getPrototypeOf(prototype) !== null) {
-    return false;
+  return Array.isArray(value) ? value : [value];
+}
+function unique(values) {
+  const seen = /* @__PURE__ */ new Set();
+  const result = [];
+  for (const value of values) {
+    if (!seen.has(value)) {
+      seen.add(value);
+      result.push(value);
+    }
   }
-  if (Symbol.iterator in value) {
-    return false;
+  return result;
+}
+function toTitleCase(value) {
+  return value.split(/[-_/]/g).filter(Boolean).map((segment) => segment.charAt(0).toUpperCase() + segment.slice(1)).join(" ");
+}
+function createDefaultCommitTypeDefinition(value) {
+  return {
+    value,
+    title: toTitleCase(value),
+    description: "Custom change type"
+  };
+}
+function mergeTypeDefinitions(defaults, overrides = []) {
+  const map = /* @__PURE__ */ new Map();
+  for (const definition of defaults) {
+    map.set(definition.value, definition);
   }
-  if (Symbol.toStringTag in value) {
-    return Object.prototype.toString.call(value) === "[object Module]";
+  for (const definition of overrides) {
+    map.set(definition.value, definition);
   }
-  return true;
+  return map;
 }
-function _defu(baseObject, defaults, namespace = ".", merger) {
-  if (!isPlainObject(defaults)) {
-    return _defu(baseObject, {}, namespace, merger);
+function isPlainObject(value) {
+  return Boolean(
+    value && typeof value === "object" && !Array.isArray(value) && Object.prototype.toString.call(value) === "[object Object]"
+  );
+}
+function mergeDeep(base, override) {
+  if (!override) {
+    return base;
   }
-  const object = Object.assign({}, defaults);
-  for (const key in baseObject) {
-    if (key === "__proto__" || key === "constructor") {
+  const output = { ...base };
+  for (const [key, value] of Object.entries(override)) {
+    if (value === void 0) {
       continue;
     }
-    const value = baseObject[key];
-    if (value === null || value === void 0) {
+    const baseValue = output[key];
+    if (isPlainObject(baseValue) && isPlainObject(value)) {
+      output[key] = mergeDeep(baseValue, value);
       continue;
     }
-    if (merger && merger(object, key, value, namespace)) {
+    if (Array.isArray(value)) {
+      output[key] = [...value];
       continue;
     }
-    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
-      );
-    } else {
-      object[key] = value;
-    }
+    output[key] = value;
+  }
+  return output;
+}
+function removeUndefined(value) {
+  const entries = Object.entries(value).filter(([, item]) => item !== void 0);
+  return Object.fromEntries(entries);
+}
+
+// src/config.ts
+function resolveExtends(entries) {
+  if (!entries) {
+    return [...DEFAULT_EXTENDS];
   }
-  return object;
+  const values = toArray(entries);
+  return unique([...DEFAULT_EXTENDS, ...values]);
 }
-function createDefu(merger) {
-  return (...arguments_) => (
-    // eslint-disable-next-line unicorn/no-array-reduce
-    arguments_.reduce((p, c) => _defu(p, c, "", merger), {})
+function resolveTypeSettings(options) {
+  let severity = RuleConfigSeverity.Error;
+  let condition = "always";
+  let overrides = [];
+  let values;
+  if (!options) {
+    values = [...DEFAULT_TYPES];
+  } else if (Array.isArray(options)) {
+    values = unique(options);
+  } else {
+    severity = options.severity ?? severity;
+    condition = options.condition ?? condition;
+    overrides = options.definitions ?? [];
+    const base = options.values ? toArray(options.values) : DEFAULT_TYPES;
+    const additions = options.add ? toArray(options.add) : [];
+    values = unique([...base, ...additions]);
+  }
+  if (values.length === 0) {
+    return {
+      definitions: [],
+      rule: [RuleConfigSeverity.Disabled]
+    };
+  }
+  const definitionsMap = mergeTypeDefinitions(DEFAULT_COMMIT_TYPES, overrides);
+  const definitions = values.map(
+    (value) => definitionsMap.get(value) ?? createDefaultCommitTypeDefinition(value)
   );
+  return {
+    definitions,
+    rule: [severity, condition, values]
+  };
 }
-var defu = createDefu();
-var defuFn = createDefu((object, key, currentValue) => {
-  if (object[key] !== void 0 && typeof currentValue === "function") {
-    object[key] = currentValue(object[key]);
-    return true;
+function asCaseArray(value) {
+  if (!value) {
+    return [];
   }
-});
-var defuArrayFn = createDefu((object, key, currentValue) => {
-  if (Array.isArray(object[key]) && typeof currentValue === "function") {
-    object[key] = currentValue(object[key]);
-    return true;
+  return toArray(value);
+}
+function resolveScopeRules(options) {
+  if (!options) {
+    return {};
+  }
+  const rules = {};
+  const values = Array.isArray(options) ? unique(options) : unique([
+    ...toArray(options.values ?? []),
+    ...toArray(options.add ?? [])
+  ]);
+  const baseSeverity = !Array.isArray(options) ? options.severity ?? RuleConfigSeverity.Error : RuleConfigSeverity.Error;
+  if (values.length > 0) {
+    rules["scope-enum"] = [baseSeverity, "always", values];
+  }
+  const allowEmpty = Array.isArray(options) ? true : options.allowEmpty ?? !options.required;
+  if (allowEmpty) {
+    rules["scope-empty"] = [RuleConfigSeverity.Disabled];
+  } else {
+    rules["scope-empty"] = [baseSeverity, "never"];
+  }
+  if (!Array.isArray(options) && options.case) {
+    const scopeCaseValues = asCaseArray(options.case);
+    if (scopeCaseValues.length > 0) {
+      const caseSeverity = options.caseSeverity ?? baseSeverity;
+      rules["scope-case"] = [caseSeverity, "always", scopeCaseValues];
+    }
   }
-});
+  return rules;
+}
+function resolveSubjectRules(options) {
+  const rules = {};
+  const forbiddenCases = asCaseArray(options?.forbidden);
+  const subjectCases = forbiddenCases.length > 0 ? forbiddenCases : DEFAULT_SUBJECT_FORBIDDEN_CASES;
+  const caseSeverity = options?.caseSeverity ?? RuleConfigSeverity.Error;
+  rules["subject-case"] = [caseSeverity, "never", subjectCases];
+  if (options?.allowEmpty) {
+    rules["subject-empty"] = [RuleConfigSeverity.Disabled];
+  } else {
+    const emptySeverity = options?.emptySeverity ?? RuleConfigSeverity.Error;
+    rules["subject-empty"] = [emptySeverity, "never"];
+  }
+  if (options?.fullStop === false) {
+    rules["subject-full-stop"] = [RuleConfigSeverity.Disabled];
+  } else {
+    const fullStopSeverity = options?.fullStopSeverity ?? RuleConfigSeverity.Error;
+    const fullStop = options?.fullStop ?? DEFAULT_FULL_STOP;
+    rules["subject-full-stop"] = [fullStopSeverity, "never", fullStop];
+  }
+  return rules;
+}
+function resolveHeaderRules(options) {
+  const severity = options?.severity ?? RuleConfigSeverity.Error;
+  const maxLength = options?.maxLength ?? DEFAULT_HEADER_MAX_LENGTH;
+  return {
+    "header-max-length": [severity, "always", maxLength]
+  };
+}
+function createBaseRules() {
+  return {
+    "body-leading-blank": [RuleConfigSeverity.Warning, "always"],
+    "body-max-line-length": [
+      RuleConfigSeverity.Error,
+      "always",
+      DEFAULT_BODY_MAX_LINE_LENGTH
+    ],
+    "footer-leading-blank": [RuleConfigSeverity.Warning, "always"],
+    "footer-max-line-length": [
+      RuleConfigSeverity.Error,
+      "always",
+      DEFAULT_FOOTER_MAX_LINE_LENGTH
+    ],
+    "header-trim": [RuleConfigSeverity.Error, "always"],
+    "type-case": [RuleConfigSeverity.Error, "always", "lower-case"],
+    "type-empty": [RuleConfigSeverity.Error, "never"]
+  };
+}
+function buildTypeEnum(definitions) {
+  return definitions.reduce(
+    (accumulator, definition) => {
+      accumulator[definition.value] = {
+        description: definition.description,
+        title: definition.title,
+        emoji: definition.emoji
+      };
+      return accumulator;
+    },
+    {}
+  );
+}
+function createBasePrompt(definitions) {
+  return {
+    questions: {
+      type: {
+        description: DEFAULT_PROMPT_TYPE_DESCRIPTION,
+        enum: buildTypeEnum(definitions)
+      },
+      scope: {
+        description: DEFAULT_PROMPT_SCOPE_DESCRIPTION
+      },
+      subject: {
+        description: DEFAULT_PROMPT_SUBJECT_DESCRIPTION
+      },
+      body: {
+        description: DEFAULT_PROMPT_BODY_DESCRIPTION
+      },
+      isBreaking: {
+        description: DEFAULT_PROMPT_IS_BREAKING_DESCRIPTION
+      },
+      breakingBody: {
+        description: DEFAULT_PROMPT_BREAKING_BODY_DESCRIPTION
+      },
+      breaking: {
+        description: DEFAULT_PROMPT_BREAKING_DESCRIPTION
+      },
+      isIssueAffected: {
+        description: DEFAULT_PROMPT_IS_ISSUE_AFFECTED_DESCRIPTION
+      },
+      issuesBody: {
+        description: DEFAULT_PROMPT_ISSUES_BODY_DESCRIPTION
+      },
+      issues: {
+        description: DEFAULT_PROMPT_ISSUES_DESCRIPTION
+      }
+    }
+  };
+}
+function resolvePrompt(definitions, overrides) {
+  const base = createBasePrompt(definitions);
+  return mergeDeep(base, overrides);
+}
+function createIcebreakerCommitlintConfig(options = {}) {
+  const extendsField = resolveExtends(options.extends);
+  const typeSettings = resolveTypeSettings(options.types);
+  const scopeRules = resolveScopeRules(options.scopes);
+  const subjectRules = resolveSubjectRules(options.subject);
+  const headerRules = resolveHeaderRules(options.header);
+  const baseRules = createBaseRules();
+  const rules = {
+    ...baseRules,
+    "type-enum": typeSettings.rule,
+    ...scopeRules,
+    ...subjectRules,
+    ...headerRules,
+    ...options.rules
+  };
+  const prompt = resolvePrompt(typeSettings.definitions, options.prompt);
+  return removeUndefined({
+    extends: extendsField,
+    formatter: options.formatter,
+    parserPreset: options.parserPreset ?? DEFAULT_PARSER_PRESET,
+    rules,
+    ignores: options.ignores,
+    defaultIgnores: options.defaultIgnores,
+    plugins: options.plugins,
+    helpUrl: options.helpUrl,
+    prompt
+  });
+}
 
 // src/index.ts
-function icebreaker(config) {
-  return defu(config, {
-    extends: ["@commitlint/config-conventional"]
-  });
+import { RuleConfigCondition, RuleConfigSeverity as RuleConfigSeverity2, TargetCaseType } from "@commitlint/types";
+function createCommitlintConfig(options) {
+  return createIcebreakerCommitlintConfig(options);
+}
+function icebreaker(options) {
+  return createIcebreakerCommitlintConfig(options);
 }
 export {
+  DEFAULT_COMMIT_TYPES,
+  DEFAULT_EXTENDS,
+  DEFAULT_SUBJECT_FORBIDDEN_CASES,
+  DEFAULT_TYPES,
   RuleConfigCondition,
-  RuleConfigSeverity,
+  RuleConfigSeverity2 as RuleConfigSeverity,
   TargetCaseType,
+  createCommitlintConfig,
+  createIcebreakerCommitlintConfig,
   icebreaker
 };

package/package.json

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