markdownlint-cli2 0.8.0 → 0.9.0

package/README.md

@@ -93,6 +93,7 @@ Configuration via:
 - .markdownlint.jsonc or .markdownlint.json
 - .markdownlint.yaml or .markdownlint.yml
 - .markdownlint.cjs or .markdownlint.mjs
+- package.json
 
 Cross-platform compatibility:
 - UNIX and Windows shells expand globs according to different rules; quoting arguments is recommended
@@ -138,7 +139,7 @@ markdownlint-cli2 --fix "**/*.md" "#node_modules"
 
 In cases where it is not convenient to store a configuration file in the root
 of a project, the `--config` argument can be used to provide a path to any
-supported configuration file:
+supported configuration file (except `package.json`):
 
 ```bash
 markdownlint-cli2 --config "config/.markdownlint-cli2.jsonc" "**/*.md" "#node_modules"
@@ -166,7 +167,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.8.0 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.9.0 "**/*.md" "#node_modules"
 ```
 
 Notes:
@@ -183,7 +184,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.8.0 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.9.0 "**/*.md" "#node_modules"
     ```
 
 > **Deprecated**
@@ -192,7 +193,7 @@ Notes:
 > 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"
+> docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:v0.9.0 "**/*.md" "#node_modules"
 > ```
 
 For convenience, the container image
@@ -233,9 +234,24 @@ of the rules within.
 - There are two kinds of configuration file (both detailed below):
   - Configuration files like `.markdownlint-cli2.*` allow complete control of
     `markdownlint-cli2` behavior and are also used by `vscode-markdownlint`.
+    - If multiple of these files are present in the same directory, only one is
+      used according to the following precedence:
+      1. `.markdownlint-cli2.jsonc`
+      2. `.markdownlint-cli2.yaml`
+      3. `.markdownlint-cli2.cjs`
+      4. `.markdownlint-cli2.mjs`
+      5. `package.json` (only supported in the current directory)
   - Configuration files like `.markdownlint.*` allow control over only the
     `markdownlint` `config` object and tend to be supported more broadly (such
     as by `markdownlint-cli`).
+    - If multiple of these files are present in the same directory, only one is
+      used according to the following precedence:
+      1. `.markdownlint.jsonc`
+      2. `.markdownlint.json`
+      3. `.markdownlint.yaml`
+      4. `.markdownlint.yml`
+      5. `.markdownlint.cjs`
+      6. `.markdownlint.mjs`
 - The VS Code extension `vscode-markdownlint` includes a schema definition for
   the `JSON(C)` configuration files described below. This adds auto-complete and
   can make it easier to define proper structure.
@@ -322,8 +338,6 @@ of the rules within.
 - The format of this file is a [YAML][yaml] object with the structure described
   above for `.markdownlint-cli2.jsonc`.
 - Other details are the same as for `.markdownlint-cli2.jsonc` described above.
-- If a `.markdownlint-cli2.jsonc` file is present in the same directory, it
-  takes precedence.
 - For example: [`.markdownlint-cli2.yaml`][markdownlint-cli2-yaml] with all
   properties set
 
@@ -336,12 +350,18 @@ of the rules within.
   `customRules`, `markdownItPlugins`, and `outputFormatters`, the corresponding
   `Object` or `Function` can be provided directly.
 - Other details are the same as for `.markdownlint-cli2.jsonc` described above.
-- If a `.markdownlint-cli2.jsonc` or `.markdownlint-cli2.yaml` file is present
-  in the same directory, it takes precedence; `.markdownlint-cli2.cjs` takes
-  precedence over `.markdownlint-cli2.mjs`.
 - For example: [`.markdownlint-cli2.cjs`][markdownlint-cli2-cjs] or
   [`.markdownlint-cli2.mjs`][markdownlint-cli2-mjs]
 
