markdownlint-cli2 0.1.0 → 0.2.0

package/README.md

@@ -68,11 +68,11 @@ Configuration via:
 - .markdownlint.js
 
 Cross-platform compatibility:
-- UNIX and Windows shells expand globs according to different rules, so quoting glob arguments is recommended
-- Shells that expand globs do not support negated patterns (!node_modules), so quoting negated globs is required
-- Some Windows shells do not handle single-quoted (') arguments correctly, so double-quotes (") are recommended
-- Some UNIX shells handle exclamation (!) in double-quotes specially, so hashtag (#) is recommended for negated globs
-- Some shells use backslash (\) to escape special characters, so forward slash (/) is the recommended path separator
+- UNIX and Windows shells expand globs according to different rules; quoting arguments is recommended
+- Some Windows shells don't handle single-quoted (') arguments well; double-quote (") is recommended
+- Shells that expand globs do not support negated patterns (!node_modules); quoting is required here
+- Some UNIX shells parse exclamation (!) in double-quotes; hashtag (#) is recommended in these cases
+- The path separator is forward slash (/) on all platforms; backslash (\) is automatically converted
 
 Therefore, the most compatible glob syntax for cross-platform support:
 $ markdownlint-cli2 "**/*.md" "#node_modules"
@@ -136,8 +136,9 @@ in both cases), these two commands behave identically.
     rules for this part of the directory tree
     - If a `.markdownlint.{jsonc,json,yaml,yml,js}` file (see below) is present
       in the same directory, it overrides the value of this property
-  - `customRules`: `Array` of `String`s of module names/paths of
-    [custom rules][markdownlint-custom-rules] to load and use when linting
+  - `customRules`: `Array` of `String`s (or `Array`s of `String`s) of module
+    names/paths of [custom rules][markdownlint-custom-rules] to load and use
+    when linting
     - Each `String` is passed as the `id` parameter to Node's
       [require function][nodejs-require]
     - Relative paths are resolved based on the location of the `JSONC` file
@@ -265,7 +266,7 @@ in both cases), these two commands behave identically.
 
 ### `vscode-markdownlint`
 
-- `.markdownlintrc` and `.markdownlintignore` are not supported.
+- `.markdownlintignore` is not supported.
 
 ## pre-commit
 
@@ -274,7 +275,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.1.0
+  rev: v0.2.0
   hooks:
   - id: markdownlint-cli2
 ```
@@ -299,6 +300,10 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 - 0.0.14 - Update dependencies (including `markdownlint`)
 - 0.0.15 - Improve extensibility
 - 0.1.0 - Simplify use of `require`, increment minor version
+  - 0.1.1 - Restore previous use of `require`
+  - 0.1.2 - Update use of `require` to be more flexible
+  - 0.1.3 - Support rule collections
+- 0.2.0 - Improve handling of Windows paths using backslash
 
 <!-- markdownlint-disable line-length -->
 

package/markdownlint-cli2.js

@@ -19,10 +19,11 @@ const { markdownlint, "readConfig": markdownlintReadConfig } =
 const markdownlintRuleHelpers = require("markdownlint-rule-helpers");
 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.1.0";
+const packageVersion = "0.2.0";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
 const dotOnlySubstitute = "*.{md,markdown}";
@@ -45,7 +46,7 @@ const posixPath = (p) => p.split(path.sep).join(path.posix.sep);
 
 // Read a JSON(C) or YAML file and return the object
 const readConfig = (dir, name, otherwise) => {
-  const file = path.join(dir, name);
+  const file = path.posix.join(dir, name);
   return () => fs.access(file).
     then(
       // @ts-ignore
@@ -57,9 +58,7 @@ const readConfig = (dir, name, otherwise) => {
 // Require a module ID with the specified directory in the path
 const requireResolve = (dir, id) => {
   if (typeof id === "string") {
-    const paths = [ dir ];
-    const resolved = dynamicRequire.resolve(id, { paths });
-    return dynamicRequire(resolved);
+    return resolveAndRequire(dynamicRequire, id, dir);
   }
   return id;
 };
@@ -83,7 +82,7 @@ const requireIdsAndParams = (dir, idsAndParams, noRequire) => {
 
 // Require a JS file and return the exported object
 const requireConfig = (dir, name, noRequire) => {
-  const file = path.join(dir, name);
+  const file = path.posix.join(dir, name);
   // eslint-disable-next-line prefer-promise-reject-errors
   return () => (noRequire ? Promise.reject() : fs.access(file)).
     then(
@@ -94,7 +93,9 @@ const requireConfig = (dir, name, noRequire) => {
 
 // Process command-line arguments and return glob patterns
 const processArgv = (argv) => {
-  const globPatterns = argv.map((glob) => glob.replace(/^#/u, "!"));
+  const globPatterns = argv.map(
+    (glob) => glob.replace(/^#/u, "!").replace(/\\(?![$()*+?[\]^])/gu, "/")
+  );
   if ((globPatterns.length === 1) && (globPatterns[0] === ".")) {
     // Substitute a more reasonable pattern
     globPatterns[0] = dotOnlySubstitute;
@@ -131,11 +132,11 @@ Configuration via:
 - .markdownlint.js
 
 Cross-platform compatibility:
-- UNIX and Windows shells expand globs according to different rules, so quoting glob arguments is recommended
-- Shells that expand globs do not support negated patterns (!node_modules), so quoting negated globs is required
-- Some Windows shells do not handle single-quoted (') arguments correctly, so double-quotes (") are recommended
-- Some UNIX shells handle exclamation (!) in double-quotes specially, so hashtag (#) is recommended for negated globs
-- Some shells use backslash (\\) to escape special characters, so forward slash (/) is the recommended path separator
+- UNIX and Windows shells expand globs according to different rules; quoting arguments is recommended
+- Some Windows shells don't handle single-quoted (') arguments well; double-quote (") is recommended
+- Shells that expand globs do not support negated patterns (!node_modules); quoting is required here
+- Some UNIX shells parse exclamation (!) in double-quotes; hashtag (#) is recommended in these cases
+- The path separator is forward slash (/) on all platforms; backslash (\\) is automatically converted
 
 Therefore, the most compatible glob syntax for cross-platform support:
 $ ${name} "**/*.md" "#node_modules"`
@@ -157,8 +158,10 @@ const getAndProcessDirInfo = (tasks, dirToDirInfo, dir, noRequire, func) => {
     dirToDirInfo[dir] = dirInfo;
 
     // Load markdownlint-cli2 object(s)
-    const markdownlintCli2Jsonc = path.join(dir, ".markdownlint-cli2.jsonc");
-    const markdownlintCli2Yaml = path.join(dir, ".markdownlint-cli2.yaml");
+    const markdownlintCli2Jsonc =
+      path.posix.join(dir, ".markdownlint-cli2.jsonc");
+    const markdownlintCli2Yaml =
+      path.posix.join(dir, ".markdownlint-cli2.yaml");
     tasks.push(
       fs.access(markdownlintCli2Jsonc).
         then(
@@ -234,6 +237,7 @@ async (baseDir, globPatterns, optionsDefault, fixDefault, noRequire) => {
 
   // Pass base ignore globs as globby patterns (best performance)
   const ignorePatterns =
+    // eslint-disable-next-line unicorn/no-array-callback-reference
     (baseMarkdownlintOptions.ignores || []).map(negateGlob);
   appendToArray(globPatterns, ignorePatterns);
   delete baseMarkdownlintOptions.ignores;
@@ -254,7 +258,7 @@ async (baseDir, globPatterns, dirToDirInfo, noRequire) => {
   };
   for await (const file of globby.stream(globPatterns, globbyOptions)) {
     // @ts-ignore
-    const dir = path.dirname(file);
+    const dir = path.posix.dirname(file);
     getAndProcessDirInfo(tasks, dirToDirInfo, dir, noRequire, (dirInfo) => {
       dirInfo.files.push(file);
     });
@@ -271,7 +275,7 @@ const enumerateParents = async (baseDir, dirToDirInfo, noRequire) => {
   let baseDirParent = baseDir;
   do {
     baseDirParents[baseDirParent] = true;
-    baseDirParent = path.dirname(baseDirParent);
+    baseDirParent = path.posix.dirname(baseDirParent);
   } while (!baseDirParents[baseDirParent]);
 
   // Visit parents of each dirInfo
@@ -280,7 +284,7 @@ const enumerateParents = async (baseDir, dirToDirInfo, noRequire) => {
     let lastDir = dir;
     while (
       !baseDirParents[dir] &&
-      (dir = path.dirname(dir)) &&
+      (dir = path.posix.dirname(dir)) &&
       (dir !== lastDir)
     ) {
       lastDir = dir;
@@ -325,12 +329,14 @@ async (baseDir, globPatterns, dirToDirInfo, optionsOverride, noRequire) => {
     } else {
       const { markdownlintOptions } = dirInfo;
       if (markdownlintOptions && markdownlintOptions.customRules) {
-        markdownlintOptions.customRules =
+        const customRules =
           requireIds(
             dir,
             markdownlintOptions.customRules,
             noRequire
           );
+        // Expand nested arrays (for packages that export multiple rules)
+        markdownlintOptions.customRules = customRules.flat();
       }
       if (markdownlintOptions && markdownlintOptions.markdownItPlugins) {
         markdownlintOptions.markdownItPlugins =
@@ -424,12 +430,13 @@ const lintFiles = (dirInfos, fileContents) => {
       (file) => fileContents[file] === undefined
     );
     if (markdownlintOptions.ignores) {
+      // eslint-disable-next-line unicorn/no-array-callback-reference
       const ignores = markdownlintOptions.ignores.map(negateGlob);
       const micromatch = require("micromatch");
       filteredFiles = micromatch(
-        files.map((file) => path.relative(dir, file)),
+        files.map((file) => path.posix.relative(dir, file)),
         ignores
-      ).map((file) => path.join(dir, file));
+      ).map((file) => path.posix.join(dir, file));
     }
     // Create markdownlint options object
     const options = {
@@ -493,10 +500,9 @@ const createSummary = (baseDir, taskResults) => {
     for (const fileName in results) {
       const errorInfos = results[fileName];
       for (const errorInfo of errorInfos) {
-        const fileNameRelativePosix =
-          posixPath(path.relative(baseDir, fileName));
+        const fileNameRelative = path.posix.relative(baseDir, fileName);
         summary.push({
-          "fileName": fileNameRelativePosix,
+          "fileName": fileNameRelative,
           ...errorInfo,
           counter
         });
@@ -553,10 +559,10 @@ const main = async (params) => {
   } = params;
   const logMessage = params.logMessage || noop;
   const logError = params.logError || noop;
-  const baseDir = posixPath(
+  const baseDirSystem =
     (directory && path.resolve(directory)) ||
-    process.cwd()
-  );
+    process.cwd();
+  const baseDir = posixPath(baseDirSystem);
   // Output banner
   logMessage(
     `${packageName} v${packageVersion} (${libraryName} v${libraryVersion})`
@@ -578,7 +584,8 @@ const main = async (params) => {
   // Include any file overrides or non-file content
   const resolvedFileContents = {};
   for (const file in fileContents) {
-    resolvedFileContents[posixPath(path.resolve(baseDir, file))] =
+    const resolvedFile = posixPath(path.resolve(baseDirSystem, file));
+    resolvedFileContents[resolvedFile] =
       fileContents[file];
   }
   for (const nonFile in nonFileContents) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
@@ -22,38 +22,39 @@
     "ci": "npm-run-all --continue-on-error --parallel test-cover lint",
     "lint": "eslint --max-warnings 0 .",
     "lint-watch": "git ls-files | entr npm run lint",
-    "test": "ava test/append-to-array-test.js test/markdownlint-cli2-test.js test/markdownlint-cli2-test-exec.js test/markdownlint-cli2-test-main.js test/merge-options-test.js",
+    "test": "ava test/append-to-array-test.js test/markdownlint-cli2-test.js test/markdownlint-cli2-test-exec.js test/markdownlint-cli2-test-main.js test/merge-options-test.js test/resolve-and-require-test.js",
     "test-cover": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 npm test",
     "test-watch": "git ls-files | entr npm run test"
   },
   "engines": {
-    "node": ">=10.17.0"
+    "node": ">=12"
   },
   "files": [
     "append-to-array.js",
     "markdownlint-cli2.js",
     "markdownlint-cli2-fix.js",
-    "merge-options.js"
+    "merge-options.js",
+    "resolve-and-require.js"
   ],
   "dependencies": {
-    "globby": "~11.0.3",
+    "globby": "~11.0.4",
     "markdownlint": "~0.23.1",
     "markdownlint-cli2-formatter-default": "^0.0.2",
     "markdownlint-rule-helpers": "~0.14.0",
-    "micromatch": "~4.0.2",
+    "micromatch": "~4.0.4",
     "strip-json-comments": "~3.1.1",
     "yaml": "~1.10.2"
   },
   "devDependencies": {
     "@iktakahiro/markdown-it-katex": "~4.0.1",
     "ava": "~3.15.0",
-    "c8": "~7.7.0",
+    "c8": "~7.7.3",
     "cpy": "~8.1.2",
     "del": "~6.0.0",
-    "eslint": "~7.23.0",
+    "eslint": "~7.31.0",
     "eslint-plugin-node": "~11.1.0",
-    "eslint-plugin-unicorn": "~29.0.0",
-    "execa": "~5.0.0",
+    "eslint-plugin-unicorn": "~34.0.1",
+    "execa": "~5.1.1",
     "markdown-it-emoji": "~2.0.0",
     "markdown-it-for-inline": "~0.1.1",
     "markdownlint-cli2-formatter-json": "^0.0.4",

package/resolve-and-require.js

@@ -0,0 +1,20 @@
+// @ts-check
+
+"use strict";
+
+/**
+ * Wrapper for calling Node's require.resolve/require with an additional path.
+ *
+ * @param {Object} req Node's require function (or equivalent).
+ * @param {*} id Package identifier to require.
+ * @param {*} dir Directory to include when resolving paths.
+ * @returns {Object} Exported module content.
+ */
+const resolveAndRequire = (req, id, dir) => {
+  const resolvePaths = req.resolve.paths ? req.resolve.paths("") : [];
+  const paths = [ dir, ...resolvePaths ];
+  const resolved = req.resolve(id, { paths });
+  return req(resolved);
+};
+
+module.exports = resolveAndRequire;