@icebreakers/commitlint-config 1.1.0 → 1.2.0

package/dist/index.mjs

@@ -1,112 +1,23 @@
-// src/config.ts
-import {
-  RuleConfigSeverity
-} from "@commitlint/types";
+// src/builders.ts
+import conventionalConfig from "@commitlint/config-conventional";
 
-// 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/types.ts
+import { RuleConfigSeverity } from "@commitlint/types";
 
 // src/utils.ts
-function toArray(value) {
+function asArray(value) {
   if (value === void 0) {
     return [];
   }
   return Array.isArray(value) ? value : [value];
 }
-function unique(values) {
+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);
@@ -114,279 +25,202 @@ function unique(values) {
   }
   return result;
 }
-function toTitleCase(value) {
-  return value.split(/[-_/]/g).filter(Boolean).map((segment) => segment.charAt(0).toUpperCase() + segment.slice(1)).join(" ");
-}
-function createDefaultCommitTypeDefinition(value) {
+
+// src/builders.ts
+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 {
-    value,
-    title: toTitleCase(value),
-    description: "Custom change type"
+    severity: RuleConfigSeverity.Error,
+    condition: "always",
+    values: []
   };
 }
-function mergeTypeDefinitions(defaults, overrides = []) {
-  const map = /* @__PURE__ */ new Map();
-  for (const definition of defaults) {
-    map.set(definition.value, definition);
-  }
-  for (const definition of overrides) {
-    map.set(definition.value, definition);
+function buildTypesConfig(options) {
+  if (!options) {
+    return {};
   }
-  return map;
-}
-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 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 output = { ...base };
-  for (const [key, value] of Object.entries(override)) {
-    if (value === void 0) {
-      continue;
-    }
-    const baseValue = output[key];
-    if (isPlainObject(baseValue) && isPlainObject(value)) {
-      output[key] = mergeDeep(baseValue, value);
-      continue;
-    }
-    if (Array.isArray(value)) {
-      output[key] = [...value];
-      continue;
+  const prompt = {
+    ...conventionalConfig.prompt ?? {},
+    questions: {
+      ...conventionalConfig.prompt?.questions ?? {},
+      type: {
+        ...basePromptType ?? {},
+        enum: mergedEnum
+      }
     }
-    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];
-  }
-  const values = toArray(entries);
-  return unique([...DEFAULT_EXTENDS, ...values]);
+  };
+  return { rule, prompt };
 }
-function resolveTypeSettings(options) {
-  let severity = RuleConfigSeverity.Error;
-  let condition = "always";
-  let overrides = [];
-  let values;
+function buildScopeRules(options) {
   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]);
+    return {};
   }
-  if (values.length === 0) {
-    return {
-      definitions: [],
-      rule: [RuleConfigSeverity.Disabled]
-    };
+  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];
+    }
   }
-  const definitionsMap = mergeTypeDefinitions(DEFAULT_COMMIT_TYPES, overrides);
-  const definitions = values.map(
-    (value) => definitionsMap.get(value) ?? createDefaultCommitTypeDefinition(value)
-  );
-  return {
-    definitions,
-    rule: [severity, condition, values]
-  };
-}
-function asCaseArray(value) {
-  if (!value) {
-    return [];
+  const scopeCases = mergeUnique(asArray(options.case));
+  if (scopeCases.length > 0) {
+    rules["scope-case"] = [severity, "always", scopeCases];
   }
-  return toArray(value);
+  return rules;
 }
-function resolveScopeRules(options) {
+function buildSubjectRules(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"];
+  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(options) && options.case) {
-    const scopeCaseValues = asCaseArray(options.case);
-    if (scopeCaseValues.length > 0) {
-      const caseSeverity = options.caseSeverity ?? baseSeverity;
-      rules["scope-case"] = [caseSeverity, "always", scopeCaseValues];
+  if (options.fullStop !== void 0) {
+    if (options.fullStop) {
+      rules["subject-full-stop"] = [
+        options.fullStopSeverity ?? RuleConfigSeverity.Error,
+        "always",
+        options.fullStopCharacter ?? "."
+      ];
+    } else {
+      rules["subject-full-stop"] = [RuleConfigSeverity.Disabled];
     }
   }
   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"];
+function buildHeaderRules(options) {
+  if (!options) {
+    return {};
   }
-  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];
+  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 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) {
+
+// 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;
+  }
+  if (!base) {
+    return override;
+  }
+  if (!override) {
+    return base;
+  }
   return {
+    ...base,
+    ...override,
     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
-      }
+      ...base.questions ?? {},
+      ...override.questions ?? {}
     }
   };
 }
-function resolvePrompt(definitions, overrides) {
-  const base = createBasePrompt(definitions);
-  return mergeDeep(base, overrides);
-}
+
+// src/index.ts
 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 { types, scopes, subject, header } = options;
+  const extendsList = mergeUnique([
+    ...DEFAULT_EXTENDS,
+    ...mergeUnique(options.extends ?? [])
+  ]);
   const rules = {
-    ...baseRules,
-    "type-enum": typeSettings.rule,
-    ...scopeRules,
-    ...subjectRules,
-    ...headerRules,
-    ...options.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 prompt = mergePrompts(typesConfig.prompt, options.prompt);
+  return {
+    extends: extendsList,
+    parserPreset: DEFAULT_PARSER_PRESET,
+    ...Object.keys(mergedRules).length > 0 ? { rules: mergedRules } : {},
+    ...prompt ? { prompt } : {}
   };
-  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
-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,
-  RuleConfigSeverity2 as RuleConfigSeverity,
-  TargetCaseType,
-  createCommitlintConfig,
+  RuleConfigSeverity,
   createIcebreakerCommitlintConfig,
   icebreaker
 };

package/package.json

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