markdownlint-cli2 0.9.2 → 0.11.0

package/CHANGELOG.md

@@ -0,0 +1,161 @@
+# Changelog
+
+## 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
+- Add `.markdownlint-cli2.jsonc` config schema
+- Update dependencies (including `markdownlint`)
+
+## 0.9.2
+
+- Remove `npm-shrinkwrap.json` entirely to avoid `npm` failures
+
+## 0.9.1
+
+- Remove `devDependencies` from `npm-shrinkwrap.json` to avoid `npm` failures
+
+## 0.9.0
+
+- Add support for Node.js's `package.json` as a configuration file source
+- Add output formatter for Static Analysis Results Interchange Format/SARIF
+- Bundle `npm-shrinkwrap.json` for reproducible/faster installs
+- Update dependencies (including `markdownlint`)
+
+## 0.8.1
+
+- Handle `--config` edge case
+
+## 0.8.0
+
+- Add support for `--config` and `--fix` parameters
+- Update dependencies (including `markdownlint`)
+- Remove support for end-of-life Node 14
+
+## 0.7.1
+
+- Update dependencies (including `markdownlint`)
+
+## 0.7.0
+
+- Add support for `extends` in `config` property of `.markdownlint-cli2.*` files
+- Build and publish `davidanson/markdownlint-cli2-rules` Docker container image
+- Update dependencies (including `markdownlint`)
+
+## 0.6.0
+
+- Update dependencies (including `markdownlint`)
+
+## 0.5.1
+
+- Update dependencies
+
+## 0.5.0
+
+- New rules
+- Support modules (MJS) everywhere
+- Include dotfiles
+
+## 0.4.0
+
+- New rules
+- Async custom rules
+- Explicit config
+- CJS (breaking)
+
+## 0.3.2
+
+- Extensibility/Windows/consistency improvements
+
+## 0.3.1
+
+- Extensibility tweaks
+
+## 0.3.0
+
+- Add Docker container
+- Update dependencies
+
+## 0.2.0
+
+- Improve handling of Windows paths using backslash
+
+## 0.1.3
+
+- Support rule collections
+
+## 0.1.2
+
+- Update use of `require` to be more flexible
+
+## 0.1.1
+
+- Restore previous use of `require`
+
+## 0.1.0
+
+- Simplify use of `require`
+- Increment minor version
+
+## 0.0.15
+
+- Improve extensibility
+
+## 0.0.14
+
+- Update dependencies (including `markdownlint`)
+
+## 0.0.13
+
+- Add `markdownlint-cli2-fix` command
+
+## 0.0.12
+
+- Update dependencies (including `markdownlint`)
+
+## 0.0.11
+
+- Improve performance of `fix`
+- Update banner
+
+## 0.0.10
+
+- Improve performance and configuration
+
+## 0.0.9
+
+- Improve configuration file handling
+
+## 0.0.8
+
+- Support `.markdownlint-cli2.yaml`
+- Add progress
+
+## 0.0.7
+
+- Support `.markdownlint-cli2.js` and `.markdownlint.js`
+
+## 0.0.6
+
+- Improve handling of very large directory trees
+
+## 0.0.5
+
+- Improve support for ignoring files
+
+## 0.0.4
+
+- Support output formatters and `markdown-it` plugins
+
+## 0.0.3
+
+- Feature parity with `markdownlint-cli`
+
+## 0.0.2
+
+- Initial release

package/README.md

@@ -167,12 +167,12 @@ 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.9.2 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.11.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,7 +184,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.9.2 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.11.0 "**/*.md" "#node_modules"
     ```
 
 > **Deprecated**
@@ -193,7 +193,7 @@ Notes:
 > instead, use Docker's `--entrypoint` flag:
 >
 > ```bash
-> docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:v0.9.2 "**/*.md" "#node_modules"
+> docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:v0.11.0 "**/*.md" "#node_modules"
 > ```
 
 For convenience, the container image
@@ -231,6 +231,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`.
@@ -305,6 +307,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 -->`
@@ -320,6 +324,9 @@ of the rules within.
     - This top-level setting is valid **only** in the directory from which
       `markdownlint-cli2` is run
     - Search [`markdownlint-cli2-formatter` on npm][markdownlint-cli2-formatter]
+  - `showFound`: `Boolean` value to display the list of found files on `stdout`
+    - This top-level setting is valid **only** in the directory from which
+      `markdownlint-cli2` is run and **only** when `noProgress` has not been set
 - When referencing a module via the `customRules`, `markdownItPlugins`, or
   `outputFormatters` properties, each `String` identifier is passed to Node's
   [`require` function][nodejs-require] then (if that failed) its
@@ -345,7 +352,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.
@@ -385,7 +392,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]
@@ -412,7 +420,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.9.2
+  rev: v0.11.0
   hooks:
   - id: markdownlint-cli2
 ```
@@ -422,8 +430,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