markdownlint-cli2 0.14.0 → 0.15.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.15.0
+
+- Add support for `stdin` input via `-` glob
+- Add output formatter based on string templates
+- Update dependencies (including `markdownlint`)
+
 ## 0.14.0
 
 - Handle `--` parameter per POSIX convention

package/README.md

@@ -76,6 +76,7 @@ Glob expressions (from the globby library):
 - {} allows for a comma-separated list of "or" expressions
 - ! or # at the beginning of a pattern negate the match
 - : at the beginning identifies a literal file path
+- - as a glob represents standard input (stdin)
 
 Dot-only glob:
 - The command "markdownlint-cli2 ." would lint every file in the current directory tree which is probably not intended
@@ -148,7 +149,7 @@ A container image [`davidanson/markdownlint-cli2`][docker-hub-markdownlint-cli2]
 can also be used (e.g., as part of a CI pipeline):
 
 ```bash
-docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.14.0 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.15.0 "**/*.md" "#node_modules"
 ```
 
 Notes:
@@ -165,7 +166,7 @@ Notes:
   - A custom working directory can be specified with Docker's `-w` flag:
 
     ```bash
-    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.14.0 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.15.0 "**/*.md" "#node_modules"
     ```
 
 For convenience, the container image
@@ -412,7 +413,7 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 
 ```yaml
 - repo: https://github.com/DavidAnson/markdownlint-cli2
-  rev: v0.14.0
+  rev: v0.15.0
   hooks:
   - id: markdownlint-cli2
 ```

package/markdownlint-cli2.js

@@ -14,21 +14,25 @@ const pathDefault = require("node:path");
 const pathPosix = pathDefault.posix;
 const { pathToFileURL } = require("node:url");
 const markdownlintLibrary = require("markdownlint");
+const {
+  applyFixes,
+  "getVersion": getLibraryVersion,
+  "promises": markdownlintPromises
+} = markdownlintLibrary;
 const {
   markdownlint,
   "extendConfig": markdownlintExtendConfig,
   "readConfig": markdownlintReadConfig
-} = markdownlintLibrary.promises;
-const markdownlintRuleHelpers = require("markdownlint/helpers");
+} = markdownlintPromises;
 const appendToArray = require("./append-to-array");
 const mergeOptions = require("./merge-options");
 const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.14.0";
+const packageVersion = "0.15.0";
 const libraryName = "markdownlint";
-const libraryVersion = markdownlintLibrary.getVersion();
+const libraryVersion = getLibraryVersion();
 const bannerMessage = `${packageName} v${packageVersion} (${libraryName} v${libraryVersion})`;
 const dotOnlySubstitute = "*.{md,markdown}";
 const utf8 = "utf8";
@@ -52,7 +56,6 @@ const negateGlob = (glob) => `!${glob}`;
 const throwForConfigurationFile = (file, error) => {
   throw new Error(
     `Unable to use configuration file '${file}'; ${error?.message}`,
-    // @ts-ignore
     { "cause": error }
   );
 };
