.commitlint.config.mjs

/* [commitlint](https://github.com/conventional-changelog/commitlint) configuration
 *
 * Bottlerocket kit repos use a `scope: description` convention where the scope
 * is typically a package name (e.g. `kubernetes-1.36: update to v1.36.2`) or an
 * area (e.g. `changelog: prepare for 15.0.0`).
 *
 * This differs from standard Conventional Commits which require a fixed type
 * prefix (feat, fix, etc.). We enforce the structural rules (colon separator,
 * line lengths, casing) while allowing any lowercase scope before the colon.
 */
import { RuleConfigSeverity } from "@commitlint/types";

// Custom plugin to validate the "scope: description" format used in kit repos.
const kitScopePlugin = {
  rules: {
    // Validates that the header matches `lowercase-scope: lowercase description`
    "kit-scope-format": (parsed, _when, _value) => {
      const header = parsed.header;
      // Match: one or more lowercase words/numbers/dots/dashes, colon, space, then description
      const pattern = /^[a-z][a-z0-9._-]*: .+$/;
      return [
        pattern.test(header),
        "header must match the format 'scope: description' (e.g. 'kubernetes-1.36: update to v1.36.2')",
      ];
    },
  },
};

export default {
  plugins: [kitScopePlugin],
  rules: {
    // Structural rules
    "header-max-length": [RuleConfigSeverity.Error, "always", 72],
    "header-trim": [RuleConfigSeverity.Error, "always"],
    "body-max-line-length": [RuleConfigSeverity.Error, "always", 72],
    "body-leading-blank": [RuleConfigSeverity.Error, "always"],

    // Subject rules (applied to text after the colon)
    "subject-full-stop": [RuleConfigSeverity.Error, "never", "."],

    // Custom kit scope format
    "kit-scope-format": [RuleConfigSeverity.Error, "always"],
  },
  ignores: [
    (message) => message.includes("Merge pull request #"),
    (message) => message.startsWith("Revert \""),
  ],
};