Feature/move to shared config (#17)

* version 1.1.0

Error handling if an invalid rule name is included in
`.npmpackagejsonlintrc.json`.

fix typo in README

fix issue resolving file path of `.npmpackagejsonlintrc.json` when
running the cli from a nested directory under `node_modules`

* Update to throw error

- use throw error
- add new unit test to validate exception
- bump version

* Move to shared config

- Extend eslint-config-tc
- Bump grunt-eslint to 19.0.0
- Resolve lint errors related to new rules

* Bump version

* Add v1.2.0 release notes

Author: tclindner

.eslintrc.json

@@ -1,211 +1,3 @@
 {
-  "parserOptions": {
-    "ecmaVersion": 6,
-    "sourceType": "module"
-  },
-  "env": {
-    "node": true,
-    "es6": true,
-    "mocha": true,
-    "jquery": true
-  },
-  "rules": {
-    "comma-dangle": ["error", "never"],
-    "no-cond-assign": ["error", "always"],
-    "no-constant-condition": "error",
-    "no-dupe-args": "error",
-    "no-dupe-keys": "error",
-    "no-duplicate-case": "error",
-    "no-empty": "error",
-    "no-empty-character-class": "error",
-    "no-ex-assign": "error",
-    "no-extra-boolean-cast": "error",
-    "no-extra-parens": ["error", "all", {"conditionalAssign": false}],
-    "no-extra-semi": "error",
-    "no-func-assign": "error",
-    "no-invalid-regexp": ["error", {"allowConstructorFlags": ["u", "y"]}],
-    "no-irregular-whitespace": "error",
-    "no-negated-in-lhs": "error",
-    "no-obj-calls": "error",
-    "no-regex-spaces": "error",
-    "no-sparse-arrays": "error",
-    "no-unreachable": "error",
-    "use-isnan": "error",
-    "valid-jsdoc": "error",
-    "no-unexpected-multiline": "error",
-    "valid-typeof": "error",
-    "accessor-pairs": "error",
-    "array-callback-return": "error",
-    "block-scoped-var": "error",
-    "complexity": "error",
-    "consistent-return": "error",
-    "curly": "error",
-    "default-case": "error",
-    "dot-location": ["error", "property"],
-    "dot-notation": "error",
-    "eqeqeq": "error",
-    "no-caller": "error",
-    "no-case-declarations": "error",
-    "no-div-regex": "error",
-    "no-empty-function": "error",
-    "no-empty-pattern": "error",
-    "no-eq-null": "error",
-    "no-eval": "error",
-    "no-extend-native": "error",
-    "no-extra-bind": "error",
-    "no-extra-label": "error",
-    "no-fallthrough": "error",
-    "no-floating-decimal": "error",
-    "no-implicit-coercion": "error",
-    "no-implicit-globals": "error",
-    "no-implied-eval": "error",
-    "no-invalid-this": "error",
-    "no-iterator": "error",
-    "no-labels": "error",
-    "no-lone-blocks": "error",
-    "no-loop-func": "error",
-    "no-magic-numbers": "error",
-    "no-multi-spaces": "error",
-    "no-multi-str": "error",
-    "no-native-reassign": "error",
-    "no-new": "error",
-    "no-new-func": "error",
-    "no-new-wrappers": "error",
-    "no-octal": "error",
-    "no-octal-escape": "error",
-    "no-param-reassign": "error",
-    "no-proto": "error",
-    "no-redeclare": "error",
-    "no-return-assign": "error",
-    "no-script-url": "error",
-    "no-self-assign": "error",
-    "no-self-compare": "error",
-    "no-sequences": "error",
-    "no-throw-literal": "error",
-    "no-unmodified-loop-condition": "error",
-    "no-unused-expressions": "error",
-    "no-unused-labels": "error",
-    "no-useless-call": "error",
-    "no-useless-concat": "error",
-    "no-useless-escape": "error",
-    "no-void": "error",
-    "no-warning-comments": "error",
-    "no-with": "error",
-    "radix": "error",
-    "vars-on-top": "error",
-    "wrap-iife": ["error", "outside"],
-    "yoda": "error",
-    "no-catch-shadow": "error",
-    "no-delete-var": "error",
-    "no-label-var": "error",
-    "no-shadow": "error",
-    "no-shadow-restricted-names": "error",
-    "no-undef": "error",
-    "no-undefined": "error",
-    "no-use-before-define": "error",
-    "callback-return": "error",
-    "handle-callback-err": "error",
-    "no-mixed-requires": "error",
-    "no-new-require": "error",
-    "no-path-concat": "error",
-    "no-process-env": "error",
-    "no-process-exit": "error",
-    "array-bracket-spacing": ["error", "never"],
-    "brace-style": "error",
-    "camelcase": "error",
-    "comma-spacing": ["error", {"before": false, "after": true}],
-    "comma-style": ["error", "last"],
-    "computed-property-spacing": ["error", "never"],
-    "eol-last": "error",
-    "func-style": ["error", "expression"],
-    "id-length": ["error", {"min": 2, "max": 20}],
-    "indent": ["error", 2],
-    "key-spacing": ["error", {"beforeColon": false, "afterColon": true}],
-    "keyword-spacing": "error",
-    "linebreak-style": ["error", "unix"],
-    "max-depth": ["error", 4],
-    "max-nested-callbacks": ["error", 3],
-    "max-params": ["error", 4],
-    "max-statements": ["error", 12],
-    "max-statements-per-line": ["error", {"max": 1}],
-    "new-cap": "error",
-    "new-parens": "error",
-    "newline-after-var": "error",
-    "newline-before-return": "error",
-    "newline-per-chained-call": ["error", {"ignoreChainWithDepth": 3}],
-    "no-array-constructor": "error",
-    "no-bitwise": "error",
-    "no-continue": "error",
-    "no-inline-comments": "error",
-    "no-lonely-if": "error",
-    "no-mixed-spaces-and-tabs": "error",
-    "no-multiple-empty-lines": ["error", {"max": 2}],
-    "no-negated-condition": "error",
-    "no-nested-ternary": "error",
-    "no-new-object": "error",
-    "no-plusplus": "error",
-    "no-trailing-spaces": "error",
-    "no-unneeded-ternary": "error",
-    "no-whitespace-before-property": "error",
-    "object-curly-spacing": ["error", "never"],
-    "one-var": ["error", "never"],
-    "operator-assignment": ["error", "always"],
-    "padded-blocks": ["error", {"classes": "always"}],
-    "quote-props": ["error", "consistent"],
-    "quotes": ["error", "single"],
-    "require-jsdoc": ["error", {
-      "require": {
-        "FunctionDeclaration": true,
-        "MethodDefinition": true,
-        "ClassDeclaration": false
-      }
-    }],
-    "semi": ["error", "always"],
-    "semi-spacing": ["error", {"before": false, "after": false}],
-    "sort-imports": "error",
-    "sort-vars": "error",
-    "space-before-blocks": ["error", {
-      "functions": "always",
-      "keywords": "always",
-      "classes": "always"
-    }],
-    "space-before-function-paren": ["error", "never"],
-    "space-in-parens": ["error", "never"],
-    "space-unary-ops": [2, {
-      "words": true,
-      "nonwords": false
-    }],
-    "spaced-comment": ["error", "always"],
-    "wrap-regex": "error",
-    "lines-around-comment": ["error", {
-      "allowArrayStart": false,
-      "allowArrayEnd": false,
-      "allowBlockStart": true,
-      "allowBlockEnd": false,
-      "allowObjectStart": false,
-      "allowObjectEnd": false,
-      "afterBlockComment": false,
-      "afterLineComment": false,
-      "beforeBlockComment": true,
-      "beforeLineComment": true
-    }],
-    "arrow-body-style": ["error", "always"],
-    "arrow-parens": ["error", "always"],
-    "arrow-spacing": ["error", {"before": true, "after": true}],
-    "constructor-super": "error",
-    "no-class-assign": "error",
-    "no-confusing-arrow": ["error", {"allowParens": true}],
-    "no-const-assign": "error",
-    "no-dupe-class-members": "error",
-    "no-duplicate-imports": "error",
-    "no-new-symbol": "error",
-    "no-this-before-super": "error",
-    "no-useless-constructor": "error",
-    "no-var": "error",
-    "object-shorthand": "error",
-    "prefer-const": "error",
-    "prefer-rest-params": "error",
-    "prefer-template": "error",
-    "template-curly-spacing": "error"
-  }
+  "extends": "eslint-config-tc"
 }

CHANGELOG.md

@@ -11,6 +11,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Removed
 
+## [1.2.0] - 2016-07-26
+### Changed
+- Bump grunt-eslint to version 19.0.0
+- Move to shared eslint-config-tc module
+
 ## [1.1.0] - 2016-07-17
 ### Added
 - Error handling if an invalid rule name is included in `.npmpackagejsonlintrc.json`.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-package-json-lint",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "CLI app for linting package.json files.",
   "keywords": [
     "lint",
@@ -33,14 +33,16 @@
     "validator": "^5.1.0"
   },
   "devDependencies": {
+    "eslint": "^3.1.1",
+    "eslint-config-tc": "^1.1.0",
     "eslint-formatter-pretty": "^0.2.1",
     "grunt": "^1.0.1",
     "grunt-bump": "^0.8.0",
     "grunt-contrib-clean": "^1.0.0",
     "grunt-contrib-copy": "^1.0.0",
     "grunt-contrib-watch": "^1.0.0",
     "grunt-env": "^0.4.4",
-    "grunt-eslint": "^18.1.0",
+    "grunt-eslint": "^19.0.0",
     "grunt-istanbul": "^0.7.0",
     "grunt-istanbul-coverage": "^0.1.4",
     "grunt-jscs": "^2.8.0",

src/Config.js

@@ -20,8 +20,6 @@ class Config {
       'no-restricted-pre-release-dependencies',
       'no-restricted-pre-release-devDependencies'
     ];
-    this.firstKey = 0;
-    this.secondKey = 1;
 
     if (this._isConfigPassed(passedConfigParam)) {
       const passedConfig = this._getPassedConfig(passedConfigParam);
@@ -86,21 +84,30 @@ class Config {
       const ruleConfig = rcFileObj[rule];
 
       if (Array.isArray(ruleConfig) && inArray(this.arrayRules, rule)) {
-        if (typeof ruleConfig[this.firstKey] !== 'string' || typeof ruleConfig[this.firstKey] === 'string' && ruleConfig[this.firstKey] !== 'error' && ruleConfig[this.firstKey] !== 'warning') {
-          throw new Error(`${rule} - first key must be set to "error" or "warning". Currently set to ${ruleConfig[this.firstKey]}`);
+        if (typeof ruleConfig[0] !== 'string' || this._isRuleValid(ruleConfig[0])) {
+          throw new Error(`${rule} - first key must be set to "error" or "warning". Currently set to ${ruleConfig[0]}`);
         }
 
-        if (!Array.isArray(ruleConfig[this.secondKey])) {
-          throw new Error(`${rule} - second key must be set an array. Currently set to ${ruleConfig[this.secondKey]}`);
+        if (!Array.isArray(ruleConfig[1])) {
+          throw new Error(`${rule} - second key must be set an array. Currently set to ${ruleConfig[1]}`);
         }
-      } else if (typeof ruleConfig !== 'string' || typeof ruleConfig === 'string' && ruleConfig !== 'error' && ruleConfig !== 'warning') {
+      } else if (typeof ruleConfig !== 'string' || this._isRuleValid(ruleConfig)) {
         throw new Error(`${rule} - must be set to "error" or "warning". Currently set to ${ruleConfig}`);
       }
     }
 
     return true;
   }
 
+  /**
+   * Validates the first key of an array type rule
+   * @param  {String}  key Error type of the rule
+   * @return {Boolean}     True if the rule is valid. False if the rule is invalid.
+   */
+  _isRuleValid(key) {
+    return typeof key === 'string' && key !== 'error' && key !== 'warning';
+  }
+
 }
 
 module.exports = Config;

src/NpmPackageJsonLint.js

@@ -18,8 +18,6 @@ class NpmPackageJsonLint {
     this.packageJsonData = packageJsonData;
     this.ignoreWarnings = options.ignoreWarnings;
     this.arrayRuleTypes = ['valid-values', 'no-restricted-dependencies', 'no-restricted-pre-release-dependencies'];
-    this.firstKey = 0;
-    this.secondKey = 1;
     this.errors = [];
     this.warnings = [];
 
@@ -38,8 +36,8 @@ class NpmPackageJsonLint {
       const ruleModule = this.rules.get(rule);
 
       if (inArray(this.arrayRuleTypes, ruleModule.ruleType)) {
-        const errorWarningSetting = this.config[rule][this.firstKey];
-        const ruleConfigArray = this.config[rule][this.secondKey];
+        const errorWarningSetting = this.config[rule][0];
+        const ruleConfigArray = this.config[rule][1];
         const lintResult = ruleModule.lint(this.packageJsonData, errorWarningSetting, ruleConfigArray);
 
         this._processResult(lintResult, errorWarningSetting);

tests/unit/validators/dependency-auditTest.js

@@ -1,6 +1,6 @@
 'use strict';
 
-/* eslint max-nested-callbacks: "off" */
+/* eslint max-nested-callbacks: "off", max-lines: "off" */
 
 const should = require('should');
 const requireHelper = require('../../require_helper');