+### `package.json`
+
+- The format of this file is a standard [npm `package.json`][package-json] file
+  including a `markdownlint-cli2` property at the root and a value corresponding
+  to the object described above for `.markdownlint-cli2.jsonc`.
+- `package.json` is only supported in the current directory.
+- `package.json` is not supported by the `--config` argument.
+- For example: [`package-json-sample`][package-json-sample]
+
 ### `.markdownlint.jsonc` or `.markdownlint.json`
 
 - The format of this file is a [JSONC][jsonc] or [JSON][json] object matching
@@ -349,8 +369,6 @@ of the rules within.
 - Settings in this file apply to the directory it is in and all subdirectories
 - Settings **override** those applied by any versions of this file in a parent
   directory (up to the current directory).
-- If `jsonc` and `json` files are present in the same directory, the `jsonc`
-  version takes precedence.
 - To merge the settings of these files or share configuration, use the `extends`
   property (documented in the link above).
 - Both file types support comments in JSON.
@@ -361,10 +379,6 @@ of the rules within.
 - The format of this file is a [YAML][yaml] object representing the
   [`markdownlint` `config` object][markdownlint-config].
 - Other details are the same as for `jsonc`/`json` files described above.
-- If `yaml` and `yml` files are present in the same directory, the `yaml`
-  version takes precedence.
-- If a `jsonc` or `json` file is present in the same directory, it takes
-  precedence.
 - For example: [`.markdownlint.yaml`][markdownlint-yaml]
 
 ### `.markdownlint.cjs` or `.markdownlint.mjs`
@@ -373,9 +387,6 @@ of the rules within.
   [ECMAScript module][ecmascript-module] (`.mjs`) that exports the
   [`markdownlint` `config` object][markdownlint-config].
 - Other details are the same as for `jsonc`/`json` files described above.
-- If a `.markdownlint.jsonc`, `.json`, `.yaml`, or `.yml` file is present in the
-  same directory, it takes precedence; `.markdownlint.cjs` takes precedence over
-  `.markdownlint.mjs`.
 - For example: [`.markdownlint.cjs`][markdownlint-cjs] or
   [`.markdownlint.mjs`][markdownlint-mjs]
 
