markdownlint-cli2 0.10.0 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.12.0
+
+- Remove deprecated `markdownlint-cli2-config` entry point
+  - Use `markdownlint-cli2 --config ...` instead
+- Remove deprecated `markdownlint-cli2-fix` entry point
+  - Use `markdownlint-cli2 --fix ...` instead
+- Add `--help` and `--no-globs` parameters
+- Improve and document included JSON schemas
+- Update dependencies (including `markdownlint`)
+
+## 0.11.0
+
+- Add `modulePaths` configuration option
+- Update dependencies (including `markdownlint`)
+- Remove support for end-of-life Node 16
+
 ## 0.10.0
 
 - Add `showFound` configuration option

package/README.md

@@ -67,7 +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] [--config file] [--fix]
+Syntax: markdownlint-cli2 glob0 [glob1] [...] [globN] [--config file] [--fix] [--help]
 
 Glob expressions (from the globby library):
 - * matches any number of characters, but not /
@@ -83,8 +83,10 @@ Dot-only glob:
 - 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)
+- --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)
+- --help      writes this message to the console and exits without doing anything else
+- --no-globs  ignores the "globs" property if present in the top-level options object
 
 Configuration via:
 - .markdownlint-cli2.jsonc
@@ -126,17 +128,6 @@ below) to `true` (though it can still be overridden by a configuration file):
 markdownlint-cli2 --fix "**/*.md" "#node_modules"
 ```
 
-> **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 `--config` argument can be used to provide a path to any
 supported configuration file (except `package.json`):
@@ -150,29 +141,18 @@ 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.
 
-> **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
 
 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.10.0 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.12.0 "**/*.md" "#node_modules"
 ```
 
 Notes:
 
