Jun 2, 2020 · Jun 2, 2020
diff --git a/src/build.ts b/src/build.ts
 import { parse } from "./utils/parse";
 import { getArg } from "./utils/args";
 import { getCommits, CommitLogObject } from "./utils/commits";
 import { validateSchema } from "./utils/validate";
 import { validateSchema } from "./utils/validateSchema";
 import * as T from "../typings/tutorial";

 const write = util.promisify(fs.writeFile);
diff --git a/src/cli.ts b/src/cli.ts
 import "./utils/logs";
 import build from "./build";
 import create from "./create";
 import { help, create as createHelp, build as buildHelp } from "./help";
 import validate from "./validate";
 import * as help from "./help";

 export async function cli(rawArgs: string[]): Promise<void> {
  const command: string = rawArgs[2];

    case "build":
      if (args.length && ["--help", "-h"].includes(args[0])) {
 buildHelp();
 help.build();
        return;
      }
      build(args);
      break;

    case "create":
      if (args.length && ["--help", "-h"].includes(args[0])) {
 createHelp();
 help.create();
        return;
      }
      create(args);
      break;

    case "validate":
      if (args.length && ["--help", "-h"].includes(args[0])) {
        help.validate();
        return;
      }
      validate(args);
      break;

    case "--help":
    case "-h":
    default:
      help();
      help.main();
  }
 }
