Output progress to stdout (disable via noProgress property in .markdownlint-cli2.jsonc).

DavidAnson · DavidAnson · commit bb7c4ddf563c · 2020-09-01T13:45:54.000-07:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -109,7 +109,7 @@
     "unicorn/no-null": "off",
     "unicorn/no-object-as-default-parameter": "error",
     "unicorn/no-process-exit": "error",
-    "unicorn/no-reduce": "error",
+    "unicorn/no-reduce": "off",
     "unicorn/no-unreadable-array-destructuring": "error",
     "unicorn/no-unsafe-regex": "error",
     "unicorn/no-unused-properties": "error",
diff --git a/README.md b/README.md
@@ -141,15 +141,18 @@ $ markdownlint-cli2 "**/*.md" "#node_modules"
   - `noInlineConfig`: `Boolean` value to disable the support of
     [HTML comments][html-comment] within Markdown content
     - For example: `<!-- markdownlint-disable some-rule -->`
+  - `noProgress`: `Boolean` value to disable the display of progress on `stdout`
+    - This top-level setting is valid **only** in the directory from which
+      `markdownlint-cli2` is run
   - `outputFormatters`: `Array` of `Array`s, each of which has a `String`
     naming a [markdownlint-cli2-formatter][markdownlint-cli2-formatter] followed
       by parameters
     - Formatters can be used to customize the tool's output for different
       scenarios
     - Relative paths are resolved based on the location of the `JSONC` file
     - For example: `[ [ "formatter-name", param_0, param_1, ... ], ... ]`
-    - This setting affects output for the entire pass, so is valid **only** in
-      the directory from which `markdownlint-cli2` is run
+    - This top-level setting is valid **only** in the directory from which
+      `markdownlint-cli2` is run
 - Settings in this file apply to the directory it is in and all subdirectories.
 - Settings **merge with** those applied by any versions of this file in a parent
   directory.
diff --git a/markdownlint-cli2.js b/markdownlint-cli2.js
@@ -186,8 +186,12 @@ $ ${name} "**/*.md" "#node_modules"`
     map(negateGlob);
   appendToArray(globPatterns, ignorePatterns);
   delete baseMarkdownlintOptions.ignores;
+  const showProgress = !baseMarkdownlintOptions.noProgress;
 
   // Enumerate files from globs and build directory info list
+  if (showProgress) {
+    logMessage(`Finding: ${globPatterns.join(" ")}`);
+  }
   for await (const file of globby.stream(globPatterns)) {
     // @ts-ignore
     const dir = path.dirname(file);
@@ -280,6 +284,10 @@ $ ${name} "**/*.md" "#node_modules"`
   }
 
   // Lint each list of files