-- As when using the [command line](#command-line), glob patterns are passed as
+- As when using the [command line][command-line], glob patterns are passed as
   arguments.
 - This image is built on the official [Node.js Docker image][nodejs-docker].
   Per security best practices, the [default user `node`][nodejs-docker-non-root]
@@ -184,18 +164,9 @@ 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.10.0 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.12.0 "**/*.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.10.0 "**/*.md" "#node_modules"
-> ```
-
 For convenience, the container image
 [`davidanson/markdownlint-cli2-rules`][docker-hub-markdownlint-cli2-rules]
 includes the latest versions of custom rules published to npm with the tag
@@ -231,6 +202,8 @@ of the rules within.
   - When glob expressions match files *not* under the current directory,
     configuration for the current directory is applied to the closest common
     parent directory.
+- Paths beginning with `~` are resolved relative to the user's home directory
+  (typically `$HOME` on UNIX and `%USERPROFILE%` on Windows)
 - 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`.
@@ -252,9 +225,12 @@ of the rules within.
       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.
+- The VS Code extension includes a [JSON Schema][json-schema] definition for the
+  `JSON(C)` configuration files described below. This adds auto-complete and can
+  make it easier to define proper structure.
+- See [markdownlint-cli2-config-schema.json][markdownlint-cli2-config-schema]
+  for that schema and [ValidatingConfiguration.md][validating-configuration] for
+  ways to use it to validate configuration files.
 
 ### `.markdownlint-cli2.jsonc`
 
@@ -284,6 +260,8 @@ of the rules within.
     command-line arguments
     - This setting can be used instead of (or in addition to) passing globs on
       the command-line and offers identical performance
+    - This setting is ignored when the `--no-globs` parameter is passed on the
+      command-line
     - This top-level setting is valid **only** in the directory from which
       `markdownlint-cli2` is run
   - `ignores`: `Array` of `String`s defining glob expressions to ignore when
@@ -305,6 +283,8 @@ of the rules within.
     - Relative paths are resolved based on the location of the `JSONC` file
     - For example: `[ [ "plugin-name", param_0, param_1, ... ], ... ]`
     - Search [`markdown-it-plugins` on npm][markdown-it-plugins]
+  - `modulePaths`: `Array` of `String`s providing additional paths to use when
+    resolving module references (e.g., alternate locations for `node_modules`)
   - `noInlineConfig`: `Boolean` value to disable the support of
     [HTML comments][html-comment] within Markdown content
     - For example: `<!-- markdownlint-disable some-rule -->`
@@ -348,7 +328,7 @@ of the rules within.
 
 - The format of this file is a [CommonJS module][commonjs-module] (`.cjs`) or
   [ECMAScript module][ecmascript-module] (`.mjs`) that exports the object
-  described above for `.markdownlint-cli2.jsonc`.
+  described above for `.markdownlint-cli2.jsonc` (directly or from a `Promise`).
 - Instead of passing a `String` to identify the module name/path to load for
   `customRules`, `markdownItPlugins`, and `outputFormatters`, the corresponding
   `Object` or `Function` can be provided directly.
@@ -388,7 +368,8 @@ of the rules within.
 
 - The format of this file is a [CommonJS module][commonjs-module] (`.cjs`) or
   [ECMAScript module][ecmascript-module] (`.mjs`) that exports the
-  [`markdownlint` `config` object][markdownlint-config].
+  [`markdownlint` `config` object][markdownlint-config] (directly or from a
+  `Promise`).
 - Other details are the same as for `jsonc`/`json` files described above.
 - For example: [`.markdownlint.cjs`][markdownlint-cjs] or
   [`.markdownlint.mjs`][markdownlint-mjs]
@@ -415,7 +396,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.10.0
+  rev: v0.12.0
   hooks:
   - id: markdownlint-cli2
 ```
@@ -425,8 +406,10 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 
 ## History
 
-See [CHANGELOG.md](CHANGELOG.md).
+See [CHANGELOG.md][changelog].
 
+[changelog]: CHANGELOG.md
+[command-line]: #command-line
 [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
@@ -440,6 +423,7 @@ See [CHANGELOG.md](CHANGELOG.md).
 [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
+[json-schema]: https://json-schema.org
 [jsonc]: https://code.visualstudio.com/Docs/languages/json#_json-with-comments
 [license-image]: https://img.shields.io/npm/l/markdownlint-cli2.svg
 [license-url]: https://opensource.org/licenses/MIT
@@ -448,26 +432,27 @@ See [CHANGELOG.md](CHANGELOG.md).
 [markdown-it-plugins]: https://www.npmjs.com/search?q=keywords:markdown-it-plugin
 [markdown-it-syntax-extensions]: https://github.com/markdown-it/markdown-it#syntax-extensions
 [markdownlint]: https://github.com/DavidAnson/markdownlint
-[markdownlint-config]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#optionsconfig
-[markdownlint-configuration]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#configuration
-[markdownlint-custom-rules]: https://github.com/DavidAnson/markdownlint/blob/main/doc/CustomRules.md
-[markdownlint-options]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#options
-[markdownlint-rules-aliases]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases
-[markdownlint-rules-tags]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#tags
+[markdownlint-config]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/README.md#optionsconfig
+[markdownlint-configuration]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/README.md#configuration
+[markdownlint-custom-rules]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/CustomRules.md
+[markdownlint-options]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/README.md#options
+[markdownlint-rules-aliases]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/README.md#rules--aliases
+[markdownlint-rules-tags]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/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
+[markdownlint-cli2-config-schema]: schema/markdownlint-cli2-config-schema.json
+[markdownlint-cli2-formatter]: https://www.npmjs.com/search?q=keywords:markdownlint-cli2-formatter
 [markdownlint-cli2-jsonc]: test/markdownlint-cli2-jsonc-example/.markdownlint-cli2.jsonc
 [markdownlint-cli2-mjs]: test/markdownlint-cli2-mjs/.markdownlint-cli2.mjs
 [markdownlint-cli2-yaml]: test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml
 [markdownlint-cjs]: test/markdownlint-cjs/.markdownlint.cjs
-[markdownlint-jsonc]: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc
+[markdownlint-jsonc]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/schema/.markdownlint.jsonc
 [markdownlint-mjs]: test/markdownlint-mjs/.markdownlint.mjs
 [markdownlint-rule]: https://www.npmjs.com/search?q=keywords:markdownlint-rule
-[markdownlint-yaml]: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+[markdownlint-yaml]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/schema/.markdownlint.yaml
 [nodejs]: https://nodejs.org/
 [nodejs-docker]: https://github.com/nodejs/docker-node
 [nodejs-docker-non-root]: https://github.com/nodejs/docker-node/blob/main/docs/BestPractices.md#non-root-user
@@ -483,6 +468,7 @@ See [CHANGELOG.md](CHANGELOG.md).
 [pre-commit-version]: https://pre-commit.com/#overriding-language-version
 [regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
 [regexp-constructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp
+[validating-configuration]: schema/ValidatingConfiguration.md
 [vscode]: https://code.visualstudio.com/
 [vscode-markdownlint]: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
 [yaml]: https://wikipedia.org/wiki/YAML