@@ -61,9 +64,10 @@ const throwForConfigurationFile = (file, error) => {
 const posixPath = (p) => p.split(pathDefault.sep).join(pathPosix.sep);
 
 // Expands a path with a tilde to an absolute path
-const expandTildePath = (id) => (
-  markdownlintRuleHelpers.expandTildePath(id, require("node:os"))
-);
+const expandTildePath = (id) => {
+  const markdownlintRuleHelpers = require("markdownlint/helpers");
+  return markdownlintRuleHelpers.expandTildePath(id, require("node:os"));
+};
 
 // Resolves module paths relative to the specified directory
 const resolveModulePaths = (dir, modulePaths) => (
@@ -110,7 +114,6 @@ const importOrRequireResolve = async (dirOrDirs, id, noRequire) => {
     } catch (error) {
       errors.push(error);
     }
-    // @ts-ignore
     throw new AggregateError(
       errors,
       `Unable to require or import module '${id}'.`
@@ -258,6 +261,7 @@ Glob expressions (from the globby library):
 - {} allows for a comma-separated list of "or" expressions
 - ! or # at the beginning of a pattern negate the match
 - : at the beginning identifies a literal file path
+- - as a glob represents standard input (stdin)
 
 Dot-only glob:
 - The command "markdownlint-cli2 ." would lint every file in the current directory tree which is probably not intended
@@ -772,6 +776,7 @@ const lintFiles = (fs, dirInfos, fileContents) => {
     const filteredFiles = filesAfterIgnores.filter(
       (file) => fileContents[file] === undefined
     );
+    /** @type {Record<string, string>} */
     const filteredStrings = {};
     for (const file of filesAfterIgnores) {
       if (fileContents[file] !== undefined) {
@@ -779,6 +784,7 @@ const lintFiles = (fs, dirInfos, fileContents) => {
       }
     }
     // Create markdownlint options object
+    /** @type {import("markdownlint").Options} */
     const options = {
       "files": filteredFiles,
       "strings": filteredStrings,
@@ -795,14 +801,14 @@ const lintFiles = (fs, dirInfos, fileContents) => {
       fs
     };
     // Invoke markdownlint
-    // @ts-ignore
     let task = markdownlint(options);
     // For any fixable errors, read file, apply fixes, and write it back
     if (markdownlintOptions.fix) {
       task = task.then((results) => {
         options.files = [];
         const subTasks = [];
-        const errorFiles = Object.keys(results);
+        const errorFiles = Object.keys(results).
+          filter((result) => filteredFiles.includes(result));
         for (const fileName of errorFiles) {
           const errorInfos = results[fileName].
             filter((errorInfo) => errorInfo.fixInfo);
@@ -811,15 +817,13 @@ const lintFiles = (fs, dirInfos, fileContents) => {
             options.files.push(fileName);
             subTasks.push(fs.promises.readFile(fileName, utf8).
               then((original) => {
-                const fixed = markdownlintRuleHelpers.
-                  applyFixes(original, errorInfos);
+                const fixed = applyFixes(original, errorInfos);
                 return fs.promises.writeFile(fileName, fixed, utf8);
               })
             );
           }
         }
         return Promise.all(subTasks).
-          // @ts-ignore
           then(() => markdownlint(options)).
           then((fixResults) => ({
             ...results,
@@ -905,11 +909,12 @@ const main = async (params) => {
     optionsDefault,
     optionsOverride,
     fileContents,
-    nonFileContents,
-    noRequire
+    noRequire,
+    allowStdin
   } = params;
   let {
-    noGlobs
+    noGlobs,
+    nonFileContents
   } = params;
   const logMessage = params.logMessage || noop;
   const logError = params.logError || noop;
@@ -922,6 +927,7 @@ const main = async (params) => {
   let fixDefault = false;
   // eslint-disable-next-line unicorn/no-useless-undefined
   let configPath = undefined;
+  let useStdin = false;
   let sawDashDash = false;
   let shouldShowHelp = false;
   const argvFiltered = (argv || []).filter((arg) => {
@@ -929,6 +935,8 @@ const main = async (params) => {
       return true;
     } else if (configPath === null) {
       configPath = arg;
+    } else if ((arg === "-") && allowStdin) {
+      useStdin = true;
       // eslint-disable-next-line unicorn/prefer-switch
     } else if (arg === "--") {
       sawDashDash = true;
@@ -979,22 +987,30 @@ const main = async (params) => {
     }
   }
   if (
-    ((globPatterns.length === 0) && !nonFileContents) ||
+    ((globPatterns.length === 0) && !useStdin && !nonFileContents) ||
     (configPath === null)
   ) {
     return showHelp(logMessage, false);
   }
+  // Add stdin as a non-file input if necessary
+  if (useStdin) {
+    const key = pathPosix.join(baseDir, "stdin");
+    const { text } = require("node:stream/consumers");
+    nonFileContents = {
+      ...nonFileContents,
+      [key]: await text(process.stdin)
+    };
+  }
   // Include any file overrides or non-file content
-  const { baseMarkdownlintOptions, dirToDirInfo } = baseOptions;
   const resolvedFileContents = {};
   for (const file in fileContents) {
     const resolvedFile = posixPath(pathDefault.resolve(baseDirSystem, file));
-    resolvedFileContents[resolvedFile] =
-      fileContents[file];
+    resolvedFileContents[resolvedFile] = fileContents[file];
   }
   for (const nonFile in nonFileContents) {
     resolvedFileContents[nonFile] = nonFileContents[nonFile];
   }
+  const { baseMarkdownlintOptions, dirToDirInfo } = baseOptions;
   appendToArray(
     dirToDirInfo[baseDir].files,
     Object.keys(nonFileContents || {})
@@ -1066,37 +1082,26 @@ const main = async (params) => {
   return errorsPresent ? 1 : 0;
 };
 
-// Run function
-const run = (overrides, args) => {
-  (async () => {
-    const argsAndArgv = args || [];
-    appendToArray(argsAndArgv, process.argv.slice(2));
-    try {
-      const defaultParams = {
-        "argv": argsAndArgv,
-        "logMessage": console.log,
-        "logError": console.error
-      };
-      const params = {
-        ...defaultParams,
-        ...overrides
-      };
-      process.exitCode = await main(params);
-    } catch (error) {
-      console.error(error);
-      process.exitCode = 2;
-    }
-  })();
-};
-
 // Export functions
 module.exports = {
-  main,
-  run
+  main
 };
 
 // Run if invoked as a CLI
-// @ts-ignore
 if (require.main === module) {
-  run();
+  const params = {
+    "argv": process.argv.slice(2),
+    "logMessage": console.log,
+    "logError": console.error,
+    "allowStdin": true
+  };
+  main(params).
+    then((exitCode) => {
+      process.exitCode = exitCode;
+    }).
+    // eslint-disable-next-line unicorn/prefer-top-level-await
+    catch((error) => {
+      console.error(error);
+      process.exitCode = 2;
+    });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
@@ -34,6 +34,10 @@
     "lint": "eslint --max-warnings 0",
     "lint-dockerfile": "docker run --rm -i hadolint/hadolint:latest-alpine < docker/Dockerfile",
     "lint-watch": "git ls-files | entr npm run lint",
+    "playwright-install-bare": "npm run playwright-install-npm && playwright install",
+    "playwright-install-npm": "npm install --no-save playwright@1.48.2",
+    "playwright-test": "playwright test --config ./webworker/playwright.config.mjs",
+    "playwright-test-docker": "docker run --rm --volume $PWD:/home/workdir --workdir /home/workdir --ipc=host mcr.microsoft.com/playwright:v1.48.2 npm run playwright-test",
     "schema": "cpy ./node_modules/markdownlint/schema/markdownlint-config-schema.json ./schema --flat",
     "test": "ava --timeout=1m test/append-to-array-test.js test/fs-mock-test.js test/fs-virtual-test.js test/markdownlint-cli2-test.js test/markdownlint-cli2-test-exec.js test/markdownlint-cli2-test-exports.js test/markdownlint-cli2-test-fs.js test/markdownlint-cli2-test-main.js test/merge-options-test.js test/resolve-and-require-test.js",
     "test-cover": "c8 --100 npm test",
@@ -71,25 +75,26 @@
     "globby": "14.0.2",
     "js-yaml": "4.1.0",
     "jsonc-parser": "3.3.1",
-    "markdownlint": "0.35.0",
+    "markdownlint": "0.36.1",
     "markdownlint-cli2-formatter-default": "0.0.5",
     "micromatch": "4.0.8"
   },
   "devDependencies": {
-    "@eslint/js": "9.9.1",
+    "@eslint/js": "9.14.0",
     "@iktakahiro/markdown-it-katex": "4.0.1",
-    "@stylistic/eslint-plugin": "2.7.2",
+    "@playwright/test": "1.48.2",
+    "@stylistic/eslint-plugin": "2.10.1",
     "ajv": "8.17.1",
-    "ava": "6.1.3",
+    "ava": "6.2.0",
     "c8": "10.1.2",
     "cpy": "11.1.0",
     "cpy-cli": "5.0.0",
-    "del": "7.1.0",
-    "eslint": "9.9.1",
-    "eslint-plugin-jsdoc": "50.2.2",
-    "eslint-plugin-n": "17.10.2",
-    "eslint-plugin-unicorn": "55.0.0",
-    "execa": "9.3.1",
+    "del": "8.0.0",
+    "eslint": "9.14.0",
+    "eslint-plugin-jsdoc": "50.4.3",
+    "eslint-plugin-n": "17.13.1",
+    "eslint-plugin-unicorn": "56.0.0",
+    "nano-spawn": "0.2.0",
     "markdown-it-emoji": "3.0.0",
     "markdown-it-for-inline": "2.0.1",
     "markdownlint-cli2-formatter-codequality": "0.0.5",
@@ -98,6 +103,7 @@
     "markdownlint-cli2-formatter-pretty": "0.0.7",
     "markdownlint-cli2-formatter-sarif": "0.0.2",
     "markdownlint-cli2-formatter-summarize": "0.0.7",
+    "markdownlint-cli2-formatter-template": "0.0.2",
     "markdownlint-rule-extended-ascii": "0.1.0",
     "npm-run-all": "4.1.5"
   },

package/schema/markdownlint-cli2-config-schema.json

@@ -1,21 +1,21 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.14.0/schema/markdownlint-cli2-config-schema.json",
+  "$id": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.15.0/schema/markdownlint-cli2-config-schema.json",
   "title": "markdownlint-cli2 configuration schema",
   "type": "object",
   "properties": {
     "$schema": {
       "description": "JSON Schema URI (expected by some editors)",
       "type": "string",
-      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.14.0/schema/markdownlint-cli2-config-schema.json"
+      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.15.0/schema/markdownlint-cli2-config-schema.json"
     },
     "config": {
-      "description": "markdownlint configuration schema : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/schema/.markdownlint.jsonc",
-      "$ref": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.35.0/schema/markdownlint-config-schema.json",
+      "description": "markdownlint configuration schema : https://github.com/DavidAnson/markdownlint/blob/v0.36.1/schema/.markdownlint.jsonc",
+      "$ref": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.36.1/schema/markdownlint-config-schema.json",
       "default": {}
     },
     "customRules": {
-      "description": "Module names or paths of custom rules to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Module names or paths of custom rules to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -25,18 +25,18 @@
       }
     },
     "fix": {
-      "description": "Whether to enable fixing of linting errors reported by rules that emit fix information : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to enable fixing of linting errors reported by rules that emit fix information : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     },
     "frontMatter": {
-      "description": "Regular expression used to match and ignore any front matter at the beginning of a document : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Regular expression used to match and ignore any front matter at the beginning of a document : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "string",
       "minLength": 1,
       "default": ""
     },
     "gitignore": {
-      "description": "Whether to ignore files referenced by .gitignore (or glob expression) (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to ignore files referenced by .gitignore (or glob expression) (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": [
         "boolean",
         "string"
@@ -44,7 +44,7 @@
       "default": false
     },
     "globs": {
-      "description": "Glob expressions to include when linting (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Glob expressions to include when linting (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -54,7 +54,7 @@
       }
     },
     "ignores": {
-      "description": "Glob expressions to ignore when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Glob expressions to ignore when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -64,7 +64,7 @@
       }
     },
     "markdownItPlugins": {
-      "description": "markdown-it plugins to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "markdown-it plugins to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -84,7 +84,7 @@
       }
     },
     "modulePaths": {
-      "description": "Additional paths to resolve module locations from : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Additional paths to resolve module locations from : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -94,22 +94,22 @@
       }
     },
     "noBanner": {
-      "description": "Whether to disable the display of the banner message and version numbers on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to disable the display of the banner message and version numbers on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     },
     "noInlineConfig": {
-      "description": "Whether to disable support of HTML comments within Markdown content : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to disable support of HTML comments within Markdown content : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     },
     "noProgress": {
-      "description": "Whether to disable the display of progress on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to disable the display of progress on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     },
     "outputFormatters": {
-      "description": "Output formatters to load and use to customize markdownlint-cli2 output (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Output formatters to load and use to customize markdownlint-cli2 output (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -129,7 +129,7 @@
       }
     },
     "showFound": {
-      "description": "Whether to show the list of found files on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to show the list of found files on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     }