prepare validate packageJson

Author: ShMcK

CHANGELOG.md

@@ -2,10 +2,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.7.0] - WIP
+- validate packageJson function
+
 ## [0.6.0] - 2016-06-12
 - allow for programmatic use
 - working `> coderoad tutorials`
-- validate name function
 
 ## [0.5.0] - 2016-05-02
 - bug fixes

lib/cli.js

@@ -9,15 +9,17 @@ var search_1 = require('./search');
 var tutorials_1 = require('./tutorials');
 var publish_1 = require('./publish');
 var update_1 = require('./update');
+var validate_1 = require('./validate');
 program
-    .version('0.6.0')
+    .version('0.7.0')
     .usage('[options] <keywords>')
     .option('-b, --build <path/to/tutorial.md>', 'tutorial markdown file', /^.+\.md$/i)
     .option('-c, --create <name>', 'tutorial name')
     .option('-p, --publish <version>', 'publish tutorial to npm with new version number')
     .option('-t, --tutorials', 'list of local tutorial packages')
     .option('-s, --search <query>', 'search for tutorial package')
     .option('-r, --run', 'run tutorial')
+    .option('-v, --validate', 'validate tutorial')
     .parse(process.argv);
 update_1.default();
 if (program.build) {
@@ -61,6 +63,11 @@ else if (program.publish) {
     var version = program.args[0];
     publish_1.default(version);
 }
+else if (program.validate) {
+    if (!validate_1.default()) {
+        result_1.fail();
+    }
+}
 else {
     program.help();
 }

lib/validate/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var chalk_1 = require('chalk');
+var packageJson_1 = require('./packageJson');
+var get_1 = require('../packageJson/get');
+function validate() {
+    var pj = get_1.default(process.cwd());
+    if (!pj) {
+        console.log(chalk_1.red('Error: No package.json.'));
+        return false;
+    }
+    var validation = packageJson_1.default(pj);
+    getValidationMessages(validation.warnings, chalk_1.yellow);
+    return getValidationMessages(validation.errors, chalk_1.red);
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = validate;
+function getValidationMessages(validation, color) {
+    if (validation && validation.length) {
+        validation.forEach(function (e) {
+            console.log(color("\n        Error: " + e.name + " " + e.msg + ".\n        Example: " + e.example + "\n      "));
+        });
+        return false;
+    }
+    return true;
+}

lib/validate/packageJson.js

@@ -88,10 +88,10 @@ function validatePackageJson(pj) {
         var target = pj.config ? pj.config : pj;
         if (!target.hasOwnProperty(key.name) || key.validate(target[key.name])) {
             if (!key.optional) {
-                errors.push({ msg: key.msg, example: key.example });
+                errors.push({ name: key.name, msg: key.msg, example: key.example });
             }
             else {
-                warnings.push({ msg: key.msg, example: key.example });
+                warnings.push({ name: key.name, msg: key.msg, example: key.example });
             }
         }
     });

src/cli.ts

@@ -10,18 +10,20 @@ import search from './search';
 import tutorials from './tutorials';
 import publish from './publish';
 import checkForUpdate from './update';
+import validate from './validate';
 
 program
-  .version('0.6.0')
+  .version('0.7.0')
   .usage('[options] <keywords>')
   .option('-b, --build <path/to/tutorial.md>',
-    'tutorial markdown file', /^.+\.md$/i)
+  'tutorial markdown file', /^.+\.md$/i)
   .option('-c, --create <name>', 'tutorial name')
   .option('-p, --publish <version>',
-    'publish tutorial to npm with new version number')
+  'publish tutorial to npm with new version number')
   .option('-t, --tutorials', 'list of local tutorial packages')
   .option('-s, --search <query>', 'search for tutorial package')
   .option('-r, --run', 'run tutorial')
+  .option('-v, --validate', 'validate tutorial')
   .parse(process.argv);
 
 checkForUpdate();
@@ -68,6 +70,12 @@ if (program.build) {
   const version = program.args[0];
   publish(version);
 
+} else if (program.validate) {
+  if (!validate()) {
+    fail();
+  }
+
+  // help
 } else {
   program.help();
 }

src/typings/cr/validate.d.ts

@@ -0,0 +1,17 @@
+interface PJErrors {
+  name: string;
+  msg: string;
+  example: string;
+}
+
+interface PJKeys extends PJErrors {
+  name: string;
+  validate: (content: string) => boolean;
+  config?: boolean;
+  optional?: boolean;
+}
+
+interface ValidatePjOutput {
+  errors: PJErrors[];
+  warnings: PJErrors[];
+}

src/validate/index.ts

@@ -0,0 +1,29 @@
+import {red, yellow} from 'chalk';
+import validatePackageJson from './packageJson';
+import getPackageJson from '../packageJson/get';
+
+export default function validate(): boolean {
+  const pj = getPackageJson(process.cwd());
+  if (!pj) {
+    console.log(red('Error: No package.json.'));
+    return false;
+  }
+  const validation = validatePackageJson(pj);
+  // log warnings
+  getValidationMessages(validation.warnings, yellow);
+  // log and return errors
+  return getValidationMessages(validation.errors, red);
+}
+
+function getValidationMessages(validation: PJErrors[], color: any) {
+  if (validation && validation.length) {
+    validation.forEach((e) => {
+      console.log(color(`
+        Error: ${e.name} ${e.msg}.
+        Example: ${e.example}
+      `));
+    });
+    return false;
+  }
+  return true;
+}

src/validate/packageJson.ts

@@ -81,22 +81,7 @@ const pJKeys: PJKeys[] = [{
     example: 'MIT',
   }];
 
-interface PJErrors {
-  msg: string;
-  example: string;
-}
-
-interface PJKeys extends PJErrors {
-  name: string;
-  validate: (content: string) => boolean;
-  config?: boolean;
-  optional?: boolean;
-}
 
-interface ValidatePjOutput {
-  errors: PJErrors[];
-  warnings: PJErrors[];
-}
 
 export default function validatePackageJson(pj: PackageJson): ValidatePjOutput {
   const errors = [];
@@ -107,9 +92,9 @@ export default function validatePackageJson(pj: PackageJson): ValidatePjOutput {
     // key doesn't exist or key is invalid
     if (!target.hasOwnProperty(key.name) || key.validate(target[key.name])) {
       if (!key.optional) {
-        errors.push({ msg: key.msg, example: key.example });
+        errors.push({ name: key.name, msg: key.msg, example: key.example });
       } else {
-        warnings.push({ msg: key.msg, example: key.example });
+        warnings.push({ name: key.name, msg: key.msg, example: key.example });
       }
     }
   });

tsconfig.json

@@ -50,6 +50,7 @@
   "src/typings/cr/globals.d.ts",
   "src/typings/cr/test.d.ts",
   "src/typings/cr/tutorial.d.ts",
+  "src/typings/cr/validate.d.ts",
   "src/typings/es6-promise/es6-promise.d.ts",
   "src/typings/globals.d.ts",
   "src/typings/node-file-exists/index.d.ts",
@@ -58,6 +59,7 @@
   "src/typings/sort-package-json/index.d.ts",
   "src/typings/tsd.d.ts",
   "src/update/index.ts",
+  "src/validate/index.ts",
   "src/validate/packageJson.ts"
  ],
  "exclude": [