@@ -401,7 +412,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.8.0
+  rev: v0.9.0
   hooks:
   - id: markdownlint-cli2
 ```
@@ -413,8 +424,6 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 
 See [CHANGELOG.md](CHANGELOG.md).
 
-<!-- markdownlint-disable line-length -->
-
 [commonmark]: https://commonmark.org/
 [commonjs-module]: https://nodejs.org/api/modules.html#modules_modules_commonjs_modules
 [ecmascript-module]: https://nodejs.org/api/esm.html#modules-ecmascript-modules
@@ -465,6 +474,8 @@ See [CHANGELOG.md](CHANGELOG.md).
 [npm-image]: https://img.shields.io/npm/v/markdownlint-cli2.svg
 [npm-url]: https://www.npmjs.com/package/markdownlint-cli2
 [output-formatters]: doc/OutputFormatters.md
+[package-json]: https://docs.npmjs.com/cli/v9/configuring-npm/package-json
+[package-json-sample]: test/package-json/package.json
 [pre-commit]: https://pre-commit.com/
 [pre-commit-version]: https://pre-commit.com/#overriding-language-version
 [regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp

package/markdownlint-cli2.js

@@ -10,7 +10,8 @@ const dynamicRequire = (typeof __non_webpack_require__ === "undefined") ? requir
 // Capture native require implementation for dynamic loading of modules
 
 // Requires
-const path = require("node:path");
+const pathDefault = require("node:path");
+const pathPosix = pathDefault.posix;
 const { pathToFileURL } = require("node:url");
 const markdownlintLibrary = require("markdownlint");
 const {
@@ -25,7 +26,7 @@ const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.8.0";
+const packageVersion = "0.9.0";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
 const dotOnlySubstitute = "*.{md,markdown}";
@@ -49,11 +50,11 @@ const yamlParse = (text) => require("yaml").parse(text);
 const negateGlob = (glob) => `!${glob}`;
 
 // Return a posix path (even on Windows)
-const posixPath = (p) => p.split(path.sep).join(path.posix.sep);
+const posixPath = (p) => p.split(pathDefault.sep).join(pathPosix.sep);
 
 // Read a JSON(C) or YAML file and return the object
 const readConfig = (fs, dir, name, otherwise) => {
-  const file = path.posix.join(dir, name);
+  const file = pathPosix.join(dir, name);
   return () => fs.promises.access(file).
     then(
       () => getJsoncParse().then(
@@ -80,7 +81,7 @@ const importOrRequireResolve = async (dir, id) => {
     }
     try {
       const fileUrlString =
-        pathToFileURL(path.resolve(dir, expandId)).toString();
+        pathToFileURL(pathDefault.resolve(dir, expandId)).toString();
       // eslint-disable-next-line no-inline-comments
       const module = await import(/* webpackIgnore: true */ fileUrlString);
       return module.default;
@@ -114,22 +115,34 @@ const importOrRequireIdsAndParams = async (dir, idsAndParams, noRequire) => {
 };
 
 // Import or require a JavaScript file and return the exported object
-const importOrRequireConfig = (fs, dir, name, noRequire, otherwise) => (
-  () => (noRequire
-    // eslint-disable-next-line prefer-promise-reject-errors
-    ? Promise.reject()
-    : fs.promises.access(path.posix.join(dir, name))
-  ).
+const importOrRequireConfig = (fs, dir, name, noRequire, otherwise) => {
+  const id = pathPosix.join(dir, name);
+  return () => fs.promises.access(id).
     then(
-      () => importOrRequireResolve(dir, `./${name}`),
+      () => (noRequire ? {} : importOrRequireResolve(dir, id)),
       otherwise
-    )
-);
+    );
+};
+
+// Extend a config object if it has 'extends' property
+const getExtendedConfig = async (config, configPath, fs) => {
+  if (config.extends) {
+    const jsoncParse = await getJsoncParse();
+    return markdownlintExtendConfig(
+      config,
+      configPath,
+      [ jsoncParse, yamlParse ],
+      fs
+    );
+  }
+
+  return config;
+};
 
 // Read an options or config file in any format and return the object
 const readOptionsOrConfig = async (configPath, fs, noRequire) => {
-  const basename = path.basename(configPath);
-  const dirname = path.dirname(configPath);
+  const basename = pathPosix.basename(configPath);
+  const dirname = pathPosix.dirname(configPath);
   let options = null;
   let config = null;
   if (basename.endsWith(".markdownlint-cli2.jsonc")) {
@@ -167,16 +180,25 @@ const readOptionsOrConfig = async (configPath, fs, noRequire) => {
       "(e.g., \".markdownlint.json\" or \"example.markdownlint-cli2.jsonc\")."
     );
   }
-  return options || { config };
+
+  if (options) {
+    if (options.config) {
+      options.config = await getExtendedConfig(options.config, configPath, fs);
+    }
+    return options;
+  }
+
+  config = await getExtendedConfig(config, configPath, fs);
+  return { config };
 };
 
 // Filter a list of files to ignore by glob
 const removeIgnoredFiles = (dir, files, ignores) => {
   const micromatch = require("micromatch");
   return micromatch(
-    files.map((file) => path.posix.relative(dir, file)),
+    files.map((file) => pathPosix.relative(dir, file)),
     ignores
-  ).map((file) => path.posix.join(dir, file));
+  ).map((file) => pathPosix.join(dir, file));
 };
 
 // Process/normalize command-line arguments and return glob patterns
@@ -234,6 +256,7 @@ Configuration via:
 - .markdownlint.jsonc or .markdownlint.json
 - .markdownlint.yaml or .markdownlint.yml
 - .markdownlint.cjs or .markdownlint.mjs
+- package.json
 
 Cross-platform compatibility:
 - UNIX and Windows shells expand globs according to different rules; quoting arguments is recommended
@@ -250,7 +273,7 @@ $ markdownlint-cli2 "**/*.md" "#node_modules"`
 
 // Get (creating if necessary) and process a directory's info object
 const getAndProcessDirInfo =