+  if (showProgress) {
+    const fileCount = dirInfos.reduce((p, c) => p + c.files.length, 0);
+    logMessage(`Linting: ${fileCount} file(s)`);
+  }
   for (const dirInfo of dirInfos) {
     const { dir, files, markdownlintConfig, markdownlintOptions } = dirInfo;
     let filteredFiles = files;
@@ -364,6 +372,9 @@ $ ${name} "**/*.md" "#node_modules"`
   summary.forEach((result) => delete result.counter);
 
   // Output summary via formatters
+  if (showProgress) {
+    logMessage(`Summary: ${summary.length} error(s)`);
+  }
   const { outputFormatters } = baseMarkdownlintOptions;
   const errorsPresent = (summary.length > 0);
   if (errorsPresent || outputFormatters) {
diff --git a/test/all-ok.stdout b/test/all-ok.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md **/*.markdown
+Linting: 3 file(s)
+Summary: 0 error(s)
diff --git a/test/config-overrides-options.stdout b/test/config-overrides-options.stdout
@@ -0,0 +1,3 @@
+Finding: viewme.md
+Linting: 1 file(s)
+Summary: 3 error(s)
diff --git a/test/customRules-invalid.stdout b/test/customRules-invalid.stdout
@@ -0,0 +1,2 @@
+Finding: .*
+Linting: 1 file(s)
diff --git a/test/customRules-missing.stdout b/test/customRules-missing.stdout
@@ -0,0 +1,2 @@
+Finding: .*
+Linting: 1 file(s)
diff --git a/test/customRules-throws.stdout b/test/customRules-throws.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 1 file(s)
+Summary: 6 error(s)
diff --git a/test/customRules.stdout b/test/customRules.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 5 file(s)
+Summary: 31 error(s)
diff --git a/test/dot.stdout b/test/dot.stdout
@@ -0,0 +1,3 @@
+Finding: *.{md,markdown}
+Linting: 2 file(s)
+Summary: 10 error(s)
diff --git a/test/file-paths-as-args.stdout b/test/file-paths-as-args.stdout
@@ -0,0 +1,3 @@
+Finding: viewme.md ./dir/subdir/info.md
+Linting: 2 file(s)
+Summary: 10 error(s)
diff --git a/test/fix.stdout b/test/fix.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 4 file(s)
+Summary: 8 error(s)
diff --git a/test/frontMatter.stdout b/test/frontMatter.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 3 file(s)
+Summary: 0 error(s)
diff --git a/test/ignores.stdout b/test/ignores.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md **/*.markdown !*.md !dir*/*/*.md
+Linting: 8 file(s)
+Summary: 8 error(s)
diff --git a/test/markdownItPlugins-missing.stdout b/test/markdownItPlugins-missing.stdout
@@ -0,0 +1,2 @@
+Finding: .*
+Linting: 1 file(s)
diff --git a/test/markdownItPlugins.stdout b/test/markdownItPlugins.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 3 file(s)
+Summary: 3 error(s)
diff --git a/test/markdownlint-cli2-js.stdout b/test/markdownlint-cli2-js.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 3 file(s)
+Summary: 9 error(s)
diff --git a/test/markdownlint-cli2-jsonc-example/.markdownlint-cli2.jsonc b/test/markdownlint-cli2-jsonc-example/.markdownlint-cli2.jsonc
@@ -32,6 +32,9 @@
   // Disable inline config comments
   "noInlineConfig": true,
 
+  // Disable progress on stdout
+  "noProgress": true,
+
   // Use a specific formatter
   "outputFormatters": [
     [ "markdownlint-cli2-formatter-default" ]
diff --git a/test/markdownlint-cli2-jsonc.stdout b/test/markdownlint-cli2-jsonc.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 3 file(s)
+Summary: 9 error(s)
diff --git a/test/markdownlint-cli2-test.js b/test/markdownlint-cli2-test.js
@@ -429,6 +429,6 @@ tape("READMEs", (test) => {
     "./formatter-json/README.md",
     "./formatter-junit/README.md"
   ];
-  markdownlintCli2(inputs, uncalled, uncalled).
+  markdownlintCli2(inputs, noop, uncalled).
     then((exitCode) => test.equal(exitCode, 0));
 });
diff --git a/test/markdownlint-js.stdout b/test/markdownlint-js.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 3 file(s)
+Summary: 10 error(s)
diff --git a/test/markdownlint-json-extends.stdout b/test/markdownlint-json-extends.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 3 file(s)
+Summary: 10 error(s)
diff --git a/test/markdownlint-json-yaml.stdout b/test/markdownlint-json-yaml.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 1 file(s)
+Summary: 4 error(s)
diff --git a/test/markdownlint-json.stdout b/test/markdownlint-json.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 3 file(s)
+Summary: 10 error(s)
diff --git a/test/markdownlint-jsonc.stdout b/test/markdownlint-jsonc.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 1 file(s)
+Summary: 4 error(s)
diff --git a/test/markdownlint-yaml.stdout b/test/markdownlint-yaml.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 3 file(s)
+Summary: 10 error(s)
diff --git a/test/markdownlint-yml.stdout b/test/markdownlint-yml.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 1 file(s)
+Summary: 4 error(s)
diff --git a/test/nested-files.stdout b/test/nested-files.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 2 file(s)
+Summary: 8 error(s)
diff --git a/test/no-config-ignore-hash.stdout b/test/no-config-ignore-hash.stdout
@@ -0,0 +1,3 @@
+Finding: ** !dir
+Linting: 1 file(s)
+Summary: 5 error(s)
diff --git a/test/no-config-ignore.stdout b/test/no-config-ignore.stdout
@@ -0,0 +1,3 @@
+Finding: ** !dir
+Linting: 1 file(s)
+Summary: 5 error(s)
diff --git a/test/no-config-unignore.stdout b/test/no-config-unignore.stdout
@@ -0,0 +1,3 @@
+Finding: ** !dir dir/subdir
+Linting: 2 file(s)
+Summary: 10 error(s)
diff --git a/test/no-config.stdout b/test/no-config.stdout
@@ -0,0 +1,3 @@
+Finding: **
+Linting: 3 file(s)
+Summary: 13 error(s)
diff --git a/test/noInlineConfig.stdout b/test/noInlineConfig.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 4 file(s)
+Summary: 10 error(s)
diff --git a/test/outputFormatters-clean.stdout b/test/outputFormatters-clean.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 0 file(s)
+Summary: 0 error(s)
diff --git a/test/outputFormatters-missing.stdout b/test/outputFormatters-missing.stdout
@@ -0,0 +1,3 @@
+Finding: .*
+Linting: 1 file(s)
+Summary: 1 error(s)
diff --git a/test/outputFormatters-npm.stdout b/test/outputFormatters-npm.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 3 file(s)
+Summary: 13 error(s)
diff --git a/test/outputFormatters-params.stdout b/test/outputFormatters-params.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 1 file(s)
+Summary: 5 error(s)
diff --git a/test/outputFormatters.stdout b/test/outputFormatters.stdout
@@ -0,0 +1,3 @@
+Finding: **/*.md
+Linting: 3 file(s)
+Summary: 13 error(s)
diff --git a/test/sibling-directory-options.stdout b/test/sibling-directory-options.stdout
@@ -0,0 +1,3 @@
+Finding: ../no-config/**/*.md
+Linting: 3 file(s)
+Summary: 9 error(s)
diff --git a/test/sibling-directory.stdout b/test/sibling-directory.stdout
@@ -0,0 +1,3 @@
+Finding: ../markdownlint-json/**/*.md
+Linting: 3 file(s)
+Summary: 10 error(s)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Finding: */.md */.markdown`
	`2`	`+Linting: 3 file(s)`
	`3`	`+Summary: 0 error(s)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Finding: viewme.md`
	`2`	`+Linting: 1 file(s)`
	`3`	`+Summary: 3 error(s)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Finding: */.md`
	`2`	`+Linting: 1 file(s)`
	`3`	`+Summary: 6 error(s)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Finding: */.md`
	`2`	`+Linting: 5 file(s)`
	`3`	`+Summary: 31 error(s)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Finding: *.{md,markdown}`
	`2`	`+Linting: 2 file(s)`
	`3`	`+Summary: 10 error(s)`