update markdown validation

Signed-off-by: shmck <shawn.j.mckay@gmail.com>

Author: ShMcK

src/utils/validateMarkdown.ts

@@ -24,23 +24,23 @@ const validations: Validation[] = [
     },
   },
   {
-    message: "should have a level `##` with a format of `L[0-9]+`",
+    message: "should have a level `##` with a format of `[0-9]+.`",
     validate: (t) => {
       const headers = t.match(/^#{2}\s(.+)$/gm) || [];
       for (const header of headers) {
-        if (!header.match(/^#{2}\s(L\d+)\s(.+)$/)) {
+        if (!header.match(/^#{2}\s(\d+\.)\s(.+)$/)) {
           return false;
         }
       }
       return true;
     },
   },
   {
-    message: "should have a step `###` with a format of `L[0-9]+S[0-9]+`",
+    message: "should have a step `###` with a format of `[0-9].[0-9]+`",
     validate: (t) => {
       const headers = t.match(/^#{3}\s(.+)$/gm) || [];
       for (const header of headers) {
-        if (!header.match(/^#{3}\s(L\d+)S\d+/)) {
+        if (!header.match(/^#{3}\s(\d+\.\d+)/)) {
           return false;
         }
       }
@@ -60,9 +60,9 @@ export function validateMarkdown(md: string): boolean {
   for (const v of validations) {
     if (!v.validate(text)) {
       valid = false;
-      if (process.env.NODE_ENV !== "test") {
-        console.warn(v.message);
-      }
+      // if (process.env.NODE_ENV !== "test") {
+      console.warn(v.message);
+      // }
     }
   }
 

tests/markdown.test.ts

@@ -5,7 +5,7 @@ describe("validate markdown", () => {
     const md = `
 Description.
 
-## Put Level's title here
+## 1. Put Level's title here
 
 > Level's summary: a short description of the level's content in one line.
 
@@ -19,7 +19,7 @@ Description.
 
 # Another Title
 
-## Put Level's title here
+## 1. Put Level's title here
 
 > Level's summary: a short description of the level's content in one line.
 
@@ -29,7 +29,7 @@ Some text that describes the level`;
 Description.
 
 
-## Put Level's title here
+## 1. Put Level's title here
 
 > Level's summary: a short description of the level's content in one line.
 
@@ -45,7 +45,7 @@ Some text that describes the level
   it("should return false if missing a summary description", () => {
     const md = `# A Title
 
-## Put Level's title here
+## 1. Put Level's title here
 
 > Level's summary: a short description of the level's content in one line.
 
@@ -79,24 +79,25 @@ A description
 
 Some text that describes the level
 
-### A Step
+### Missing step id
 
 First step
 `;
+    expect(validateMarkdown(md)).toBe(false);
   });
 
   it("should return true for valid markdown", () => {
     const md = `# Title
 
 Description.
 
-## Put Level's title here
+## 1. Put Level's title here
 
 > Level's summary: a short description of the level's content in one line.
 
 Some text that describes the level
 
-### Step 1
+### 1.1
 
 First Step`;
     expect(validateMarkdown(md)).toBe(true);
@@ -114,19 +115,19 @@ Should not be a problem
 \`\`\`
 
 
-## Put Level's title here
+## 1. Put Level's title here
 
 > Level's summary: a short description of the level's content in one line.
 
 Some text that describes the level
 
 \`\`\`
-## Another Level in markdown
+## 2. Another Level in markdown
 
 Should not be an issue
 \`\`\`
 
-### Step 1
+### 1.1
 
 First Step`;
     expect(validateMarkdown(md)).toBe(true);