add schema validation

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

Author: ShMcK

Diff for: src/build.ts

@@ -6,6 +6,7 @@ import * as util from "util";
 import { parse } from "./utils/parse";
 import { getArg } from "./utils/args";
 import { getCommits, CommitLogObject } from "./utils/commits";
+import { validateSchema } from "./utils/validate";
 import * as T from "../typings/tutorial";
 
 const write = util.promisify(fs.writeFile);
@@ -58,7 +59,7 @@ async function build(args: string[]) {
   // path to run build from
   const localPath = path.join(process.cwd(), options.dir);
 
-  // load files
+  // load markdown and files
   let _markdown: string;
   let _yaml: string;
   try {
@@ -72,6 +73,7 @@ async function build(args: string[]) {
     return;
   }
 
+  // parse yaml config
   let config;
   try {
     config = yamlParser.load(_yaml);
@@ -80,6 +82,7 @@ async function build(args: string[]) {
     console.error(e.message);
   }
 
+  // load git commits to use in parse step
   let commits: CommitLogObject;
   try {
     commits = await getCommits({
@@ -92,7 +95,7 @@ async function build(args: string[]) {
     return;
   }
 
-  // Otherwise, continue with the other options
+  // parse tutorial from markdown and yaml
   let tutorial: T.Tutorial;
   try {
     tutorial = await parse({
@@ -106,11 +109,25 @@ async function build(args: string[]) {
     return;
   }
 
+  // validate tutorial based on json schema
+  try {
+    const valid = validateSchema(tutorial);
+    if (!valid) {
+      console.error("Tutorial validation failed. See above to see what to fix");
+      return;
+    }
+  } catch (e) {
+    console.error("Error validating tutorial schema:");
+    console.error(e.message);
+  }
+
+  // write tutorial
   if (tutorial) {
     try {
       await write(options.output, JSON.stringify(tutorial), "utf8");
+      console.info(`Success! See output at ${options.output}`);
     } catch (e) {
-      console.error("Error writing tutorial json:");
+      console.error("Error writing tutorial json file:");
       console.error(e.message);
     }
   }

Diff for: src/utils/logs.ts

@@ -7,12 +7,12 @@ const _info = console.info;
 
 console.error = function () {
   // @ts-ignore
-  _error(red.bold.apply(console, arguments));
+  _error(red.apply(console, arguments));
 };
 
 console.warn = function () {
   // @ts-ignore
-  _warn(yellow.bold.apply(console, arguments));
+  _warn(yellow.apply(console, arguments));
 };
 
 console.info = function () {

Diff for: src/utils/validate.ts

@@ -16,7 +16,6 @@ export function validateSchema(json: any): boolean | PromiseLike<boolean> {
   if (!valid) {
     // log errors
     if (process.env.NODE_ENV !== "test") {
-      console.error("Validation failed. See below for details");
       jsonSchema.errors?.forEach((error: JsonSchema.ErrorObject) => {
         console.warn(
           `Validation error at ${error.dataPath} - ${error.message}`