add markdown validation to build script

Signed-off-by: shmck <[email protected]>

Author: ShMcK

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coderoad/cli",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A CLI to build the configuration file for Coderoad Tutorials",
   "keywords": [
     "coderoad",
@@ -25,7 +25,7 @@
   ],
   "main": "bin/coderoad",
   "bin": {
-    "@coderoad/coderoad": "bin/coderoad",
+    "@coderoad/cli": "bin/coderoad",
     "coderoad": "bin/coderoad"
   },
   "scripts": {

src/build.ts

@@ -8,6 +8,7 @@ import { getCommits, CommitLogObject } from "./utils/commits";
 import skeletonSchema from "./schema/skeleton";
 import tutorialSchema from "./schema/tutorial";
 import { validateSchema } from "./utils/validateSchema";
+import { validateMarkdown } from "./utils/validateMarkdown";
 import * as T from "../typings/tutorial";
 
 const write = util.promisify(fs.writeFile);
@@ -72,6 +73,18 @@ async function build(args: string[]) {
     return;
   }
 
+  // validate markdown loosely
+  try {
+    const isValid = validateMarkdown(_markdown);
+    if (!isValid) {
+      console.warn("Invalid markdown");
+    }
+  } catch (e) {
+    console.error("Error validating markdown:");
+    console.error(e.message);
+    return;
+  }
+
   // parse yaml skeleton config
   let skeleton;
   try {

src/utils/validateMarkdown.ts

@@ -27,7 +27,6 @@ const validations: Validation[] = [
     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;
@@ -40,7 +39,6 @@ const validations: Validation[] = [
     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;
@@ -62,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);
+      }
     }
   }