markdownlint-cli2 0.1.3 → 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"
@@ -266,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
 
@@ -275,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.3
+  rev: v0.2.0
   hooks:
   - id: markdownlint-cli2
 ```
@@ -303,6 +303,7 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
   - 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

@@ -23,7 +23,7 @@ const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.1.3";
+const packageVersion = "0.2.0";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
 const dotOnlySubstitute = "*.{md,markdown}";
@@ -93,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;
@@ -130,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"`
@@ -235,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;
@@ -333,7 +336,7 @@ async (baseDir, globPatterns, dirToDirInfo, optionsOverride, noRequire) => {
             noRequire
           );
         // Expand nested arrays (for packages that export multiple rules)
-        markdownlintOptions.customRules = [].concat(...customRules);
+        markdownlintOptions.customRules = customRules.flat();
       }
       if (markdownlintOptions && markdownlintOptions.markdownItPlugins) {
         markdownlintOptions.markdownItPlugins =
@@ -427,6 +430,7 @@ 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(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.1.3",
+  "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",
@@ -27,7 +27,7 @@
     "test-watch": "git ls-files | entr npm run test"
   },
   "engines": {
-    "node": ">=10.17.0"
+    "node": ">=12"
   },
   "files": [
     "append-to-array.js",
@@ -37,24 +37,24 @@
     "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",