markdownlint-cli2 0.5.0 → 0.6.0

package/README.md

@@ -10,22 +10,36 @@
 
 As a global CLI:
 
-```shell
+```bash
 npm install markdownlint-cli2 --global
 ```
 
-As a development dependency of the current package:
+As a development dependency of the current [Node.js][nodejs] package:
 
-```shell
+```bash
 npm install markdownlint-cli2 --save-dev
 ```
 
-Or as a Docker container image:
+As a [Docker][docker] container image:
 
-```shell
+```bash
 docker pull davidanson/markdownlint-cli2
 ```
 
+As a global CLI with [Homebrew][homebrew]:
+
+```bash
+brew install markdownlint-cli2
+```
+
+As a [GitHub Action][github-action] via
+[`markdownlint-cli2-action`][markdownlint-cli2-action]:
+
+```yaml
+- name: markdownlint-cli2-action
+  uses: DavidAnson/markdownlint-cli2-action
+```
+
 ## Overview
 
 - [`markdownlint`][markdownlint] is a library for linting [Markdown][markdown]/
@@ -131,7 +145,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:0.5.0 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.6.0 "**/*.md" "#node_modules"
 ```
 
 Notes:
@@ -148,14 +162,14 @@ Notes:
   - A custom working directory can be specified with Docker's `-w` flag:
 
     ```bash
-    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:0.5.0 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.6.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:0.5.0 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:v0.6.0 "**/*.md" "#node_modules"
 ```
 
 ### Exit Codes
@@ -344,7 +358,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.5.0
+  rev: v0.6.0
   hooks:
   - id: markdownlint-cli2
 ```
@@ -378,16 +392,21 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
   - 0.3.2 - Extensibility/Windows/consistency improvements
 - 0.4.0 - New rules, async custom rules, explicit config, CJS (breaking)
 - 0.5.0 - New rules, support modules (MJS) everywhere, include dotfiles
+  - 0.5.1 - Update dependencies
+- 0.6.0 - Update dependencies (including `markdownlint`)
 
 <!-- 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
+[docker]: https://www.docker.com
 [docker-bind-mounts]: https://docs.docker.com/storage/bind-mounts/
 [docker-hub-markdownlint-cli2]: https://hub.docker.com/r/davidanson/markdownlint-cli2
 [front-matter]: https://jekyllrb.com/docs/frontmatter/
+[github-action]: https://docs.github.com/actions
 [globby]: https://www.npmjs.com/package/globby
+[homebrew]: https://brew.sh
 [html-comment]: https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Getting_started
 [json]: https://wikipedia.org/wiki/JSON
 [jsonc]: https://code.visualstudio.com/Docs/languages/json#_json-with-comments
@@ -406,6 +425,7 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 [markdownlint-rules-tags]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#tags
 [markdownlint-cli]: https://github.com/igorshubovych/markdownlint-cli
 [markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2
+[markdownlint-cli2-action]: https://github.com/marketplace/actions/markdownlint-cli2-action
 [markdownlint-cli2-blog]: https://dlaa.me/blog/post/markdownlintcli2
 [markdownlint-cli2-formatter]: https://www.npmjs.com/search?q=keywords:markdownlint-cli2-formatter
 [markdownlint-cli2-cjs]: test/markdownlint-cli2-cjs/.markdownlint-cli2.cjs

package/markdownlint-cli2.js

@@ -22,7 +22,7 @@ const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.5.0";
+const packageVersion = "0.6.0";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
 const dotOnlySubstitute = "*.{md,markdown}";
@@ -34,8 +34,7 @@ const noop = () => null;
 // Gets a synchronous function to parse JSONC text
 const getJsoncParse = async () => {
   const { "default": stripJsonComments } =
-    // eslint-disable-next-line max-len
-    // eslint-disable-next-line no-inline-comments, node/no-unsupported-features/es-syntax
+    // eslint-disable-next-line no-inline-comments
     await import(/* webpackMode: "eager" */ "strip-json-comments");
   return (text) => JSON.parse(stripJsonComments(text));
 };
@@ -79,8 +78,8 @@ const importOrRequireResolve = async (dir, id) => {
     try {
       const fileUrlString =
         pathToFileURL(path.resolve(dir, expandId)).toString();
-      // eslint-disable-next-line node/no-unsupported-features/es-syntax
-      const module = await import(fileUrlString);
+      // eslint-disable-next-line no-inline-comments
+      const module = await import(/* webpackIgnore: true */ fileUrlString);
       return module.default;
     } catch (error) {
       errors.push(error);
@@ -445,8 +444,7 @@ async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, noErrors, noRequi
     })
   );
   // Process glob patterns
-  // eslint-disable-next-line max-len
-  // eslint-disable-next-line no-inline-comments, node/no-unsupported-features/es-syntax
+  // eslint-disable-next-line no-inline-comments
   const { globby } = await import(/* webpackMode: "eager" */ "globby");
   const files = [
     ...await globby(expandedDirectories, globbyOptions),
@@ -677,7 +675,7 @@ const lintFiles = async (fs, dirInfos, fileContents) => {
       "files": filteredFiles,
       "strings": filteredStrings,
       "config": markdownlintConfig || markdownlintOptions.config,
-      "configParsers": [ jsoncParse ],
+      "configParsers": [ jsoncParse, yamlParse ],
       "customRules": markdownlintOptions.customRules,
       "frontMatter": markdownlintOptions.frontMatter
         ? new RegExp(markdownlintOptions.frontMatter, "u")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
@@ -8,6 +8,7 @@
   },
   "license": "MIT",
   "type": "commonjs",
+  "main": "./markdownlint-cli2.js",
   "exports": "./markdownlint-cli2.js",
   "bin": {
     "markdownlint-cli2": "markdownlint-cli2.js",
@@ -40,7 +41,7 @@
     "webworker-install": "npm run docker-npm-install -- --no-save path-browserify process setimmediate stream-browserify url util webpack-cli"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=14.18.0"
   },
   "files": [
     "append-to-array.js",
@@ -51,25 +52,26 @@
     "resolve-and-require.js"
   ],
   "dependencies": {
-    "globby": "13.1.2",
-    "markdownlint": "0.26.1",
+    "globby": "13.1.3",
+    "markdownlint": "0.27.0",
     "markdownlint-cli2-formatter-default": "0.0.3",
     "micromatch": "4.0.5",
     "strip-json-comments": "5.0.0",
-    "yaml": "2.1.1"
+    "yaml": "2.2.1"
   },
   "devDependencies": {
     "@iktakahiro/markdown-it-katex": "4.0.1",
-    "ava": "4.3.1",
+    "ava": "5.1.0",
     "c8": "7.12.0",
     "cpy": "9.0.1",
     "del": "7.0.0",
-    "eslint": "8.20.0",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-unicorn": "43.0.2",
+    "eslint": "8.30.0",
+    "eslint-plugin-n": "15.6.0",
+    "eslint-plugin-unicorn": "45.0.2",
     "execa": "6.1.0",
     "markdown-it-emoji": "2.0.2",
     "markdown-it-for-inline": "0.1.1",
+    "markdownlint-cli2-formatter-codequality": "0.0.1",
     "markdownlint-cli2-formatter-json": "0.0.6",
     "markdownlint-cli2-formatter-junit": "0.0.5",
     "markdownlint-cli2-formatter-pretty": "0.0.3",