Add support for --config and --fix parameters, begin deprecating corresponding dedicated entry points.

Author: DavidAnson

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
 
@@ -165,12 +186,14 @@ Notes:
     docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.7.1 "**/*.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.7.1 "**/*.md" "#node_modules"
+> ```
 
 For convenience, the container image
 [`davidanson/markdownlint-cli2-rules`][docker-hub-markdownlint-cli2-rules]

markdownlint-cli2-config.js

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

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" ]
+);

markdownlint-cli2.js

@@ -181,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;
@@ -208,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 /
@@ -225,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
@@ -818,7 +820,6 @@ const main = async (params) => {
     argv,
     optionsDefault,
     optionsOverride,
-    fixDefault,
     fileContents,
     nonFileContents,
     noErrors,
@@ -838,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,
@@ -921,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
       };