refactor process out of cli, allow for programmatic use

ShMcK · ShMcK · commit e70d158eeb30 · 2016-05-31T22:05:09.000-07:00
diff --git a/lib/build/index.js b/lib/build/index.js
@@ -0,0 +1,36 @@
+"use strict";
+var fs_1 = require('fs');
+var validate = require('./validators');
+var info_1 = require('./parser/info');
+var readme_1 = require('./readme');
+var cleanup_1 = require('./parser/cleanup');
+function parseAndBuild(lines) {
+    var result = {
+        info: {
+            title: '',
+            description: '',
+        },
+        pages: []
+    };
+    var index = {
+        page: -1,
+        task: -1,
+    };
+    return info_1.info(result, lines, index);
+}
+function build(filePath, output) {
+    if (output === void 0) { output = './coderoad.json'; }
+    if (!validate.filePath(filePath)) {
+        return false;
+    }
+    ;
+    var lines = fs_1.readFileSync(filePath, 'utf8').split('\n');
+    var result = cleanup_1.cleanup(parseAndBuild(lines));
+    if (validate.result(result)) {
+        fs_1.writeFileSync(output, result, 'utf8');
+    }
+    readme_1.createReadme();
+    return true;
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = build;
diff --git a/lib/build/validators.js b/lib/build/validators.js
@@ -4,7 +4,7 @@ var lint_1 = require('./lint');
 function filePath(filePath) {
     if (!filePath) {
         console.log(chalk.red("\n    Pass in a path to your .md file\n    > coderoad build \"./src/tutorial.md\"\n    "));
-        process.exit(1);
+        return false;
     }
 }
 exports.filePath = filePath;
diff --git a/lib/cli.js b/lib/cli.js
@@ -2,12 +2,13 @@
 "use strict";
 var program = require('commander');
 var chalk_1 = require('chalk');
-var build_1 = require('./build/build');
-var create_1 = require('./create/create');
-var search_1 = require('./search/search');
-var tutorials_1 = require('./tutorials/tutorials');
-var publish_1 = require('./publish/publish');
-var update_1 = require('./update/update');
+var result_1 = require('./result');
+var build_1 = require('./build');
+var create_1 = require('./create');
+var search_1 = require('./search');
+var tutorials_1 = require('./tutorials');
+var publish_1 = require('./publish');
+var update_1 = require('./update');
 program
     .version('0.6.0')
     .usage('[options] <keywords>')
@@ -18,16 +19,22 @@ program
     .option('-s, --search [query]', 'search for tutorial package')
     .option('-r, --run', 'run tutorial')
     .parse(process.argv);
-update_1.checkForUpdate();
+update_1.default();
 if (program.build) {
     var tutorial = program.args[0] || 'tutorial/tutorial.md';
     var output = 'coderoad.json';
     process.stdout.write(chalk_1.grey("building coderoad.json for " + tutorial + "..."));
-    build_1.default(tutorial, output);
+    var built = build_1.default(tutorial, output);
+    if (!built) {
+        result_1.fail();
+    }
 }
 else if (program.create) {
     var packageName = program.args[0];
-    create_1.default(packageName);
+    var created = create_1.default(packageName);
+    if (!created) {
+        result_1.fail();
+    }
 }
 else if (program.search) {
     var query = program.args[0];
@@ -43,5 +50,4 @@ else if (program.publish) {
 else {
     program.help();
 }
-process.stdout.write(chalk_1.green(' ✓\n'));
-process.exit(0);
+result_1.success();
diff --git a/lib/create/index.js b/lib/create/index.js
@@ -0,0 +1,19 @@
+"use strict";
+var validate_1 = require('./validate');
+var write_demo_1 = require('./write-demo');
+var build_1 = require('../build/build');
+function create(name) {
+    if (!validate_1.validatePackageName(name)) {
+        return false;
+    }
+    process.stdout.write("Creating demo tutorial \"coderoad-" + name + "\"...");
+    return Promise.all([
+        write_demo_1.createPackageJson(name),
+        write_demo_1.createTutorialMd()
+    ]).then(function () {
+        build_1.default('tutorial/tutorial.md', 'coderoad.json');
+        return true;
+    });
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = create;
diff --git a/lib/create/validate.js b/lib/create/validate.js
@@ -18,7 +18,8 @@ function validatePackageName(name) {
         if (!validated.errors && !validated.warnings) {
             console.log(chalk_1.red("\n        Invalid package name. Try using kebab-case.\n        > coderoad create " + lodash_kebabcase_1.default(name) + "\n      "));
         }
-        process.exit(1);
+        return false;
     }
+    return true;
 }
 exports.validatePackageName = validatePackageName;
diff --git a/lib/index.js b/lib/index.js
@@ -0,0 +1,13 @@
+"use strict";
+var build_1 = require('./build');
+exports.build = build_1.default;
+var create_1 = require('./create');
+exports.create = create_1.default;
+var publish_1 = require('./publish');
+exports.publish = publish_1.default;
+var search_1 = require('./search');
+exports.search = search_1.default;
+var tutorials_1 = require('./tutorials');
+exports.tutorials = tutorials_1.default;
+var update_1 = require('./update');
+exports.update = update_1.default;
diff --git a/lib/publish/index.js b/lib/publish/index.js
@@ -0,0 +1,13 @@
+"use strict";
+var chalk_1 = require('chalk');
+var validate_1 = require('./validate');
+function publish(version) {
+    validate_1.default(version);
+    process.stdout.write("Publishing package version \"" + version + "\"... \n");
+    console.log(chalk_1.yellow('Publish feature not implemented yet.\n'));
+    console.log('To publish your tutorial package follow these instructions: \n');
+    console.log("Setup a git repo and tag your version:\n    > git init\n    > git add -A\n    > git commit -m \"$your-commit-message$\"\n    > git tag v" + version + "\n    > git add remote origin http://github.com/$your-github-id$/$your-package-name$\n    > git push -u --tags\n  ");
+    console.log("\n    Publish your package to npm:\n    > npm publish\n  ");
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = publish;
diff --git a/lib/result.js b/lib/result.js
@@ -0,0 +1,10 @@
+"use strict";
+var chalk_1 = require('chalk');
+exports.success = function () {
+    process.stdout.write(chalk_1.green(' ✓\n'));
+    process.exit(0);
+};
+exports.fail = function () {
+    process.stdout.write(chalk_1.red(' ✗\n'));
+    process.exit(1);
+};
diff --git a/lib/search/index.js b/lib/search/index.js
@@ -0,0 +1,12 @@
+"use strict";
+var chalk_1 = require('chalk');
+var validate_1 = require('./validate');
+function search(query) {
+    validate_1.validateQuery(query);
+    console.log("Searching for \"coderoad-" + query + "\"...");
+    console.log(chalk_1.yellow('Search feature not fully implemented yet.\n'));
+    console.log('To search for tutorials follow the instructions below: \n');
+    console.log("Search tutorials on npm:\n    > npm search coderoad tutorial\n  ");
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = search;
diff --git a/lib/tutorials/index.js b/lib/tutorials/index.js
@@ -0,0 +1,8 @@
+"use strict";
+var chalk_1 = require('chalk');
+function tutorials() {
+    console.log("List of tutorial packages in this directory...\n");
+    console.log(chalk_1.yellow('This feature is not yet implemented'));
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = tutorials;
diff --git a/lib/update/index.js b/lib/update/index.js
@@ -0,0 +1,5 @@
+"use strict";
+function checkForUpdate() {
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = checkForUpdate;
diff --git a/lib/write.js b/lib/write.js
@@ -0,0 +1,4 @@
+"use strict";
+var chalk_1 = require('chalk');
+exports.success = function () { return process.stdout.write(chalk_1.green(' ✓\n')); };
+exports.fail = function () { return process.stdout.write(chalk_1.red(' ✗\n')); };
diff --git a/src/build/index.ts b/src/build/index.ts
@@ -19,9 +19,11 @@ function parseAndBuild(lines: string[]): CR.Output {
   return info(result, lines, index);
 }
 
-export default function build(filePath: string, output = './coderoad.json'): void {
+export default function build(filePath: string, output = './coderoad.json'): boolean {
   // VALIDATE: path name
-  validate.filePath(filePath);
+  if (!validate.filePath(filePath)) {
+    return false;
+  };
 
   // Read
   let lines: string[] = readFileSync(filePath, 'utf8').split('\n');
@@ -33,4 +35,5 @@ export default function build(filePath: string, output = './coderoad.json'): voi
     writeFileSync(output, result, 'utf8');
   }
   createReadme();
+  return true;
 }
diff --git a/src/build/validators.ts b/src/build/validators.ts
@@ -1,13 +1,13 @@
 import * as chalk from 'chalk';
 import {isValidJSON, hasTutorialInfo, hasPage, lintOutput} from './lint';
 
-export function filePath(filePath: string): void {
+export function filePath(filePath: string): boolean {
   if (!filePath) {
     console.log(chalk.red(`
     Pass in a path to your .md file
     > coderoad build "./src/tutorial.md"
     `));
-    process.exit(1); // fail
+    return false; // fail
   }
   // regex .md
 }
diff --git a/src/cli.ts b/src/cli.ts
@@ -1,14 +1,15 @@
 #! /usr/bin/env node
 
 import * as program from 'commander';
-import {grey, green} from 'chalk';
+import {grey} from 'chalk';
+import {success, fail} from './result';
 
-import build from './build/build';
-import create from './create/create';
-import search from './search/search';
-import tutorials from './tutorials/tutorials';
-import publish from './publish/publish';
-import {checkForUpdate} from './update/update';
+import build from './build';
+import create from './create';
+import search from './search';
+import tutorials from './tutorials';
+import publish from './publish';
+import checkForUpdate from './update';
 
 program
   .version('0.6.0')
@@ -29,11 +30,17 @@ if (program.build) {
   const tutorial = program.args[0] || 'tutorial/tutorial.md';
   const output = 'coderoad.json';
   process.stdout.write(grey(`building coderoad.json for ${tutorial}...`));
-  build(tutorial, output);
+  const built = build(tutorial, output);
+  if (!built) {
+    fail();
+  }
 
 } else if (program.create) {
   const packageName = program.args[0];
-  create(packageName);
+  const created = create(packageName);
+  if (!created) {
+    fail();
+  }
 
 } else if (program.search) {
   const query = program.args[0];
@@ -51,5 +58,4 @@ if (program.build) {
 }
 
 // success! exit
-process.stdout.write(green(' ✓\n'));
-process.exit(0);
+success();
diff --git a/src/create/index.ts b/src/create/index.ts
@@ -2,19 +2,21 @@ import {validatePackageName} from './validate';
 import {createPackageJson, createTutorialMd} from './write-demo';
 import build from '../build/build';
 
-export default function create(name: string, dir: string): void {
+export default function create(name: string): boolean | Promise<boolean> {
   // check
-  validatePackageName(name);
+  if (!validatePackageName(name)) {
+    return false;
+  }
 
   // continue
   process.stdout.write(`Creating demo tutorial "coderoad-${name}"...`);
 
   // npm package
-  Promise.all([
+  return Promise.all([
     createPackageJson(name),
     createTutorialMd()
   ]).then(() => {
     build('tutorial/tutorial.md', 'coderoad.json');
+    return true;
   });
-
 }
diff --git a/src/create/validate.ts b/src/create/validate.ts
@@ -2,7 +2,7 @@ import {red, yellow} from 'chalk';
 import * as validateNpm from 'validate-npm-package-name';
 import kebabCase from 'lodash.kebabcase';
 
-export function validatePackageName(name: string): void {
+export function validatePackageName(name: string): boolean {
   let validated: Validated = validateNpm(name);
   if (!validated.validForNewPackages || !validated.validForOldPackages) {
     if (validated.errors) {
@@ -21,6 +21,7 @@ export function validatePackageName(name: string): void {
         > coderoad create ${kebabCase(name) }
       `));
     }
-    process.exit(1);
+    return false;
   }
+  return true;
 }
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,6 @@
+export {default as build} from './build';
+export {default as create} from './create';
+export {default as publish} from './publish';
+export {default as search} from './search';
+export {default as tutorials} from './tutorials';
+export {default as update} from './update';
diff --git a/src/publish/index.ts b/src/publish/index.ts
diff --git a/src/result.ts b/src/result.ts
@@ -0,0 +1,11 @@
+import {green, red} from 'chalk';
+
+export const success = () => {
+  process.stdout.write(green(' ✓\n'));
+  process.exit(0);
+};
+
+export const fail = () => {
+  process.stdout.write(red(' ✗\n'));
+  process.exit(1); // fail
+};
diff --git a/src/search/index.ts b/src/search/index.ts
diff --git a/src/tutorials/index.ts b/src/tutorials/index.ts
diff --git a/src/typings/es6-promise/es6-promise.d.ts b/src/typings/es6-promise/es6-promise.d.ts
diff --git a/src/update/index.ts b/src/update/index.ts
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ var lint_1 = require('./lint');`
`4`	`4`	`function filePath(filePath) {`
`5`	`5`	`if (!filePath) {`
`6`	`6`	`console.log(chalk.red("\n Pass in a path to your .md file\n > coderoad build \"./src/tutorial.md\"\n "));`
`7`		`- process.exit(1);`
	`7`	`+ return false;`
`8`	`8`	`}`
`9`	`9`	`}`
`10`	`10`	`exports.filePath = filePath;`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,8 @@ function validatePackageName(name) {`
`18`	`18`	`if (!validated.errors && !validated.warnings) {`
`19`	`19`	`console.log(chalk_1.red("\n Invalid package name. Try using kebab-case.\n > coderoad create " + lodash_kebabcase_1.default(name) + "\n "));`
`20`	`20`	`}`
`21`		`- process.exit(1);`
	`21`	`+ return false;`
`22`	`22`	`}`
	`23`	`+ return true;`
`23`	`24`	`}`
`24`	`25`	`exports.validatePackageName = validatePackageName;`