markdownlint-cli2 0.7.1 → 0.8.0

package/README.md

@@ -67,9 +67,7 @@ As a [GitHub Action][github-action] via
 markdownlint-cli2 vX.Y.Z (markdownlint vX.Y.Z)
 https://github.com/DavidAnson/markdownlint-cli2
 
-Syntax: markdownlint-cli2 glob0 [glob1] [...] [globN]
-        markdownlint-cli2-fix glob0 [glob1] [...] [globN]
-        markdownlint-cli2-config config-file glob0 [glob1] [...] [globN]
+Syntax: markdownlint-cli2 glob0 [glob1] [...] [globN] [--config file] [--fix]
 
 Glob expressions (from the globby library):
 - * matches any number of characters, but not /
@@ -84,6 +82,10 @@ Dot-only glob:
 - Instead, it is mapped to "markdownlint-cli2 *.{md,markdown}" which lints all Markdown files in the current directory
 - To lint every file in the current directory tree, the command "markdownlint-cli2 **" can be used instead
 
+Optional parameters:
+- --config  specifies the path to a configuration file to define the base configuration
+- --fix     updates files to resolve fixable issues (can be overridden in configuration)
+
 Configuration via:
 - .markdownlint-cli2.jsonc
 - .markdownlint-cli2.yaml
@@ -116,28 +118,47 @@ markdownlint-cli2 "**/*.md" "#node_modules"
 ```
 
 Because sharing the same configuration between "normal" and "fix" modes is
-common, the following command defaults the `fix` property (see below) to `true`:
+common, the `--fix` argument can be used to default the `fix` property (see
+below) to `true` (though it can still be overridden by a configuration file):
 
 ```bash
-markdownlint-cli2-fix "**/*.md" "#node_modules"
+markdownlint-cli2 --fix "**/*.md" "#node_modules"
 ```
 
-Other than the default behavior of the `fix` property (which can be overridden),
-these two commands behave identically.
+> **Deprecated**
+>
+> The following command behaves similarly, defaulting the `fix` property to
+> `true`:
+>
+> ```bash
+> markdownlint-cli2-fix "**/*.md" "#node_modules"
+> ```
+>
+> Otherwise, `markdownlint-cli2-fix` behaves the same as `markdownlint-cli2`.
 
 In cases where it is not convenient to store a configuration file in the root
-of a project, the `markdownlint-cli2-config` command can be used. This command
-accepts a path to any supported configuration file as its first argument:
+of a project, the `--config` argument can be used to provide a path to any
+supported configuration file:
 
 ```bash
-markdownlint-cli2-config "config/.markdownlint-cli2.jsonc" "**/*.md" "#node_modules"
+markdownlint-cli2 --config "config/.markdownlint-cli2.jsonc" "**/*.md" "#node_modules"
 ```
 
-The configuration file name must be (or end with) one of the supported types
+The configuration file name must be (or end with) one of the supported names
 above. For example, `.markdownlint.json` or `example.markdownlint-cli2.jsonc`.
 The specified configuration file will be loaded, parsed, and applied as a base
 configuration for the current directory - which will then be handled normally.
-Otherwise, this command behaves identically to `markdownlint-cli2`.
+
+> **Deprecated**
+>
+> The following command behaves similarly, accepting a base configuration file
+> path as its first parameter:
+>
+> ```bash
+> markdownlint-cli2-config "config/.markdownlint-cli2.jsonc" "**/*.md" "#node_modules"
+> ```
+>
+> Otherwise, `markdownlint-cli2-config` behaves the same as `markdownlint-cli2`.
 
 ### Container Image
 
@@ -145,7 +166,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.7.1 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.8.0 "**/*.md" "#node_modules"
 ```
 
 Notes:
@@ -162,15 +183,17 @@ 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.7.1 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.8.0 "**/*.md" "#node_modules"
     ```
 
-To invoke the `markdownlint-cli2-config` or `markdownlint-cli2-fix` commands
-instead, use Docker's `--entrypoint` flag:
-
-```bash
-docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:v0.7.1 "**/*.md" "#node_modules"
-```
+> **Deprecated**
+>
+> To invoke the `markdownlint-cli2-config` or `markdownlint-cli2-fix` commands
+> instead, use Docker's `--entrypoint` flag:
+>
+> ```bash
+> docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:v0.8.0 "**/*.md" "#node_modules"
+> ```
 
 For convenience, the container image
 [`davidanson/markdownlint-cli2-rules`][docker-hub-markdownlint-cli2-rules]
@@ -378,7 +401,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.7.1
+  rev: v0.8.0
   hooks:
   - id: markdownlint-cli2
 ```

