commitlint.config: add rule

Add default-revert-message rule.

Author: tehraninasab

commitlint.config.ts

@@ -51,10 +51,14 @@ module.exports = {
         // disabled because most of the time it doesn't work, due to https://github.com/conventional-changelog/commitlint/issues/3404
         // and anyway we were using this rule only as a warning, not an error (because a scope is not required, e.g. when too broad)
         "type-empty": [RuleConfigSeverity.Disabled, "never"],
+        "default-revert-message": [RuleConfigSeverity.Error, "never"],
     },
+
+    // Commitlint automatically ignores some kinds of commits like Revert commit messages.
+    // We need to set this value to false to apply our rules on these messages.
+    defaultIgnores: false,
     plugins: [
         // TODO (ideas for more rules):
-        // * Detect reverts which have not been elaborated.
         // * Reject some stupid obvious words: change, update, modify (if first word after colon, error; otherwise warning).
         // * Think of how to reject this shitty commit message: https://github.com/nblockchain/NOnion/pull/34/commits/9ffcb373a1147ed1c729e8aca4ffd30467255594
         // * Workflow: detect if wip commit in a branch not named "wip/*" or whose name contains "squashed".
@@ -142,6 +146,30 @@ module.exports = {
                     return Plugins.properIssueRefs(rawStr);
                 },
 
+                "default-revert-message": (
+                    {
+                        header,
+                        body,
+                    }: {
+                        header: any;
+                        body: any;
+                    },
+                    when: string
+                ) => {
+                    Helpers.assertWhen(when);
+
+                    let bodyStr = Helpers.convertAnyToString(body, "body");
+                    let headerStr = Helpers.assertNotNull(
+                        Helpers.convertAnyToString(header, "header"),
+                        notNullStringErrorMessage("header")
+                    );
+                    return Plugins.defaultRevertMessage(
+                        headerStr,
+                        bodyStr,
+                        when
+                    );
+                },
+
                 "title-uppercase": ({ header }: { header: any }) => {
                     let headerStr = Helpers.assertNotNull(
                         Helpers.convertAnyToString(header, "header"),

commitlint/helpers.ts

@@ -37,6 +37,14 @@ export abstract class Helpers {
         return text as string;
     }
 
+    public static assertWhen(when: string) {
+        if (when !== "never" && when !== "always") {
+            throw new Error(
+                'Variable "when" should be either "never" or "always"'
+            );
+        }
+    }
+
     public static assertCharacter(letter: string) {
         if (letter.length !== 1) {
             throw Error("This function expects a character as input");

commitlint/plugins.ts

@@ -278,6 +278,44 @@ export abstract class Plugins {
         ];
     }
 
+    public static defaultRevertMessage(
+        headerStr: string,
+        bodyStr: string | null,
+        when: string
+    ) {
+        let offence = false;
+        let isRevertCommitMessage = headerStr.toLowerCase().includes("revert");
+
+        const negated = when === "never";
+
+        if (isRevertCommitMessage) {
+            let isDefaultRevertHeader =
+                headerStr.match(/^[Rr]evert ".+"$/) !== null;
+
+            if (isDefaultRevertHeader) {
+                if (bodyStr !== null) {
+                    let lines = bodyStr.split("\n");
+                    offence =
+                        lines.length == 1 &&
+                        // 40 is the length of git commit hash.
+                        lines[0].match(/^This reverts commit [^ ]{40}\.$/) !==
+                            null;
+                } else {
+                    offence = true;
+                }
+            }
+
+            offence = negated ? offence : !offence;
+        }
+        return [
+            !offence,
+            (negated
+                ? `Please explain why you're reverting.`
+                : `Please don't change the default revert commit message.`) +
+                Helpers.errMessageSuffix,
+        ];
+    }
+
     public static titleUppercase(headerStr: string) {
         let firstWord = headerStr.split(" ")[0];
         let offence =