-  (fs, tasks, dirToDirInfo, dir, relativeDir, noRequire, func) => {
+  (fs, tasks, dirToDirInfo, dir, relativeDir, noRequire, allowPackageJson) => {
     let dirInfo = dirToDirInfo[dir];
     if (!dirInfo) {
       dirInfo = {
@@ -265,9 +288,10 @@ const getAndProcessDirInfo =
 
       // Load markdownlint-cli2 object(s)
       const markdownlintCli2Jsonc =
-        path.posix.join(dir, ".markdownlint-cli2.jsonc");
+        pathPosix.join(dir, ".markdownlint-cli2.jsonc");
       const markdownlintCli2Yaml =
-        path.posix.join(dir, ".markdownlint-cli2.yaml");
+        pathPosix.join(dir, ".markdownlint-cli2.yaml");
+      const packageJson = pathPosix.join(dir, "package.json");
       tasks.push(
         fs.promises.access(markdownlintCli2Jsonc).
           then(
@@ -292,7 +316,21 @@ const getAndProcessDirInfo =
                     dir,
                     ".markdownlint-cli2.mjs",
                     noRequire,
-                    noop
+                    () => (allowPackageJson
+                      ? fs.promises.access(packageJson)
+                      // eslint-disable-next-line prefer-promise-reject-errors
+                      : Promise.reject()
+                    ).
+                      then(
+                        () => fs.promises.
+                          readFile(packageJson, utf8).
+                          then(
+                            (content) => getJsoncParse().
+                              then((jsoncParse) => jsoncParse(content)).
+                              then((obj) => obj[packageName])
+                          ),
+                        noop
+                      )
                   )
                 )
               )
@@ -301,17 +339,12 @@ const getAndProcessDirInfo =
             dirInfo.markdownlintOptions = options;
             return options &&
               options.config &&
-              options.config.extends &&
-              getJsoncParse().
-                then(
-                  (jsoncParse) => markdownlintExtendConfig(
-                    options.config,
-                    // Just needs to identify a file in the right directory
-                    markdownlintCli2Jsonc,
-                    [ jsoncParse, yamlParse ],
-                    fs
-                  )
-                ).
+              getExtendedConfig(
+                options.config,
+                // Just needs to identify a file in the right directory
+                markdownlintCli2Jsonc,
+                fs
+              ).
                 then((config) => {
                   options.config = config;
                 });
@@ -360,9 +393,6 @@ const getAndProcessDirInfo =
           })
       );
     }
-    if (func) {
-      func(dirInfo);
-    }
     return dirInfo;
   };
 
@@ -385,7 +415,8 @@ const getBaseOptions = async (
     dirToDirInfo,
     baseDir,
     relativeDir,
-    noRequire
+    noRequire,
+    true
   );
   await Promise.all(tasks);
   // eslint-disable-next-line no-multi-assign
@@ -437,7 +468,7 @@ const enumerateFiles =
       (globPattern) => {
         if (globPattern.startsWith(":")) {
           literalFiles.push(
-            posixPath(path.resolve(baseDirSystem, globPattern.slice(1)))
+            posixPath(pathDefault.resolve(baseDirSystem, globPattern.slice(1)))
           );
           return false;
         }
@@ -459,13 +490,15 @@ const enumerateFiles =
           globPattern.startsWith("!")
             ? globPattern.slice(1)
             : globPattern;
-        const globPath =
-          (path.posix.isAbsolute(barePattern) || path.isAbsolute(barePattern))
-            ? barePattern
-            : path.posix.join(baseDir, barePattern);
+        const globPath = (
+          pathPosix.isAbsolute(barePattern) ||
+          pathDefault.isAbsolute(barePattern)
+        )
+          ? barePattern
+          : pathPosix.join(baseDir, barePattern);
         return fs.promises.stat(globPath).
           then((stats) => (stats.isDirectory()
-            ? path.posix.join(globPattern, "**")
+            ? pathPosix.join(globPattern, "**")
             : globPattern)).
           catch(() => globPattern);
       })