package/markdownlint-cli2-config.js

@@ -6,6 +6,9 @@
 
 const { run } = require("./markdownlint-cli2");
 
-run({
-  "name": "markdownlint-cli2-config"
-});
+run(
+  {
+    "name": "markdownlint-cli2-config"
+  },
+  [ "--config" ]
+);

package/markdownlint-cli2-fix.js

@@ -6,7 +6,9 @@
 
 const { run } = require("./markdownlint-cli2");
 
-run({
-  "fixDefault": true,
-  "name": "markdownlint-cli2-fix"
-});
+run(
+  {
+    "name": "markdownlint-cli2-fix"
+  },
+  [ "--fix" ]
+);

package/markdownlint-cli2.js

@@ -25,7 +25,7 @@ const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.7.1";
+const packageVersion = "0.8.0";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
 const dotOnlySubstitute = "*.{md,markdown}";
@@ -87,8 +87,11 @@ const importOrRequireResolve = async (dir, id) => {
     } catch (error) {
       errors.push(error);
     }
-    // Use AggregateError once available in Node 15+
-    throw new Error(errors.map((error) => error.message).join(" / "));
+    // @ts-ignore
+    throw new AggregateError(
+      errors,
+      `Unable to require or import module '${id}'.`
+    );
   }
   return id;
 };
