Show multiple errors at once (#2)

Signed-off-by: Matthew Peveler <[email protected]>

Author: MasterOdin

dist/index.js

@@ -41,55 +41,67 @@ export function checkTitle(fullTitle: string): true {
     }
   }
 
-  if (!/^\[[a-zA-Z/]+(?::[a-zA-Z]+)?\] /.test(title)) {
+  if (!/^\[[a-zA-Z0-9\\/]+(?::[a-zA-Z0-9\\/]+)?\] /.test(title)) {
     throw new Error(
       `Invalid title format, must start with ${
         hasSysadminTag ? sysadminTag : ""
       }[<TYPE>:<MODULE>] and have space before description.`
     );
   }
 
+  const errors = [];
+
   const [
     _,
     type,
     module,
     message,
-  ] = /^\[([a-zA-Z/]+)(?::([a-zA-Z]+))?\] (.*)/.exec(title) as RegExpMatchArray;
+  ] = /^\[([a-zA-Z0-9\\/]+)(?::([a-zA-Z0-9\\/]+))?\] (.*)/.exec(
+    title
+  ) as RegExpMatchArray;
 
   const isDependency = type === "Dependency" || type === "DevDependency";
   const minMessageLength = 2;
   const maxMessageLength = isDependency ? 70 : 40;
 
   if (!allowedTypes.includes(type)) {
-    throw new Error(
+    errors.push(
       `Invalid type, expected one of ${allowedTypes.join(", ")}. Got ${type}.`
     );
   }
 
   if (isDependency) {
     if (module !== undefined) {
-      throw new Error(
+      errors.push(
         `No allowed module for ${type}, expected [${type}]. Got [${type}:${module}].`
       );
     }
   } else if (!allowedModules.includes(module)) {
-    throw new Error(
+    errors.push(
       `Invalid module, expected one of ${allowedModules.join(
         ", "
       )}. Got ${module}.`
     );
   }
 
   if (message.length < minMessageLength) {
-    throw new Error(
+    errors.push(
       `Too short a message, expected at least ${minMessageLength} characters, got ${message.length} characters.`
     );
   }
   if (message.length > maxMessageLength) {
-    throw new Error(
+    errors.push(
       `Too long a message, expected at most ${maxMessageLength} characters, got ${message.length} characters.`
     );
   }
 
+  if (errors.length > 0) {
+    throw new Error(
+      `Errors detected in title:\n${errors
+        .map((str) => `  - ${str}`)
+        .join("\n")}`
+    );
+  }
+
   return true;
 }

dist/index.js.map

@@ -24,48 +24,72 @@ describe("validate", () => {
     });
 
     describe("throws", () => {
-      [
-        [
-          "[UI//UX:API] xxxx",
-          "Invalid type, expected one of Bugfix, Feature, Refactor, Testing, Documentation, VPAT, UI/UX, Dependency, DevDependency. Got UI//UX.",
-        ],
-        [
-          "[UI\\/UX:API] xxxx",
-          "Invalid title format, must start with [<TYPE>:<MODULE>] and have space before description.",
-        ],
-        [
-          "[Refactor:RainbowGrades]",
-          "Invalid title format, must start with [<TYPE>:<MODULE>] and have space before description.",
-        ],
-        [
-          "[BugFix:TAGrading] xxxx",
-          "Invalid type, expected one of Bugfix, Feature, Refactor, Testing, Documentation, VPAT, UI/UX, Dependency, DevDependency. Got BugFix.",
-        ],
-        [
-          "[Dependency:Autograding] xxxx",
-          "No allowed module for Dependency, expected [Dependency]. Got [Dependency:Autograding].",
-        ],
-        [
-          "[SYSADMINACTION][Refactor:Autograding] xxxx",
-          "Invalid title format, must start with [<TYPE>:<MODULE>] and have space before description.",
-        ],
+      describe("error parsing", () => {
         [
-          "[DevDependency:Autograding] xxxx",
-          "No allowed module for DevDependency, expected [DevDependency]. Got [DevDependency:Autograding].",
-        ],
-        [
-          "[Bugfix:Submission] a",
-          "Too short a message, expected at least 2 characters, got 1 characters.",
-        ],
+          [
+            "[Refactor:RainbowGrades]",
+            "Invalid title format, must start with [<TYPE>:<MODULE>] and have space before description.",
+          ],
+          [
+            "[SYSADMINACTION][Refactor:Autograding] xxxx",
+            "Invalid title format, must start with [<TYPE>:<MODULE>] and have space before description.",
+          ],
+        ].forEach(([value, expectedException]) => {
+          it(`checkTitle should throw: ${value}`, () => {
+            expect(() => checkTitle(value)).to.throw(expectedException);
+          });
+        });
+      });
+
+      describe("specific format errors", () => {
         [
-          "[Bugfix:Submission] 01234567890123456789012345678901234567890",
-          "Too long a message, expected at most 40 characters, got 41 characters.",
-        ],
-      ].forEach(([value, expectedException]) => {
-        it(`checkTitle should throw: ${value}`, () => {
-          expect(() => checkTitle(value)).to.throw(expectedException);
+          [
+            "[UI//UX:API] xxxx",
+            "Invalid type, expected one of Bugfix, Feature, Refactor, Testing, Documentation, VPAT, UI/UX, Dependency, DevDependency. Got UI//UX.",
+          ],
+          [
+            "[UI\\/UX:API] xxxx",
+            "Invalid type, expected one of Bugfix, Feature, Refactor, Testing, Documentation, VPAT, UI/UX, Dependency, DevDependency. Got UI\\/UX.",
+          ],
+          [
+            "[BugFix:TAGrading] xxxx",
+            "Invalid type, expected one of Bugfix, Feature, Refactor, Testing, Documentation, VPAT, UI/UX, Dependency, DevDependency. Got BugFix.",
+          ],
+          [
+            "[Dependency:Autograding] xxxx",
+            "No allowed module for Dependency, expected [Dependency]. Got [Dependency:Autograding].",
+          ],
+          [
+            "[DevDependency:Autograding] xxxx",
+            "No allowed module for DevDependency, expected [DevDependency]. Got [DevDependency:Autograding].",
+          ],
+          [
+            "[Bugfix:Submission] a",
+            "Too short a message, expected at least 2 characters, got 1 characters.",
+          ],
+          [
+            "[Bugfix:Submission] 01234567890123456789012345678901234567890",
+            "Too long a message, expected at most 40 characters, got 41 characters.",
+          ],
+        ].forEach(([value, expectedException]) => {
+          it(`checkTitle should throw: ${value}`, () => {
+            expect(() => checkTitle(value)).to.throw(
+              `Errors detected in title:\n  - ${expectedException}`
+            );
+          });
         });
       });
+
+      it("should show multiple format errors at once", () => {
+        expect(() =>
+          checkTitle(
+            "[Fake:Error] this message is much too long and it should be shortened"
+          )
+        ).to.throw(`Errors detected in title:
+  - Invalid type, expected one of Bugfix, Feature, Refactor, Testing, Documentation, VPAT, UI/UX, Dependency, DevDependency. Got Fake.
+  - Invalid module, expected one of Submission, Autograding, Forum, Notifications, TAGrading, InstructorUI, SubminiPolls, HelpQueue, CourseMaterials, Plagiarism, RainbowGrades, System, Developer, API. Got Error.
+  - Too long a message, expected at most 40 characters, got 56 characters.`);
+      });
     });
   });
 });