markdownlint-cli2 0.18.0 → 0.19.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.19.0
+
+- Add `--format` parameter for editor integration
+- Update output formatters for severity `warning`
+- Explicitly version Docker containers for `pre-commit`
+- Update dependencies (including `markdownlint`)
+
+## 0.18.1
+
+- Update dependencies (including `markdownlint`)
+
 ## 0.18.0
 
 - Use user ID in Docker containers for security

package/README.md

@@ -37,7 +37,7 @@ As a [GitHub Action][github-action] via
 
 ```yaml
 - name: markdownlint-cli2-action
-  uses: DavidAnson/markdownlint-cli2-action@v9
+  uses: DavidAnson/markdownlint-cli2-action@main
 ```
 
 ## Overview
@@ -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] [--help]
+Syntax: markdownlint-cli2 glob0 [glob1] [...] [globN] [--config file] [--fix] [--format] [--help] [--no-globs]
 
 Glob expressions (from the globby library):
 - * matches any number of characters, but not /
@@ -86,6 +86,7 @@ Dot-only glob:
 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)
+- --format    reads standard input (stdin), applies fixes, writes standard output (stdout)
 - --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
 
@@ -149,7 +150,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.18.0 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.19.0 "**/*.md" "#node_modules"
 ```
 
 Notes:
@@ -166,7 +167,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.18.0 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.19.0 "**/*.md" "#node_modules"
     ```
 
 For convenience, the container image
@@ -178,11 +179,51 @@ onto the base image `davidanson/markdownlint-cli2`.
 **Note**: This container image exists for convenience and is not an endorsement
 of the rules within.
 
+### Output Formatters
+
+In addition to (or instead of) the default behavior of writing a list of all
+issues to the standard error (`stderr`) device, custom output formatters can be
+configured to produce a variety of outputs like:
+
+- [List of issues (default)][formatter-default]
+- [List of issues with color and links][formatter-pretty]
+- [GitLab Code Quality report file][formatter-codequality]
+- [JSON file][formatter-json]
+- [JUnit XML file][formatter-junit]
+- [Static Analysis Results Interchange Format/SARIF file][formatter-sarif]
+- [Summary of issues found][formatter-summarize]
+- [Flexible string template][formatter-template] supporting:
+  - Azure Pipelines Task command LogIssue format
+  - GitHub Actions workflow commands format
+
+[formatter-default]: ./formatter-default/README.md
+[formatter-codequality]: ./formatter-codequality/README.md
+[formatter-json]: ./formatter-json/README.md
+[formatter-junit]: ./formatter-junit/README.md
+[formatter-pretty]: ./formatter-pretty/README.md
+[formatter-sarif]: ./formatter-sarif/README.md
+[formatter-summarize]: ./formatter-summarize/README.md
+[formatter-template]: ./formatter-template/README.md
+
+For more information, refer to the documentation for the `outputFormatters`
+parameter below.
+
 ### Exit Codes
 
-- `0`: Linting was successful and there were no errors
-- `1`: Linting was successful and there were errors
-- `2`: Linting was not completed due to a runtime issue
+- `0`: Linting was successful and there were no errors (there may be warnings)
+- `1`: Linting was successful and there were errors (and possibly warnings)
+- `2`: Linting was not successful due to a problem or failure
+
+### Formatting
+
+Some editors implement document formatting by invoking an external program,
+passing the text of the current document on standard input (`stdin`), and
+reading the formatted result from standard output (`stdout`). This scenario is
+supported by the `--format` command-line parameter. When `--format` is set:
+
+- Globs and other input sources are ignored
+- The `--fix` parameter is implicitly set
+- The exit code `1` is not used
 
 ## Rule List
 
@@ -404,10 +445,6 @@ of the rules within.
 - The `INI` config format, `.markdownlintrc`, and `.markdownlintignore` are not
   supported.
 
-### `vscode-markdownlint`
-
-- `.markdownlintignore` is not supported.
-
 ## pre-commit
 
 To run `markdownlint-cli2` as part of a [pre-commit][pre-commit] workflow, add a
@@ -415,7 +452,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.18.0
+  rev: v0.19.0
   hooks:
   - id: markdownlint-cli2
 ```
@@ -451,12 +488,12 @@ See [CHANGELOG.md][changelog].
 [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/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-config]: https://github.com/DavidAnson/markdownlint/blob/v0.39.0/README.md#optionsconfig
+[markdownlint-configuration]: https://github.com/DavidAnson/markdownlint/blob/v0.39.0/README.md#configuration
+[markdownlint-custom-rules]: https://github.com/DavidAnson/markdownlint/blob/v0.39.0/doc/CustomRules.md
+[markdownlint-options]: https://github.com/DavidAnson/markdownlint/blob/v0.39.0/README.md#options
+[markdownlint-rules-aliases]: https://github.com/DavidAnson/markdownlint/blob/v0.39.0/README.md#rules--aliases
+[markdownlint-rules-tags]: https://github.com/DavidAnson/markdownlint/blob/v0.39.0/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
@@ -468,15 +505,15 @@ See [CHANGELOG.md][changelog].
 [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/v0.32.1/schema/.markdownlint.jsonc
+[markdownlint-jsonc]: https://github.com/DavidAnson/markdownlint/blob/v0.39.0/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/v0.32.1/schema/.markdownlint.yaml
+[markdownlint-yaml]: https://github.com/DavidAnson/markdownlint/blob/v0.39.0/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
 [nodejs-import-expression]: https://nodejs.org/api/esm.html#import-expressions
-[nodejs-import-meta-resolve]: https://nodejs.org/api/esm.html#importmetaresolvespecifier-parent
+[nodejs-import-meta-resolve]: https://nodejs.org/api/esm.html#importmetaresolvespecifier
 [nodejs-require]: https://nodejs.org/api/modules.html#modules_require_id
 [npm-image]: https://img.shields.io/npm/v/markdownlint-cli2.svg
 [npm-url]: https://www.npmjs.com/package/markdownlint-cli2

package/append-to-array.mjs

@@ -4,8 +4,9 @@ const sliceSize = 1000;
 
 /**
  * Efficiently appends the source array to the destination array.
- * @param {object[]} destination Destination Array.
- * @param {object[]} source Source Array.
+ * @template T
+ * @param {T[]} destination Destination Array.
+ * @param {T[]} source Source Array.
  * @returns {void}
  */
 const appendToArray = (destination, source) => {

package/markdownlint-cli2-bin.mjs

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 
+// @ts-check
+
 import { "main" as markdownlintCli2 } from "./markdownlint-cli2.mjs";
 
 const params = {