include warnings in packageJson validator

Author: ShMcK

lib/index.js

@@ -11,5 +11,5 @@ var tutorials_1 = require('./tutorials');
 exports.tutorials = tutorials_1.default;
 var update_1 = require('./update');
 exports.update = update_1.default;
-var name_1 = require('./validate/name');
-exports.validateName = name_1.default;
+var packageJson_1 = require('./validate/packageJson');
+exports.validatePackageJson = packageJson_1.default;

lib/validate/packageJson.js

@@ -56,16 +56,49 @@ var pJKeys = [{
         validate: function (runner) { return typeof runner === 'string' && runner.length; },
         msg: 'must specify a test runner',
         example: 'mocha-coderoad',
+    }, {
+        name: 'repository',
+        optional: true,
+        validate: function (repo) {
+            return typeof repo === 'string' && repo.length ||
+                typeof repo === 'object' && repo.hasOwnProperty('type')
+                    && typeof repo.type === 'string' &&
+                    repo.hasOwnProperty('url') && typeof repo.url === 'string';
+        },
+        msg: 'should have a valid repository',
+        example: 'https://github.com/shmck/coderoad-tutorial-name',
+    }, {
+        name: 'bugs',
+        optional: true,
+        validate: function (bugs) { return typeof bugs === 'object' &&
+            bugs.hasOwnProperty('url') && typeof bugs.url === 'string'; },
+        msg: 'should have a link to where to post bugs',
+        example: '"bugs": { "url": "https://github.com/shmck/coderoad-tutorial-name" }'
+    }, {
+        name: 'license',
+        optional: true,
+        validate: function (license) { return typeof license === 'string' && license.length; },
+        msg: 'should have a valid license (ex: MIT, ISC, etc.)',
+        example: 'MIT',
     }];
 function validatePackageJson(pj) {
     var errors = [];
+    var warnings = [];
     pJKeys.forEach(function (key) {
         var target = pj.config ? pj.config : pj;
         if (!target.hasOwnProperty(key.name) || key.validate(target[key.name])) {
-            errors.push({ msg: key.msg, example: key.example });
+            if (!key.optional) {
+                errors.push({ msg: key.msg, example: key.example });
+            }
+            else {
+                warnings.push({ msg: key.msg, example: key.example });
+            }
         }
     });
-    return errors;
+    return {
+        errors: errors,
+        warnings: warnings,
+    };
 }
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = validatePackageJson;

src/index.ts

@@ -5,4 +5,4 @@ export {default as search} from './search';
 export {default as tutorials} from './tutorials';
 export {default as update} from './update';
 
-export {default as validateName} from './validate/name';
+export {default as validatePackageJson} from './validate/packageJson';

src/validate/packageJson.ts

@@ -55,6 +55,30 @@ const pJKeys: PJKeys[] = [{
     validate: runner => typeof runner === 'string' && runner.length,
     msg: 'must specify a test runner',
     example: 'mocha-coderoad',
+  }, {
+    name: 'repository',
+    optional: true,
+    validate: (repo: string | { type: string, url: string }) => {
+      return typeof repo === 'string' && repo.length ||
+        typeof repo === 'object' && repo.hasOwnProperty('type')
+        && typeof repo.type === 'string' &&
+        repo.hasOwnProperty('url') && typeof repo.url === 'string';
+    },
+    msg: 'should have a valid repository',
+    example: 'https://github.com/shmck/coderoad-tutorial-name',
+  }, {
+    name: 'bugs',
+    optional: true,
+    validate: (bugs: { url: string }) => typeof bugs === 'object' &&
+      bugs.hasOwnProperty('url') && typeof bugs.url === 'string',
+    msg: 'should have a link to where to post bugs',
+    example: '"bugs": { "url": "https://github.com/shmck/coderoad-tutorial-name" }'
+  }, {
+    name: 'license',
+    optional: true,
+    validate: license => typeof license === 'string' && license.length,
+    msg: 'should have a valid license (ex: MIT, ISC, etc.)',
+    example: 'MIT',
   }];
 
 interface PJErrors {
@@ -66,17 +90,31 @@ 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): PJErrors[] {
+export default function validatePackageJson(pj: PackageJson): ValidatePjOutput {
   const errors = [];
+  const warnings = [];
   pJKeys.forEach(key => {
     // key on pj or pj.config
     const target = pj.config ? pj.config : pj;
     // key doesn't exist or key is invalid
     if (!target.hasOwnProperty(key.name) || key.validate(target[key.name])) {
-      errors.push({ msg: key.msg, example: key.example });
+      if (!key.optional) {
+        errors.push({ msg: key.msg, example: key.example });
+      } else {
+        warnings.push({ msg: key.msg, example: key.example });
+      }
     }
   });
-  return errors;
+  return {
+    errors,
+    warnings,
+  };
 }