feat: add support for quiet mode

If `--quiet` or `{quiet: true}` is set, webpack-validator won't write to
stdout. This is useful with webpack `--json` option as then you won't
get extra output there.

Closes #69.

Author: bebraw

README.md

@@ -79,6 +79,9 @@ const config = { /* ... your webpack config */ }
 module.exports = validate(config, yourSchema)
 ```
 
+#### Quiet Mode
+If you want to mute console output apart from errors, set `--quiet` or `validate(config, yourSchema, {quiet: true})`. This is particularly useful if you are using webpack `--json` as you'll want to avoid writing additional text to the JSON output.
+
 #### Advanced Usage
 If you need to access the validation results directly and want to control the side-effects (i.e. console.log output, `process.exit(1)` on fail behaviour) yourself, you can call the validation function like so: `validate(config, yourSchema, { returnValidation: true })`. This will make 1) the function return the validation results instead of your configuration and 2) not perform any side effects.
 

src/bin/webpack-validator.js

@@ -1,61 +1,65 @@
-#!/usr/bin/env node
-
-'use strict'
-const fs = require('fs')
-const path = require('path')
-const program = require('commander')
-const log = require('npmlog')
-const validate = require('../')
-const schema = require('../').schema
-let configFile
-
-program
-  .arguments('<configFileName>')
-  .action((configFileName) => {
-    configFile = configFileName
-  })
-program.parse(process.argv)
-
-function errorHandler(err) {
-  if (err.isJoi && err.name === 'ValidationError' && err.annotate) {
-    log.error(err.annotate())
-  } else {
-    log.error(err.message)
-  }
-  process.exit(1)
-}
-
-function validateConfig(webpackConfigFile) {
-  console.log(`Reading: ${webpackConfigFile}`)
-  const config = require(path.join(process.cwd(), webpackConfigFile))
-  const validationResult = validate(config, schema, { returnValidation: true })
-  if (validationResult.error) {
-    console.info(validationResult.error.annotate())
-    process.exit(1)
-  } else {
-    console.info(`${webpackConfigFile} is valid`)
-    process.exit(0)
-  }
-}
-
-if (! configFile) {
-  const error = new Error(['No configuration file given',
-    'Usage: webpack-validator-cli <configFileName>'].join('\n'))
-  error.type = 'EUSAGE'
-  errorHandler(error)
-}
-
-fs.stat(configFile, (err, stats) => {
-  if (err) {
-    err.message = `Could not find file "${configFile}"` // eslint-disable-line no-param-reassign
-    errorHandler(err)
-  } else {
-    if (stats.isFile()) {
-      validateConfig(configFile)
-    } else {
-      const error = new Error(`Could not find file "${configFile}"`)
-      error.type = 'EISDIR'
-      errorHandler(error)
-    }
-  }
-})
+#!/usr/bin/env node
+
+'use strict'
+const fs = require('fs')
+const path = require('path')
+const program = require('commander')
+const log = require('npmlog')
+const validate = require('../')
+const schema = require('../').schema
+let configFile
+
+program
+  .arguments('<configFileName>')
+  .option('-q, --quiet', 'Quiet output')
+  .action((configFileName) => {
+    configFile = configFileName
+  })
+program.parse(process.argv)
+
+function errorHandler(err) {
+  if (err.isJoi && err.name === 'ValidationError' && err.annotate) {
+    log.error(err.annotate())
+  } else {
+    log.error(err.message)
+  }
+  process.exit(1)
+}
+
+function validateConfig(webpackConfigFile, quiet) {
+  if (!quiet) console.log(`Reading: ${webpackConfigFile}`)
+  const config = require(path.join(process.cwd(), webpackConfigFile))
+  const validationResult = validate(config, schema, {
+    returnValidation: true,
+    quiet,
+  })
+  if (validationResult.error) {
+    console.info(validationResult.error.annotate())
+    process.exit(1)
+  } else {
+    if (!quiet) console.info(`${webpackConfigFile} is valid`)
+    process.exit(0)
+  }
+}
+
+if (! configFile) {
+  const error = new Error(['No configuration file given',
+    'Usage: webpack-validator-cli <configFileName>'].join('\n'))
+  error.type = 'EUSAGE'
+  errorHandler(error)
+}
+
+fs.stat(configFile, (err, stats) => {
+  if (err) {
+    err.message = `Could not find file "${configFile}"` // eslint-disable-line no-param-reassign
+    errorHandler(err)
+  } else {
+    if (stats.isFile()) {
+      validateConfig(configFile, program.quiet)
+    } else {
+      const error = new Error(`Could not find file "${configFile}"`)
+      error.type = 'EISDIR'
+      errorHandler(error)
+    }
+  }
+})

src/index.js

@@ -52,6 +52,7 @@ module.exports = function validate(config, schema_ = schema, options = {}) {
   const {
     // Don't return the config object and throw on error, but just return the validation result
     returnValidation, // bool
+    quiet, // bool
   } = options
 
   const validationResult = Joi.validate(config, schema_, { abortEarly: false })
@@ -61,7 +62,11 @@ module.exports = function validate(config, schema_ = schema, options = {}) {
     console.error(validationResult.error.annotate())
     process.exit(1)
   }
-  console.info(chalk.green('[webpack-validator] Config is valid.'))
+
+  if (!quiet) {
+    console.info(chalk.green('[webpack-validator] Config is valid.'))
+  }
+
   return config
 }
 module.exports.schema = schema

src/index.test.js

@@ -44,4 +44,18 @@ describe('.', () => {
     // process.exit should have been called
     assert(processExitStub.callCount === 1)
   })
+
+  it('should allow console output to be muted', () => {
+    validate({}, {}, { quiet: true })
+
+    // The success message should not have been printed
+    assert(consoleInfoStub.callCount === 0)
+
+    // The error message should not have been printed
+    if (consoleErrorStub.callCount !== 0) {
+      throw new Error(consoleErrorStub.args[0])
+    }
+    // process.exit should not have been called
+    assert(processExitStub.callCount === 0)
+  })
 })