@@ -478,18 +511,17 @@ const enumerateFiles =
       ...filteredLiteralFiles
     ];
     for (const file of files) {
-      const dir = path.posix.dirname(file);
-      getAndProcessDirInfo(
+      const dir = pathPosix.dirname(file);
+      const dirInfo = getAndProcessDirInfo(
         fs,
         tasks,
         dirToDirInfo,
         dir,
         null,
         noRequire,
-        (dirInfo) => {
-          dirInfo.files.push(file);
-        }
+        false
       );
+      dirInfo.files.push(file);
     }
     await Promise.all(tasks);
   };
@@ -503,7 +535,7 @@ const enumerateParents = async (fs, baseDir, dirToDirInfo, noRequire) => {
   let baseDirParent = baseDir;
   do {
     baseDirParents[baseDirParent] = true;
-    baseDirParent = path.posix.dirname(baseDirParent);
+    baseDirParent = pathPosix.dirname(baseDirParent);
   } while (!baseDirParents[baseDirParent]);
 
   // Visit parents of each dirInfo
@@ -512,11 +544,11 @@ const enumerateParents = async (fs, baseDir, dirToDirInfo, noRequire) => {
     let lastDir = dir;
     while (
       !baseDirParents[dir] &&
-      (dir = path.posix.dirname(dir)) &&
+      (dir = pathPosix.dirname(dir)) &&
       (dir !== lastDir)
     ) {
       lastDir = dir;
-      lastDirInfo =
+      const dirInfo =
         getAndProcessDirInfo(
           fs,
           tasks,
@@ -524,11 +556,10 @@ const enumerateParents = async (fs, baseDir, dirToDirInfo, noRequire) => {
           dir,
           null,
           noRequire,
-          // eslint-disable-next-line no-loop-func
-          (dirInfo) => {
-            lastDirInfo.parent = dirInfo;
-          }
+          false
         );
+      lastDirInfo.parent = dirInfo;
+      lastDirInfo = dirInfo;
     }
 
     // If dir not under baseDir, inject it as parent for configuration
@@ -761,7 +792,7 @@ const createSummary = (baseDir, taskResults) => {
     for (const fileName in results) {
       const errorInfos = results[fileName];
       for (const errorInfo of errorInfos) {
-        const fileNameRelative = path.posix.relative(baseDir, fileName);
+        const fileNameRelative = pathPosix.relative(baseDir, fileName);
         summary.push({
           "fileName": fileNameRelative,
           ...errorInfo,
@@ -831,7 +862,7 @@ const main = async (params) => {
   const logError = params.logError || noop;
   const fs = params.fs || require("node:fs");
   const baseDirSystem =
-    (directory && path.resolve(directory)) ||
+    (directory && pathDefault.resolve(directory)) ||
     process.cwd();
   const baseDir = posixPath(baseDirSystem);
   // Output banner
@@ -860,9 +891,11 @@ const main = async (params) => {
   let optionsArgv = null;
   let relativeDir = null;
   if (configPath) {
+    const resolvedConfigPath =
+      posixPath(pathDefault.resolve(baseDirSystem, configPath));
     optionsArgv =
-      await readOptionsOrConfig(configPath, fs, noRequire);
-    relativeDir = path.dirname(configPath);
+      await readOptionsOrConfig(resolvedConfigPath, fs, noRequire);
+    relativeDir = pathPosix.dirname(resolvedConfigPath);
   }
   // Process arguments and get base options
   const globPatterns = processArgv(argvFiltered);
@@ -877,14 +910,17 @@ const main = async (params) => {
       noGlobs,
       noRequire
     );
-  if ((globPatterns.length === 0) && !nonFileContents) {
+  if (
+    ((globPatterns.length === 0) && !nonFileContents) ||
+    (configPath === null)
+  ) {
     showHelp(logMessage);
     return 2;
   }
   // Include any file overrides or non-file content
   const resolvedFileContents = {};
   for (const file in fileContents) {
-    const resolvedFile = posixPath(path.resolve(baseDirSystem, file));
+    const resolvedFile = posixPath(pathDefault.resolve(baseDirSystem, file));
     resolvedFileContents[resolvedFile] =
       fileContents[file];
   }