Add quiet cli option (#32)

* Add quiet cli option

Fixes #30
Bump version to 2.2.0
Add new quiet (-q) option to cli that suppresses output if no errors
are found
Add tests for the CLI!!

* Update changelog with quiet cli feature

Author: tclindner

CHANGELOG.md

@@ -11,6 +11,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Removed
 
+## [2.2.0] - 2017-04-12
+### Added
+- Add new quiet (-q) option to cli that suppresses output if no errors
+
 ## [2.1.2] - 2017-04-10
 ### Fixed
 - Array style rules, like `valid-values-author`, so they can be easily turned off by setting `valid-values-author: 'off'`

README.md

@@ -49,6 +49,7 @@ First thing first, let's make sure you have the necessary pre-requisites.
 | pjl-cli --rule <rule name> | -r | Valid rule name to check. Defaults to nothing |
 | pjl-cli --rules-file <file path> | -c | File path of .npmpackagejsonlintrc |
 | pjl-cli --rule-severity <rule severity> | -s | "error" or "warning". Defaults to "error" |
+| pjl-cli --quiet | -q | Report errors only |
 | pjl-cli --ignore-warnings | -w | Ignore warnings |
 
 ### Examples

grunt/mocha.js

@@ -3,7 +3,8 @@ module.exports = function(grunt) {
   grunt.config('mochaTest', {
     local: {
       options: {
-        reporter: 'spec'
+        reporter: 'spec',
+        timeout: 5000
       },
       src: ['tests/unit/**/*.js']
     }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-package-json-lint",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "CLI app for linting package.json files.",
   "keywords": [
     "lint",

src/cli.js

@@ -28,13 +28,26 @@ const handleError = function(err) {
   throw new Error(err);
 };
 
+/**
+ * Helper function to determine if output should be logged
+ *
+ * @param {boolean}  quietFlag Flag indicating if output should be logged if no error occur
+ * @param {boolean}  hasErrors True if the linter found errors. False if it didn't.
+ * @return {boolean}           True if the message should be logged. False if the message shouldn't be logged.
+ */
+const shouldLogOutput = function(quietFlag, hasErrors) {
+  /* eslint no-extra-parens: "off" */
+  return !quietFlag || (quietFlag && hasErrors);
+};
+
 // configure cli options
 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('-q, --quiet', 'Report errors only');
 cliApp.option('-w, --ignore-warnings', 'Ignore warnings');
 cliApp.parse(process.argv);
 
@@ -90,21 +103,28 @@ try {
   const npmPackageJsonLint = new NpmPackageJsonLint(fileData, rulesConfig, options);
   const output = npmPackageJsonLint.lint();
   const reporter = new Reporter();
+  let hasErrors = false;
 
   for (const issueType in output) {
     const issues = output[issueType];
 
     if (issues.length > noIssues && issueType === 'errors') {
       exitCode = issuesDetectedErrorCode;
+      hasErrors = true;
     }
 
-    reporter.write(output[issueType], issueType);
+    if (shouldLogOutput(cliApp.quiet, hasErrors)) {
+      reporter.write(output[issueType], issueType);
+    }
   }
 
   const formattedFileName = chalk.bold.green(filePath);
 
   process.exitCode = exitCode;
-  console.log(`${formattedFileName} check complete`);
+
+  if (shouldLogOutput(cliApp.quiet, hasErrors)) {
+    console.log(`${formattedFileName} check complete`);
+  }
 } catch (err) {
   handleError(err);
 }

tests/fixtures/errors/.npmpackagejsonlintrc.json

@@ -0,0 +1,25 @@
+{
+  "rules": {
+    "require-author": "error",
+    "require-description": "error",
+    "require-devDependencies": "error",
+    "require-homepage": "error",
+    "require-keywords": "error",
+    "require-name": "error",
+    "require-repository": "error",
+    "require-scripts": "error",
+    "require-version": "error",
+    "description-type": "error",
+    "devDependencies-type": "error",
+    "homepage-type": "error",
+    "keywords-type": "error",
+    "name-type": "error",
+    "repository-type": "error",
+    "version-type": "error",
+    "valid-values-author": ["error", [
+      "Thomas Lindner"
+    ]],
+    "name-format": "error",
+    "version-format": "error"
+  }
+}

tests/fixtures/errors/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "npm-package-json-lint",
+  "version": "0.1.0",
+  "description": "CLI app for linting package.json files.",
+  "keywords": [
+    "lint"
+  ],
+  "homepage": "https://github.com/tclindner/npm-package-json-lint",
+  "author": "Thomas Lindner",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tclindner/npm-package-json-lint"
+  },
+  "devDependencies": {
+    "mocha": "^2.4.5"
+  }
+}

tests/fixtures/errorsAndWarnings/.npmpackagejsonlintrc.json

@@ -0,0 +1,26 @@
+{
+  "rules": {
+    "require-author": "error",
+    "require-description": "error",
+    "require-devDependencies": "error",
+    "require-homepage": "error",
+    "require-keywords": "error",
+    "require-license": "warning",
+    "require-name": "error",
+    "require-repository": "error",
+    "require-scripts": "error",
+    "require-version": "error",
+    "description-type": "error",
+    "devDependencies-type": "error",
+    "homepage-type": "error",
+    "keywords-type": "error",
+    "name-type": "error",
+    "repository-type": "error",
+    "version-type": "error",
+    "valid-values-author": ["error", [
+      "Thomas Lindner"
+    ]],
+    "name-format": "error",
+    "version-format": "error"
+  }
+}

tests/fixtures/errorsAndWarnings/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "npm-package-json-lint",
+  "version": "0.1.0",
+  "description": "CLI app for linting package.json files.",
+  "keywords": [
+    "lint"
+  ],
+  "homepage": "https://github.com/tclindner/npm-package-json-lint",
+  "author": "Thomas Lindner",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tclindner/npm-package-json-lint"
+  },
+  "devDependencies": {
+    "mocha": "^2.4.5"
+  }
+}

tests/fixtures/valid/.npmpackagejsonlintrc.json

@@ -0,0 +1,24 @@
+{
+  "rules": {
+    "require-author": "error",
+    "require-description": "error",
+    "require-devDependencies": "error",
+    "require-homepage": "error",
+    "require-keywords": "error",
+    "require-name": "error",
+    "require-repository": "error",
+    "require-version": "error",
+    "description-type": "error",
+    "devDependencies-type": "error",
+    "homepage-type": "error",
+    "keywords-type": "error",
+    "name-type": "error",
+    "repository-type": "error",
+    "version-type": "error",
+    "valid-values-author": ["error", [
+      "Thomas Lindner"
+    ]],
+    "name-format": "error",
+    "version-format": "error"
+  }
+}