ci: 🎡 commitlint msg to a new level

added git-cz for cli interactive git commit messages, also changes the
requirements for commit messages

Author: blu3eee

commitlint.config.cjs

@@ -1,23 +1,124 @@
+// Credit: @ONEARMY/community-platform
+// https://github.com/ONEARMY/community-platform/blob/master/commitlint.config.js
+
+/* global module */
 module.exports = {
-  extends: [],
-  rules: {
-    "header-min-length": [2, "always", 15],
-    "header-case-start-capital": [2, "always"],
-    "header-end-period": [2, "always"],
-  },
-  plugins: [
-    {
-      rules: {
-        "header-case-start-capital": ({ raw }) => {
-          return [
-            /^[A-Z]/.test(raw),
-            "Commit message must start with a capital letter.",
-          ];
-        },
-        "header-end-period": ({ header }) => {
-          return [/\.$/.test(header), "Commit message must end with a period"];
+  extends: ["@commitlint/config-conventional"],
+  /** Add optional custom formatter */
+  // Temporarily removed due to unresolved error: https://app.circleci.com/pipelines/github/ONEARMY/community-platform/5891/workflows/59757a07-b416-43be-9a57-eedc1190d5a0/jobs/44654
+  // formatter: path.resolve(__dirname, 'commitlint.format.ts'),
+  /** Add optional override rules (https://www.npmjs.com/package/@commitlint/config-conventional) */
+  // rules: {},
+  helpUrl:
+    "run `npm commit` for interactive prompt or see examples at\nhttps://www.conventionalcommits.org",
+  // Interactive prompts, called via `yarn commit`
+  prompt: {
+    settings: {},
+    messages: {
+      skip: ":skip",
+      max: "upper %d chars",
+      min: "%d chars at least",
+      emptyWarning: "can not be empty",
+      upperLimitWarning: "over limit",
+      lowerLimitWarning: "below limit",
+    },
+
+    questions: {
+      type: {
+        description: "Select the type of change that you're committing:",
+        enum: {
+          feat: {
+            description: "A new feature",
+            title: "Features",
+            emoji: "✨",
+          },
+          fix: {
+            description: "A bug fix",
+            title: "Bug Fixes",
+            emoji: "🐛",
+          },
+          docs: {
+            description: "Documentation only changes",
+            title: "Documentation",
+            emoji: "📚",
+          },
+          style: {
+            description:
+              "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)",
+            title: "Styles",
+            emoji: "💎",
+          },
+          refactor: {
+            description:
+              "A code change that neither fixes a bug nor adds a feature",
+            title: "Code Refactoring",
+            emoji: "📦",
+          },
+          perf: {
+            description: "A code change that improves performance",
+            title: "Performance Improvements",
+            emoji: "🚀",
+          },
+          test: {
+            description: "Adding missing tests or correcting existing tests",
+            title: "Tests",
+            emoji: "🚨",
+          },
+          build: {
+            description:
+              "Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)",
+            title: "Builds",
+            emoji: "🛠",
+          },
+          ci: {
+            description:
+              "Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)",
+            title: "Continuous Integrations",
+            emoji: "⚙️",
+          },
+          chore: {
+            description: "Other changes that don't modify src or test files",
+            title: "Chores",
+            emoji: "♻️",
+          },
+          revert: {
+            description: "Reverts a previous commit",
+            title: "Reverts",
+            emoji: "🗑",
+          },
         },
       },
+      scope: {
+        description:
+          "What is the scope of this change (e.g. component or file name)",
+      },
+      subject: {
+        description:
+          "Write a short, imperative tense description of the change",
+      },
+      body: {
+        description: "Provide a longer description of the change",
+      },
+      isBreaking: {
+        description: "Are there any breaking changes?",
+      },
+      breakingBody: {
+        description:
+          "A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself",
+      },
+      breaking: {
+        description: "Describe the breaking changes",
+      },
+      isIssueAffected: {
+        description: "Does this change affect any open issues?",
+      },
+      issuesBody: {
+        description:
+          "If issues are closed, the commit requires a body. Please enter a longer description of the commit itself",
+      },
+      issues: {
+        description: 'Add issue references (e.g. "fix #123", "re #123".)',
+      },
     },
-  ],
+  },
 };

commitlint.format.ts

@@ -0,0 +1,31 @@
+import type { FormattableReport, Formatter } from "@commitlint/types";
+
+// Custom formatter for commitlint message
+export const formatter: Formatter = function (report, options) {
+  const { results, valid } = report as IFormatReport;
+  if (results && !valid) {
+    console.log("\nCommit needs to be formatted as conventional commit");
+    console.log("\n<type>[optional scope]: <description>\n");
+    for (const result of results) {
+      if (result.errors) {
+        for (const error of result.errors) {
+          console.log(result.input);
+          console.log("\x1b[31m%s\x1b[0m", "✖   " + error.message);
+        }
+      }
+    }
+  }
+  console.log("\n");
+  console.log(options.helpUrl);
+  console.log("\n");
+  return "";
+};
+
+module.exports = formatter;
+
+// Fix type definition for formattable report
+interface IFormatReport extends FormattableReport {
+  errorCount: number;
+  valid: boolean;
+  warningCount: number;
+}

package.json

@@ -9,7 +9,8 @@
     "prepare": "husky",
     "lint": "eslint . --ext js,jsx,ts,tsx --report-unused-disable-directives --max-warnings 0",
     "lint:fix": "eslint . --ext js,jsx,ts,tsx --fix",
-    "format": "prettier --config .prettierrc.json --write --ignore-unknown \"**/*.{ts,tsx}\""
+    "format": "prettier --config .prettierrc.json --write --ignore-unknown \"**/*.{ts,tsx}\"",
+    "commit": "npx git-cz"
   },
   "dependencies": {
     "@radix-ui/react-collapsible": "^1.0.3",