docs: improve verbose description

README.md

@@ -72,8 +72,9 @@ Options:
   -r, --relative                     pass relative filepaths to tasks (default: false)
   -x, --shell                        skip parsing of tasks for better shell support (default:
                                      false)
-  -v, --verbose                      always show task output (default: false)
-  -h, --help                         output usage information
+  -v, --verbose                      show task output even when tasks succeed; by default only
+                                     failed output is shown (default: false)
+  -h, --help                         display help for command
 ```
 
 - **`--allow-empty`**: By default, when linter tasks undo all staged changes, lint-staged will exit with an error and abort the commit. Use this flag to allow creating empty git commits.

bin/lint-staged.js

@@ -40,7 +40,11 @@ cmdline
   .option('-q, --quiet', 'disable lint-staged’s own console output', false)
   .option('-r, --relative', 'pass relative filepaths to tasks', false)
   .option('-x, --shell', 'skip parsing of tasks for better shell support', false)
-  .option('-v, --verbose', 'always show task output', false)
+  .option(
+    '-v, --verbose',
+    'show task output even when tasks succeed; by default only failed output is shown',
+    false
+  )
   .parse(process.argv)
 
 if (cmdline.debug) {

lib/index.js

@@ -55,7 +55,7 @@ function loadConfig(configPath) {
  * @param {boolean} [options.relative] - Pass relative filepaths to tasks
  * @param {boolean} [options.shell] - Skip parsing of tasks for better shell support
  * @param {boolean} [options.stash] - Enable the backup stash, and revert in case of errors
- * @param {boolean} [options.verbose] - Always show task output
+ * @param {boolean} [options.verbose] - Show task output even when tasks succeed; by default only failed output is shown
  * @param {Logger} [logger]
  *
  * @returns {Promise<boolean>} Promise of whether the linting passed or failed

lib/runAll.js

@@ -46,11 +46,11 @@ const createError = (ctx) => Object.assign(new Error('lint-staged failed'), { ct
  * @param {Object} [options.cwd] - Current working directory
  * @param {boolean} [options.debug] - Enable debug mode
  * @param {number} [options.maxArgLength] - Maximum argument string length
- * @param {boolean} [options.verbose] - Always show task output
  * @param {boolean} [options.quiet] - Disable lint-staged’s own console output
  * @param {boolean} [options.relative] - Pass relative filepaths to tasks
  * @param {boolean} [options.shell] - Skip parsing of tasks for better shell support
  * @param {boolean} [options.stash] - Enable the backup stash, and revert in case of errors
+ * @param {boolean} [options.verbose] - Show task output even when tasks succeed; by default only failed output is shown
  * @param {Logger} logger
  * @returns {Promise}
  */