diff --git a/src/help.ts b/src/help.ts
 export functionhelp() {
 export functionmain() {
  console.log(`
 CodeRoad CLI
 Usage: coderoad [options]

 Options:
 --help (-h)       display these help docs
 --version (-v)    show coderoad cli version
 create            start a new tutorial from a template
 build             generate a coderoad.json file from markdown and yaml
 validate          run a variety of tests to ensure a tutorial works as intended

 More docs at https://github.com/coderoad/coderoad-cli
    `);
 More docs at https://github.com/coderoad/coderoad-cli`);
 }

 export function create() {
  console.log(`
  console.log(`Create a new CodeRoad tutorial project from a template.

 Usage: coderoad create [path] [options]

 Options:
 --help (-h)         display these help docs
 --lang (-l)         programming language for template
 --testRunner (-t)   test runner module for template

 More docs at https://github.com/coderoad/coderoad-cli
 `);
 More docs at https://github.com/coderoad/coderoad-cli`);
 }

 export function build() {
  console.log(`
  console.log(`Compile a coderoad.json file from markdown & yaml.

 Usage: coderoad build [path] [options]

 Options:
 --yaml (-y)       custom path to the tutorial yaml file (coderoad.yaml)
 --output (-o)     custom path to tutorial json config file (coderoad.json)

 More docs at https://github.com/coderoad/coderoad-cli
 `);
 More docs at https://github.com/coderoad/coderoad-cli`);
 }

 export function validate() {
  console.log(`Validates commits and tests across a tutorial.

 Usage: coderoad validate [path] [options]

 Options:
 --help (-h)       display these help docs

 More docs at https://github.com/coderoad/coderoad-cli`);
 }
diff --git a/src/utils/validate.ts → src/utils/validateSchema.ts b/src/utils/validate.ts → src/utils/validateSchema.ts
diff --git a/src/validate.ts b/src/validate.ts
 async function validate(args: string[]) {
  // dir - default .
  const dir = !args.length || args[0].match(/^-/) ? "." : args[0];
  console.warn("Not yet implemented. Coming soon");
  return;

  // setup .tmp directory
  // git clone branch

  // VALIDATE SKELETON WITH COMMITS
  // parse tutorial skeleton for order and commands

  // on error, warn missing level/step

  // VALIDATE COMMIT ORDER
  // list all commits in order
  // validate that a level number doesn't come before another level
  // validate that a step falls within a level
  // validate that steps are in order

  // on error, show level/step out of order

  // VALIDATE TUTORIAL TESTS
  // load INIT commit(s)
  // run test runner setup command(s)
  // loop over commits:
  // - load level commit
  // - run level setup command(s)
  // - load step setup commit(s)
  // - run step setup command(s)
  // - if next solution:
  //    - run test - expect fail
  // - if solution
  //    - run test - expect pass

  // log level/step
  // on error, show level/step & error message

  // CLEANUP
  // finally: remove .tmp directory
 }

 export default validate;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,7 +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 { validateSchema } from "./utils/validateSchema";
		import * as T from "../typings/tutorial";

		const write = util.promisify(fs.writeFile);
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,7 +1,8 @@
		import "./utils/logs";
		import build from "./build";
		import create from "./create";
		import { help, create as createHelp, build as buildHelp } from "./help";
		import validate from "./validate";
		import * as help from "./help";

		export async function cli(rawArgs: string[]): Promise<void> {
		const command: string = rawArgs[2];
Expand All		@@ -16,23 +17,31 @@ export async function cli(rawArgs: string[]): Promise<void> {

		case "build":
		if (args.length && ["--help", "-h"].includes(args[0])) {
		buildHelp();
		help.build();
		return;
		}
		build(args);
		break;

		case "create":
		if (args.length && ["--help", "-h"].includes(args[0])) {
		createHelp();
		help.create();
		return;
		}
		create(args);
		break;

		case "validate":
		if (args.length && ["--help", "-h"].includes(args[0])) {
		help.validate();
		return;
		}
		validate(args);
		break;

		case "--help":
		case "-h":
		default:
		help();
		help.main();
		}
		}
Original file line number	Diff line number	Diff line change
		@@ -1,32 +1,34 @@
		export functionhelp() {
		export functionmain() {
		console.log(`
		CodeRoad CLI
		Usage: coderoad [options]

		Options:
		--help (-h) display these help docs
		--version (-v) show coderoad cli version
		create start a new tutorial from a template
		build generate a coderoad.json file from markdown and yaml
		validate run a variety of tests to ensure a tutorial works as intended

		More docs at https://github.com/coderoad/coderoad-cli
		`);
		More docs at https://github.com/coderoad/coderoad-cli`);
		}

		export function create() {
		console.log(`
		console.log(`Create a new CodeRoad tutorial project from a template.

		Usage: coderoad create [path] [options]

		Options:
		--help (-h) display these help docs
		--lang (-l) programming language for template
		--testRunner (-t) test runner module for template

		More docs at https://github.com/coderoad/coderoad-cli
		`);
		More docs at https://github.com/coderoad/coderoad-cli`);
		}

		export function build() {
		console.log(`
		console.log(`Compile a coderoad.json file from markdown & yaml.

		Usage: coderoad build [path] [options]

		Options:
Expand All		@@ -35,6 +37,16 @@ Options:
		--yaml (-y) custom path to the tutorial yaml file (coderoad.yaml)
		--output (-o) custom path to tutorial json config file (coderoad.json)

		More docs at https://github.com/coderoad/coderoad-cli
		`);
		More docs at https://github.com/coderoad/coderoad-cli`);
		}

		export function validate() {
		console.log(`Validates commits and tests across a tutorial.

		Usage: coderoad validate [path] [options]

		Options:
		--help (-h) display these help docs

		More docs at https://github.com/coderoad/coderoad-cli`);
		}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,43 @@
		async function validate(args: string[]) {
		// dir - default .
		const dir = !args.length \|\| args[0].match(/^-/) ? "." : args[0];
		console.warn("Not yet implemented. Coming soon");
		return;

		// setup .tmp directory
		// git clone branch

		// VALIDATE SKELETON WITH COMMITS
		// parse tutorial skeleton for order and commands

		// on error, warn missing level/step

		// VALIDATE COMMIT ORDER
		// list all commits in order
		// validate that a level number doesn't come before another level
		// validate that a step falls within a level
		// validate that steps are in order

		// on error, show level/step out of order

		// VALIDATE TUTORIAL TESTS
		// load INIT commit(s)
		// run test runner setup command(s)
		// loop over commits:
		// - load level commit
		// - run level setup command(s)
		// - load step setup commit(s)
		// - run step setup command(s)
		// - if next solution:
		// - run test - expect fail
		// - if solution
		// - run test - expect pass

		// log level/step
		// on error, show level/step & error message

		// CLEANUP
		// finally: remove .tmp directory
		}

		export default validate;