2.0.0 (#22)

* Add node 7 to travis build list

* Alter coverage check to exclude require method

* Remove grunt watch, bump deps, and move to 2.0.0

* Add extends support and add new severity cli option

* Remove default config

* Update docs and changelog

* Remove reference to old default config

Author: tclindner

.travis.yml

@@ -13,6 +13,7 @@ node_js:
   - "4"
   - "5"
   - "6"
+  - "7"
 
 cache:
   directories:

CHANGELOG.md

@@ -11,6 +11,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Removed
 
+## [2.0.0] - 2017-02-18
+### Added
+- Support configuration extension!! Now you can add "extends" to your rc file to extend a based configuration. This is great for sharing a standard ruleset between many projects.  Please see the [wiki](https://github.com/tclindner/npm-package-json-lint/wiki) for more information.
+- An optional cli flag for controlling rule severity. Please see the [README.md](README.md) for examples.
+
+### Removed
+- Default configuration is no longer provided. Please see the new default config module, [npm-package-json-lint-config-default](https://github.com/tclindner/npm-package-json-lint-config-default)
+
 ## [1.4.0] - 2016-10-15
 ### Added
 - New rule: [valid-values-license](https://github.com/tclindner/npm-package-json-lint/wiki/valid-values-license)

README.md

@@ -53,10 +53,13 @@ First thing first, let's make sure you have the necessary pre-requisites.
 ### Examples
 
 Run a specific rule, require-author, on a file relative to the current working directory.
-`pjl-cli -f "../relative-path/package.json" -r "require-author: 'error'"`
+`pjl-cli -f "../relative-path/package.json" -r "require-author"`
 
 Run a specific rule, require-author, ignoring warnings on a file relative to the current working directory.
-`pjl-cli -f "../relative-path/package.json" -r "require-author: 'error'" --ignore-warnings`
+`pjl-cli -f "../relative-path/package.json" -r "require-author" --ignore-warnings`
+
+Run a specific rule, require-author, set severity to warning on a file relative to the current working directory.
+`pjl-cli -f "../relative-path/package.json" -r "require-author" -s "warning"`
 
 Run using the config in `.npmpackagejsonlintrc` on a file relative to the current working directory.
 `pjl-cli -f "../relative-path/package.json" -c "./.npmpackagejsonlintrc"`
@@ -66,7 +69,7 @@ Run using the default config on a file relative to the current working directory
 
 ## Lint Rules
 
-npm-package-json-lint has a configurable set of rules. Please see the [wiki](https://github.com/tclindner/npm-package-json-lint/wiki) for a full list of available rules. By [default](src/defaultConfig.js) only type checks and name/version rules are enforced. This is the bare minimum configuration.
+npm-package-json-lint has a configurable set of rules. Please see the [wiki](https://github.com/tclindner/npm-package-json-lint/wiki) for a full list of available rules. By default no rules are enabled. If you would like to use npm-package-json-lint's default ruleset, please see [npm-package-json-lint-config-default](https://github.com/tclindner/npm-package-json-lint-config-default).
 
 Each rule contains the following properties:
 
@@ -75,17 +78,22 @@ Each rule contains the following properties:
   3. Message - example: author is required
   4. Rule Type - example: required
 
-As mentioned in the "Commands and configuration" section there are two ways to specify rule sets. The first is using `--rule` to specify a given rule. This will run npm-package-json-lint with just this rule. The second is using `--rules-file` to specify a JSON file, named [`.npmpackagejsonlintrc`](https://github.com/tclindner/npm-package-json-lint/wiki/npm-package-json-lint-rc), to run a set of rules. If neither of the options above are specified then npm-package-json-lint looks for a global [`.npmpackagejsonlintrc`](https://github.com/tclindner/npm-package-json-lint/wiki/npm-package-json-lint-rc) file in the root of your user directory. Finally, if a global [`.npmpackagejsonlintrc`](https://github.com/tclindner/npm-package-json-lint/wiki/npm-package-json-lint-rc) file doesn't exist then the [defaults](src/defaultConfig.js) are used.
+As mentioned in the "Commands and configuration" section there are two ways to specify rule sets. The first is using `--rule` to specify a given rule. This will run npm-package-json-lint with just this rule. The second is using `--rules-file` to specify a JSON file, named [`.npmpackagejsonlintrc`](https://github.com/tclindner/npm-package-json-lint/wiki/npm-package-json-lint-rc), to run a set of rules. If neither of the options above are specified then npm-package-json-lint looks for a global [`.npmpackagejsonlintrc`](https://github.com/tclindner/npm-package-json-lint/wiki/npm-package-json-lint-rc) file in the root of your user directory.
 
 ### Configuring rules
 
-npm-package-json-lint rules can either be run as an `error` or a `warning`.
+npm-package-json-lint rules can either be run as an `error`, `warning`, or `off`.
 
 * "warning" - run the rule as a warning
 * "error" - run the rule as an error
+* "off" - disables the rule
 
 Ex: `"require-author": "error"`
 
+## Migrating from v10.x.x to 2.x.x
+
+Please see the [migration guide](https://github.com/tclindner/npm-package-json-lint/wiki/migrating-from-v1-to-v2).
+
 ## Migrating from v0.x.x to 1.x.x
 
 Please see the [migration guide](https://github.com/tclindner/npm-package-json-lint/wiki/migrating-from-v0-to-v1).
@@ -101,6 +109,7 @@ Please see [CHANGELOG.md](CHANGELOG.md).
 ## Related
 
 * [grunt-npm-package-json-lint](https://github.com/tclindner/grunt-npm-package-json-lint): Grunt Wrapper for npm-package-json-lint
+* [npm-package-json-lint-config-default](https://github.com/tclindner/npm-package-json-lint-config-default): Shared default configuration module for npm-package-json-lint
 
 ## License
 

grunt/coverage-check.js

@@ -6,9 +6,9 @@ module.exports = function(grunt) {
       options: {
         thresholds: {
           statements: 100,
-          branches: 98,
+          branches: 99,
           lines: 100,
-          functions: 100
+          functions: 99
         },
         dir: 'coverage',
         root: 'tests'

grunt/watch.js

@@ -1,6 +1,6 @@
 {
   "name": "npm-package-json-lint",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "CLI app for linting package.json files.",
   "keywords": [
     "lint",
@@ -24,33 +24,32 @@
   },
   "main": "src/NpmPackageJsonLint.js",
   "dependencies": {
-    "chalk": "^1.1.1",
+    "chalk": "^1.1.3",
     "commander": "^2.9.0",
     "in-array": "^0.1.2",
     "is-plain-obj": "^1.1.0",
     "semver": "^5.3.0",
     "user-home": "^2.0.0",
-    "validator": "^6.0.0"
+    "validator": "^6.2.1"
   },
   "devDependencies": {
-    "eslint": "^3.7.1",
-    "eslint-config-tc": "^1.2.0",
+    "eslint": "^3.15.0",
+    "eslint-config-tc": "^1.4.0",
     "eslint-formatter-pretty": "^1.0.0",
     "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": "^19.0.0",
-    "grunt-istanbul": "^0.7.1",
+    "grunt-istanbul": "^0.7.2",
     "grunt-istanbul-coverage": "^0.1.4",
     "grunt-jscs": "^3.0.1",
     "grunt-jsonlint": "^1.1.0",
     "grunt-mocha-test": "^0.13.2",
-    "mocha": "^3.1.0",
-    "should": "^11.1.0",
-    "sinon": "^1.17.5",
+    "mocha": "^3.2.0",
+    "should": "^11.2.0",
+    "sinon": "^1.17.7",
     "time-grunt": "^1.4.0"
   },
   "engines": {

package.json

@@ -21,22 +21,26 @@ class Config {
       'no-restricted-pre-release-devDependencies'
     ];
 
-    if (this._isConfigPassed(passedConfigParam)) {
-      const passedConfig = this._getPassedConfig(passedConfigParam);
-
-      this.config = Object.assign({}, passedConfig);
-    } else {
-      this.defaultConfig = require('./defaultConfig');
-      this.config = Object.assign({}, this.defaultConfig);
-    }
+    this.passedConfigParam = passedConfigParam;
   }
 
   /**
    * Gets the config
    * @return {Object} Config object
    */
   get() {
-    return this.config;
+    if (this._isConfigPassed(this.passedConfigParam)) {
+      const passedConfig = this._getPassedConfig(this.passedConfigParam);
+      let extendsConfig = {};
+
+      if (passedConfig.hasOwnProperty('extends')) {
+        extendsConfig = this._getExtendsConfig(passedConfig.extends);
+      }
+
+      return Object.assign({}, extendsConfig, passedConfig.rules);
+    } else {
+      throw new Error('No configuration passed');
+    }
   }
 
   /**
@@ -75,24 +79,62 @@ class Config {
   }
 
   /**
-   * Validates config file
-   * @param  {Object}     rcFileObj   Object version of .npmpackagejsonlintrc file
-   * @return {boolean}                True if validate config is successful
+   * Gets configuration from a extends config module
+   * @param  {String} moduleName  Name of the configuration module
+   * @return {Object}             Configuration object
+   */
+  _getExtendsConfig(moduleName) {
+    const configObj = this._getExtendsConfigModule(moduleName);
+
+    this._validateConfig(configObj);
+
+    return configObj.rules;
+  }
+
+  /**
+   * Loads extends config module
+   * @param  {String} moduleName  Name of the configuration module
+   * @return {Object}             Configuration object
+   */
+  _getExtendsConfigModule(moduleName) {
+    /* istanbul ignore next */
+    return require(moduleName);
+  }
+
+  /**
+   * Validates config object
+   * @param  {Object} rcFileObj   Object version of .npmpackagejsonlintrc file
+   * @return {boolean}            True if validate config is successful
    */
   _validateConfig(rcFileObj) {
-    for (const rule in rcFileObj) {
-      const ruleConfig = rcFileObj[rule];
+    if (rcFileObj.hasOwnProperty('rules')) {
+      this._validateRulesConfig(rcFileObj.rules);
+    } else {
+      throw new Error('`rules` object missing in config');
+    }
+
+    return true;
+  }
+
+  /**
+   * Validates rules object
+   * @param  {Object}     rulesObj   Object version of .npmpackagejsonlintrc file
+   * @return {boolean}               True if validate config is successful
+   */
+  _validateRulesConfig(rulesObj) {
+    for (const rule in rulesObj) {
+      const ruleConfig = rulesObj[rule];
 
       if (Array.isArray(ruleConfig) && inArray(this.arrayRules, rule)) {
         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]}`);
+          throw new Error(`${rule} - first key must be set to "error", "warning", or "off". Currently set to ${ruleConfig[0]}`);
         }
 
         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' || this._isRuleValid(ruleConfig)) {
-        throw new Error(`${rule} - must be set to "error" or "warning". Currently set to ${ruleConfig}`);
+        throw new Error(`${rule} - must be set to "error", "warning", or "off". Currently set to ${ruleConfig}`);
       }
     }
 
@@ -105,7 +147,7 @@ class Config {
    * @return {Boolean}     True if the rule is valid. False if the rule is invalid.
    */
   _isRuleValid(key) {
-    return typeof key === 'string' && key !== 'error' && key !== 'warning';
+    return typeof key === 'string' && key !== 'error' && key !== 'warning' && key !== 'off';
   }
 
 }

src/Config.js

@@ -22,30 +22,34 @@ class NpmPackageJsonLint {
     this.warnings = [];
 
     this.rules = new Rules();
-    this._loadRules();
-
-    this.config = this._getConfig(config);
+    this.rules.load();
+    this.config = config;
   }
 
   /**
    * Main execution method for package json lint.
    * @return {Object} Results object
    */
   lint() {
-    for (const rule in this.config) {
+    const configObj = this._getConfig(this.config);
+
+    for (const rule in configObj) {
       const ruleModule = this.rules.get(rule);
 
       if (inArray(this.arrayRuleTypes, ruleModule.ruleType)) {
-        const errorWarningSetting = this.config[rule][0];
-        const ruleConfigArray = this.config[rule][1];
-        const lintResult = ruleModule.lint(this.packageJsonData, errorWarningSetting, ruleConfigArray);
+        const errorWarningOffSetting = configObj[rule][0];
+        const ruleConfigArray = configObj[rule][1];
+
+        if (errorWarningOffSetting !== 'off') {
+          this._processResult(ruleModule.lint(this.packageJsonData, errorWarningOffSetting, ruleConfigArray), errorWarningOffSetting);
+        }
 
-        this._processResult(lintResult, errorWarningSetting);
       } else {
-        const errorWarningSetting = this.config[rule];
-        const lintResult = ruleModule.lint(this.packageJsonData, errorWarningSetting);
+        const errorWarningOffSetting = configObj[rule];
 
-        this._processResult(lintResult, errorWarningSetting);
+        if (errorWarningOffSetting !== 'off') {
+          this._processResult(ruleModule.lint(this.packageJsonData, errorWarningOffSetting), errorWarningOffSetting);
+        }
       }
     }
 
@@ -84,14 +88,6 @@ class NpmPackageJsonLint {
     return result;
   }
 
-  /**
-   * Private method for loading rules
-   * @return {undefined}            No return
-   */
-  _loadRules() {
-    this.rules.load();
-  }
-
   /**
    * Private method for loading config
    * @param  {Object|String} config   Object or string with desired configuration

src/NpmPackageJsonLint.js

@@ -12,6 +12,7 @@ const Reporter = require('./Reporter');
 const userHome = require('user-home');
 
 const DEFAULT_FILE_NAME = './package.json';
+const DEFAULT_RULE_SEVERITY = 'error';
 const RC_FILE_NAME = '.npmpackagejsonlintrc';
 
 /**
@@ -32,6 +33,7 @@ cliApp.version(pkg.version);
 cliApp.usage(pkg.name);
 cliApp.option('-f, --file <filePath>', `File path including name. Defaults to ${DEFAULT_FILE_NAME}`, DEFAULT_FILE_NAME);
 cliApp.option('-r, --rule <rule name>', 'Valid rule name to check. Defaults to nothing');
+cliApp.option('-s, --rule-severity <rule severity>', `"error" or "warning". Defaults to ${DEFAULT_RULE_SEVERITY}`, DEFAULT_RULE_SEVERITY);
 cliApp.option('-c, --rules-file <filePath>', 'File path of .npmpackagejsonlintrc');
 cliApp.option('-w, --ignore-warnings', 'Ignore warnings');
 cliApp.parse(process.argv);
@@ -52,7 +54,10 @@ let rulesLoaded = false;
 let rulesConfig = {};
 
 if (typeof cliApp.rule !== 'undefined') {
-  rulesConfig[cliApp.rule] = true;
+  const rules = {};
+
+  rules[cliApp.rule] = cliApp.ruleSeverity;
+  rulesConfig.rules = rules;
   rulesLoaded = true;
 }