commitlint: use When enum

nblockchain · Feb 25, 2023 · 50de12e · 50de12e
1 parent cae2cdc
commit 50de12e
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/commitlint.config.ts b/commitlint.config.ts
@@ -151,7 +151,7 @@ module.exports = {
                         header: any;
                         body: any;
                     },
-                    when: string
+                    when: When
                 ) => {
                     Helpers.assertWhen(when);
 

diff --git a/commitlint/helpers.ts b/commitlint/helpers.ts
@@ -42,12 +42,13 @@ export abstract class Helpers {
         return text as string;
     }
 
-    public static assertWhen(when: string) {
+    public static assertWhen(when: When) {
         if (when !== When.Never && when !== When.Always) {
             throw new Error(
                 'Variable "when" should be either "never" or "always"'
             );
         }
+        return when
     }
 
     public static assertCharacter(letter: string) {

diff --git a/commitlint/plugins.ts b/commitlint/plugins.ts
@@ -1,5 +1,5 @@
 import { abbr } from "./abbreviations";
-import { Helpers } from "./helpers";
+import { Helpers, When } from "./helpers";
 
 export abstract class Plugins {
     public static bodyProse(rawStr: string) {
@@ -265,7 +265,7 @@ export abstract class Plugins {
     public static defaultRevertMessage(
         headerStr: string,
         bodyStr: string | null,
-        when: string
+        when: When
     ) {
         let offence = false;
         let isRevertCommitMessage = headerStr.toLowerCase().includes("revert");