@@ -178,7 +181,7 @@ const removeIgnoredFiles = (dir, files, ignores) => {
 
 // Process/normalize command-line arguments and return glob patterns
 const processArgv = (argv) => {
-  const globPatterns = (argv || []).map(
+  const globPatterns = argv.map(
     (glob) => {
       if (glob.startsWith(":")) {
         return glob;
@@ -205,9 +208,7 @@ const showHelp = (logMessage) => {
   /* eslint-disable max-len */
   logMessage(`https://github.com/DavidAnson/markdownlint-cli2
 
-Syntax: markdownlint-cli2 glob0 [glob1] [...] [globN]
-        markdownlint-cli2-fix glob0 [glob1] [...] [globN]
-        markdownlint-cli2-config config-file glob0 [glob1] [...] [globN]
+Syntax: markdownlint-cli2 glob0 [glob1] [...] [globN] [--config file] [--fix]
 
 Glob expressions (from the globby library):
 - * matches any number of characters, but not /
@@ -222,6 +223,10 @@ Dot-only glob:
 - Instead, it is mapped to "markdownlint-cli2 ${dotOnlySubstitute}" which lints all Markdown files in the current directory
 - To lint every file in the current directory tree, the command "markdownlint-cli2 **" can be used instead
 
+Optional parameters:
+- --config  specifies the path to a configuration file to define the base configuration
+- --fix     updates files to resolve fixable issues (can be overridden in configuration)
+
 Configuration via:
 - .markdownlint-cli2.jsonc
 - .markdownlint-cli2.yaml
@@ -815,7 +820,6 @@ const main = async (params) => {
     argv,
     optionsDefault,
     optionsOverride,
-    fixDefault,
     fileContents,
     nonFileContents,
     noErrors,
@@ -835,17 +839,33 @@ const main = async (params) => {
     // eslint-disable-next-line max-len
     `${name || packageName} v${packageVersion} (${libraryName} v${libraryVersion})`
   );
+  // Merge and process args/argv
+  let fixDefault = false;
+  // eslint-disable-next-line unicorn/no-useless-undefined
+  let configPath = undefined;
+  const argvFiltered = (argv || []).filter((arg) => {
+    if (configPath === null) {
+      configPath = arg;
+      return false;
+    } else if (arg === "--config") {
+      configPath = null;
+      return false;
+    } else if (arg === "--fix") {
+      fixDefault = true;
+      return false;
+    }
+    return true;
+  });
   // Read argv configuration file (if relevant and present)
   let optionsArgv = null;
   let relativeDir = null;
-  const [ configPath ] = (argv || []);
-  if ((name === "markdownlint-cli2-config") && configPath) {
+  if (configPath) {
     optionsArgv =
       await readOptionsOrConfig(configPath, fs, noRequire);
     relativeDir = path.dirname(configPath);
   }
   // Process arguments and get base options
-  const globPatterns = processArgv(optionsArgv ? argv.slice(1) : argv);
+  const globPatterns = processArgv(argvFiltered);
   const { baseMarkdownlintOptions, dirToDirInfo } =
     await getBaseOptions(
       fs,
@@ -859,7 +879,7 @@ const main = async (params) => {
     );
   if ((globPatterns.length === 0) && !nonFileContents) {
     showHelp(logMessage);
-    return 1;
+    return 2;
   }
   // Include any file overrides or non-file content
   const resolvedFileContents = {};
@@ -918,11 +938,13 @@ const main = async (params) => {
 };
 
 // Run function
-const run = (overrides) => {
+const run = (overrides, args) => {
   (async () => {
+    const argsAndArgv = args || [];
+    appendToArray(argsAndArgv, process.argv.slice(2));
     try {
       const defaultParams = {
-        "argv": process.argv.slice(2),
+        "argv": argsAndArgv,
         "logMessage": console.log,
         "logError": console.error
       };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
@@ -29,8 +29,8 @@
     "build-docker-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker build -t davidanson/markdownlint-cli2:v$VERSION -f docker/Dockerfile --label org.opencontainers.image.version=v$VERSION .",
     "build-docker-image-rules": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker build -t davidanson/markdownlint-cli2-rules:v$VERSION -f docker/Dockerfile-rules --build-arg VERSION=v$VERSION --label org.opencontainers.image.version=v$VERSION .",
     "ci": "npm-run-all --continue-on-error --parallel test-cover lint",
-    "docker-npm-install": "docker run --rm --tty --name npm-install --volume $PWD:/home/workdir --workdir /home/workdir --user node node:16 npm install",
-    "docker-npm-run-upgrade": "docker run --rm --tty --name npm-run-upgrade --volume $PWD:/home/workdir --workdir /home/workdir --user node node:16 npm run upgrade",
+    "docker-npm-install": "docker run --rm --tty --name npm-install --volume $PWD:/home/workdir --workdir /home/workdir --user node node:latest npm install",
+    "docker-npm-run-upgrade": "docker run --rm --tty --name npm-run-upgrade --volume $PWD:/home/workdir --workdir /home/workdir --user node node:latest npm run upgrade",
     "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",
@@ -48,7 +48,7 @@
     "webworker-install": "npm run docker-npm-install -- --no-save path-browserify process setimmediate stream-browserify url util webpack-cli"
   },
   "engines": {
-    "node": ">=14.18.0"
+    "node": ">=16"
   },
   "files": [
     "append-to-array.js",
@@ -62,21 +62,21 @@
   ],
   "dependencies": {
     "globby": "13.1.4",
-    "markdownlint": "0.28.2",
+    "markdownlint": "0.29.0",
     "markdownlint-cli2-formatter-default": "0.0.4",
     "micromatch": "4.0.5",
     "strip-json-comments": "5.0.0",
-    "yaml": "2.2.2"
+    "yaml": "2.3.1"
   },
   "devDependencies": {
     "@iktakahiro/markdown-it-katex": "4.0.1",
-    "ava": "5.2.0",
-    "c8": "7.13.0",
-    "cpy": "9.0.1",
+    "ava": "5.3.0",
+    "c8": "7.14.0",
+    "cpy": "10.1.0",
     "del": "7.0.0",
-    "eslint": "8.39.0",
-    "eslint-plugin-n": "15.7.0",
-    "eslint-plugin-unicorn": "46.0.0",
+    "eslint": "8.42.0",
+    "eslint-plugin-n": "16.0.0",
+    "eslint-plugin-unicorn": "47.0.0",
     "execa": "7.1.1",
     "markdown-it-emoji": "2.0.2",
     "markdown-it-for-inline": "0.1.1",