add validate markdown fn

ShMcK · ShMcK · commit 3feef7c453cb · 2020-06-12T18:50:05.000-07:00
Signed-off-by: shmck &lt;shawn.j.mckay@gmail.com&gt;
diff --git a/src/utils/validateMarkdown.ts b/src/utils/validateMarkdown.ts
@@ -1,9 +1,72 @@
+type Validation = {
+  message: string;
+  validate: (t: string) => boolean;
+};
+
+const validations: Validation[] = [
+  {
+    message: "should start with a title",
+    validate: (t) => !!t.match(/^#\s.+/),
+  },
+  {
+    message: "should not have multiple `#` headers",
+    validate: (t) => !t.match(/[\n\r]#\s/),
+  },
+  {
+    message: "should have a summary description under the title",
+    validate: (t) => {
+      const [summary] = t.split(/[\n\r]##/) || [""];
+      const description = summary
+        .split(/\n/)
+        .slice(1)
+        .filter((l) => l.length);
+      return !!description.length;
+    },
+  },
+  {
+    message: "should have a level `##` with a format of `L[0-9]+`",
+    validate: (t) => {
+      const headers = t.match(/^#{2}\s(.+)$/gm) || [];
+      console.log("level headers", headers);
+      for (const header of headers) {
+        if (!header.match(/^#{2}\s(L\d+)\s(.+)$/)) {
+          return false;
+        }
+      }
+      return true;
+    },
+  },
+  {
+    message: "should have a step `###` with a format of `L[0-9]+S[0-9]+`",
+    validate: (t) => {
+      const headers = t.match(/^#{3}\s(.+)$/gm) || [];
+      console.log("step headers", headers);
+      for (const header of headers) {
+        if (!header.match(/^#{3}\s(L\d+)S\d+/)) {
+          return false;
+        }
+      }
+      return true;
+    },
+  },
+];
+
+const codeBlockRegex = /```[a-z]*\n[\s\S]*?\n```/gm;
+
 export function validateMarkdown(md: string): boolean {
-  // validate title (#)
-  // validate description
-  // validate level
-  // validate steps
-  // validate codeblock formats
+  // remove codeblocks which might contain any valid combinations
+  const text = md.replace(codeBlockRegex, "");
+
+  let valid = true;
+
+  for (const v of validations) {
+    if (!v.validate(text)) {
+      valid = false;
+      //   if (process.env.NODE_ENV !== "test") {
+      console.warn(v.message);
+      //   }
+    }
+  }
 
-  return false;
+  return valid;
 }
diff --git a/tests/markdown.test.ts b/tests/markdown.test.ts
@@ -37,6 +37,7 @@ Some text that describes the level
 
 # Another title
 `;
+
     expect(validateMarkdown(md1)).toBe(false);
     expect(validateMarkdown(md2)).toBe(false);
   });
@@ -97,6 +98,36 @@ Some text that describes the level
 
 ### L1S1
 
+First Step`;
+    expect(validateMarkdown(md)).toBe(true);
+  });
+
+  it("should ignore markdown content in codeblocks", () => {
+    const md = `# Title
+
+Description.
+
+\`\`\`md
+# A codeblock
+
+Should not be a problem
+\`\`\`
+
+
+## L1 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
+
+Should not be an issue
+\`\`\`
+
+### L1S1
+
 First Step`;
     expect(validateMarkdown(md)).toBe(true);
   });
