diff --git a/.github/dictionary.txt b/.github/dictionary.txt index c81bc318..465ba1f4 100644 --- a/.github/dictionary.txt +++ b/.github/dictionary.txt @@ -26,6 +26,7 @@ markdownlint-cli2-formatter-pretty markdownlint-cli2-formatter-sarif markdownlint-cli2-formatter-summarize npm +POSIX pre-commit SARIF subdirectories diff --git a/doc/OutputFormatters.md b/doc/OutputFormatters.md index 761e5d0b..586d1c97 100644 --- a/doc/OutputFormatters.md +++ b/doc/OutputFormatters.md @@ -20,6 +20,8 @@ module.exports = (options, params) => { ... } Where `options` is an object that looks like: +- `directory`: `String` that identifies the base directory for relative paths + (using POSIX syntax) - `results`: `Array` of [`markdownlint` `LintError` objects][markdownlint-d-ts], each with an added `String` property `fileName` containing a relative path - `logMessage`: `Function` that takes a single `String` argument and logs it to