Add support for .markdownlint-cli2.yaml configuration files (fixes #5).

Author: DavidAnson

README.md

@@ -61,6 +61,7 @@ Dot-only glob:
 
 Configuration via:
 - .markdownlint-cli2.jsonc
+- .markdownlint-cli2.yaml
 - .markdownlint-cli2.js
 - .markdownlint.jsonc or .markdownlint.json
 - .markdownlint.yaml or .markdownlint.yml
@@ -159,13 +160,23 @@ $ markdownlint-cli2 "**/*.md" "#node_modules"
 - For example: [`.markdownlint-cli2.jsonc`][markdownlint-cli2-jsonc] with all
   properties set
 
-### `.markdownlint-cli2.js`
+### `.markdownlint-cli2.yaml`
 
-- The format of this file is a [CommonJS module][commonjs-module] that exports
-  the `.markdownlint-cli2.jsonc` object described above.
+- The format of this file is a [YAML][yaml] object with the structure described
+  above for `.markdownlint-cli2.jsonc`.
 - Other details are the same as for `.markdownlint-cli2.jsonc` described above.
 - If a `.markdownlint-cli2.jsonc` file is present in the same directory, it
   takes precedence.
+- For example: [`.markdownlint-cli2.yaml`][markdownlint-cli2-yaml] with all
+  properties set
+
+### `.markdownlint-cli2.js`
+
+- The format of this file is a [CommonJS module][commonjs-module] that exports
+  the object described above for `.markdownlint-cli2.jsonc`.
+- Other details are the same as for `.markdownlint-cli2.jsonc` described above.
+- If a `.markdownlint-cli2.jsonc` or `.markdownlint-cli2.yaml` file is present
+  in the same directory, it takes precedence.
 - For example: [`.markdownlint-cli2.js`][markdownlint-cli2-js]
 
 ### `.markdownlint.jsonc` or `.markdownlint.json`
@@ -254,6 +265,7 @@ $ markdownlint-cli2 "**/*.md" "#node_modules"
 [markdownlint-cli2-formatter]: https://www.npmjs.com/search?q=keywords:markdownlint-cli2-formatter
 [markdownlint-cli2-js]: test/markdownlint-cli2-js/.markdownlint-cli2.js
 [markdownlint-cli2-jsonc]: test/markdownlint-cli2-jsonc-example/.markdownlint-cli2.jsonc
+[markdownlint-cli2-yaml]: test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml
 [markdownlint-js]: test/markdownlint-js/.markdownlint.js
 [markdownlint-jsonc]: test/markdownlint-jsonc/.markdownlint.jsonc
 [markdownlint-yaml]: test/markdownlint-yaml/.markdownlint.yaml

markdownlint-cli2.js

@@ -94,6 +94,7 @@ Dot-only glob:
 
 Configuration via:
 - .markdownlint-cli2.jsonc
+- .markdownlint-cli2.yaml
 - .markdownlint-cli2.js
 - .markdownlint.jsonc or .markdownlint.json
 - .markdownlint.yaml or .markdownlint.yml
@@ -131,14 +132,20 @@ $ ${name} "**/*.md" "#node_modules"`
       };
       dirToDirInfo[dir] = dirInfo;
       const markdownlintCli2Jsonc = path.join(dir, ".markdownlint-cli2.jsonc");
+      const markdownlintCli2Yaml = path.join(dir, ".markdownlint-cli2.yaml");
       tasks.push(
         fs.access(markdownlintCli2Jsonc).
           then(
             () => fs.readFile(markdownlintCli2Jsonc, utf8).then(jsoncParse),
-            requireConfig(
-              dir,
-              ".markdownlint-cli2.js",
-              () => null)
+            () => fs.access(markdownlintCli2Yaml).
+              then(
+                () => fs.readFile(markdownlintCli2Yaml, utf8).then(yamlParse),
+                requireConfig(
+                  dir,
+                  ".markdownlint-cli2.js",
+                  () => null
+                )
+              )
           ).
           then((options) => {
             dirInfo.markdownlintOptions = options;

test/markdownlint-cli2-jsonc/.markdownlint-cli2.yaml

@@ -257,6 +257,28 @@ testCase({
   "stderrRe": /Unexpected end of JSON input/u
 });
 
+testCase({
+  "name": "markdownlint-cli2-yaml",
+  "args": [ "**/*.md" ],
+  "exitCode": 1
+});
+
+testCase({
+  "name": "markdownlint-cli2-yaml-example",
+  "args": [ "**/*.md" ],
+  "exitCode": 1,
+  "cwd": "markdownlint-cli2-yaml-example-copy",
+  "pre": copyDirectory,
+  "post": deleteDirectory
+});
+
+testCase({
+  "name": "markdownlint-cli2-yaml-invalid",
+  "args": [ ".*" ],
+  "exitCode": 2,
+  "stderrRe": /Map keys must be unique/u
+});
+
 testCase({
   "name": "markdownlint-cli2-js",
   "args": [ "**/*.md" ],

test/markdownlint-cli2-test.js

@@ -0,0 +1,2 @@
+title-case.md:1:1 titlecase-rule Titlecase rule [Title Case: 'Expected # Heading, found # heading']
+viewme.md:6 MD025/single-title/single-h1 Multiple top level headings in the same document [Context: "# Description"]

test/markdownlint-cli2-yaml-example.stderr

@@ -0,0 +1,38 @@
+#
+# An example .markdownlint-cli2.yaml file
+#
+
+# Disable some built-in rules
+config:
+  no-trailing-spaces: false
+  no-multiple-blanks: false
+
+# Include a custom rule package
+customRules:
+  - markdownlint-rule-titlecase
+
+# Fix any fixable errors
+fix: true
+
+# Define a custom front matter pattern
+frontMatter: "<head>[^]*<\/head>"
+
+# Define glob expressions to ignore
+ignores:
+  - "ignore*.md"
+
+# Use a plugin to recognize math
+markdownItPlugins:
+  -
+    - "@iktakahiro/markdown-it-katex"
+
+# Disable inline config comments
+noInlineConfig: true
+
+# Disable progress on stdout
+noProgress: true
+
+# Use a specific formatter
+outputFormatters:
+  -
+    - markdownlint-cli2-formatter-default

test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml

@@ -0,0 +1,4 @@
+<head>
+  <front>matter</front>
+</head>
+# Heading

test/markdownlint-cli2-yaml-example/front-matter-custom.md

@@ -0,0 +1 @@
+Heading

test/markdownlint-cli2-yaml-example/ignoreme.md

@@ -0,0 +1,11 @@
+# Katex
+
+- List item
+
+$1 *2* 3$
+
+$$1 *2* 3$$
+
+$$1
++ 2
++ 3$$

test/markdownlint-cli2-yaml-example/katex.md

@@ -0,0 +1,3 @@
+#  heading
+
+<!-- markdownlint-disable-file titlecase-rule -->