commitlint.config.js

module.exports = {
  prompt: {
    questions: {
      type: {
        description: `Select the type of change you're committing:`,
        enum: {
          add: {
            description: `Create a capability e.g. feature, test, dependency.`,
            title: `add`,
          },
          bump: {
            description: `Increase the version of something e.g. a dependency.`,
            title: `bump`,
          },
          document: {
            description: `A change that MUST be only in the documentation, e.g. help files.`,
            title: `document`,
          },
          drop: {
            description: `Delete a capability e.g. feature, test, dependency.`,
            title: `drop`,
          },
          fix: {
            description: `Fix an issue e.g. bug, typo, accident, misstatement.`,
            title: `fix`,
          },
          make: {
            description: `Change the build process, or tools, or infrastructure.`,
            title: `make`,
          },
          optimize: {
            description: `A change that MUST be just about performance, e.g. speed up code.`,
            title: `optimize`,
          },
          refactor: {
            description: `A change that MUST be just refactoring.`,
            title: `refactor`,
          },
          reformat: {
            description: `A change that MUST be just format, e.g. indent line, trim space, etc.`,
            title: `reformat`,
          },
          rephrase: {
            description: `A change that MUST be just textual, e.g. edit a comment, doc, etc.`,
            title: `rephrase`,
          },
          start: {
            description: `Begin doing something; e.g. enable a toggle, feature flag, etc.`,
            title: `start`,
          },
          stop: {
            description: `End doing something; e.g. disable a toggle, feature flag, etc.`,
            title: `stop`,
          },
        },
      },
    },
  },
  rules: {
    'header-max-length': [2, `always`, 72],
    'scope-case': [2, `always`, `lower-case`],
    'subject-case': [
      2,
      `never`,
      [`sentence-case`, `start-case`, `pascal-case`, `upper-case`],
    ],
    'subject-empty': [2, `never`],
    'subject-full-stop': [2, `never`, `.`],
    'type-case': [2, `always`, `lower-case`],
    'type-empty': [2, `never`],
    'type-enum': [
      2,
      `always`,
      [
        `add`,
        `drop`,
        `fix`,
        `bump`,
        `make`,
        `start`,
        `stop`,
        `optimize`,
        `document`,
        `refactor`,
        `reformat`,
        `rephrase`,
      ],
    ],
  },
}