diff --git a/README.md b/README.md index 9c6674c5..46016997 100644 --- a/README.md +++ b/README.md @@ -352,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. @@ -392,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] diff --git a/test/markdownlint-cjs/dir/subdir/.markdownlint.cjs b/test/markdownlint-cjs/dir/subdir/.markdownlint.cjs index d370bdae..c51e9666 100644 --- a/test/markdownlint-cjs/dir/subdir/.markdownlint.cjs +++ b/test/markdownlint-cjs/dir/subdir/.markdownlint.cjs @@ -2,6 +2,6 @@ "use strict"; -module.exports = { +module.exports = Promise.resolve({ "first-line-heading": false -}; +}); diff --git a/test/markdownlint-cli2-cjs/dir/subdir/.markdownlint-cli2.cjs b/test/markdownlint-cli2-cjs/dir/subdir/.markdownlint-cli2.cjs index d6215d29..87514d86 100644 --- a/test/markdownlint-cli2-cjs/dir/subdir/.markdownlint-cli2.cjs +++ b/test/markdownlint-cli2-cjs/dir/subdir/.markdownlint-cli2.cjs @@ -2,8 +2,8 @@ "use strict"; -module.exports = { +module.exports = Promise.resolve({ "config": { "first-line-heading": false } -}; +}); diff --git a/test/markdownlint-cli2-mjs/dir/subdir/.markdownlint-cli2.cjs b/test/markdownlint-cli2-mjs/dir/subdir/.markdownlint-cli2.mjs similarity index 51% rename from test/markdownlint-cli2-mjs/dir/subdir/.markdownlint-cli2.cjs rename to test/markdownlint-cli2-mjs/dir/subdir/.markdownlint-cli2.mjs index d6215d29..58b4c927 100644 --- a/test/markdownlint-cli2-mjs/dir/subdir/.markdownlint-cli2.cjs +++ b/test/markdownlint-cli2-mjs/dir/subdir/.markdownlint-cli2.mjs @@ -1,9 +1,9 @@ // @ts-check -"use strict"; - -module.exports = { +const options = Promise.resolve({ "config": { "first-line-heading": false } -}; +}); + +export default options; diff --git a/test/markdownlint-mjs/dir/subdir/.markdownlint.mjs b/test/markdownlint-mjs/dir/subdir/.markdownlint.mjs index a8c6514d..0e49f169 100644 --- a/test/markdownlint-mjs/dir/subdir/.markdownlint.mjs +++ b/test/markdownlint-mjs/dir/subdir/.markdownlint.mjs @@ -1,7 +1,7 @@ // @ts-check -const config = { +const config = Promise.resolve({ "first-line-heading": false -}; +}); export default config;