Add support for TOML configuration files via --config (refs #113, refs #458).

Author: BenniWi

README.md

@@ -27,7 +27,7 @@ markdownlint --help
 
   Options:
     -V, --version                               output the version number
-    -c, --config [configFile]                   configuration file (JSON, JSONC, JS, or YAML)
+    -c, --config [configFile]                   configuration file (JSON, JSONC, JS, YAML, or TOML)
     -d, --dot                                   include files/folders with a dot (for example `.github`)
     -f, --fix                                   fix basic errors (does not work with STDIN)
     -i, --ignore [file|directory|glob]          file(s) to ignore/exclude (default: [])
@@ -88,7 +88,7 @@ Because this option makes changes to the input files, it is good to make a backu
 
 `markdownlint-cli` reuses [the rules][rules] from `markdownlint` package.
 
-Configuration is stored in JSON, JSONC, YAML, or INI files in the same [config format][config].
+Configuration is stored in JSON, JSONC, YAML, INI, or TOML files in the same [config format][config].
 
 A sample configuration file:
 
@@ -102,7 +102,7 @@ A sample configuration file:
 }
 ```
 
-For more examples, see [.markdownlint.jsonc][markdownlint-jsonc], [.markdownlint.yaml][markdownlint-yaml], or the [style folder][style-folder].
+For more examples, see [.markdownlint.jsonc][markdownlint-jsonc], [.markdownlint.yaml][markdownlint-yaml], [test-config.toml](test/test-config.toml) or the [style folder][style-folder].
 
 The CLI argument `--config` is not required.
 If it is not provided, `markdownlint-cli` looks for the file `.markdownlint.jsonc`/`.markdownlint.json`/`.markdownlint.yaml`/`.markdownlint.yml` in current folder, or for the file `.markdownlintrc` in the current or all parent folders.
@@ -116,7 +116,8 @@ A JS configuration file may internally `require` one or more npm packages as a w
 `--enable` and `--disable` override configuration files; if a configuration file disables `MD123` and you pass `--enable MD123`, it will be enabled.
 If a rule is passed to both `--enable` and `--disable`, it will be disabled.
 
-> JS configuration files must be provided via the `--config` argument; they are not automatically loaded because running untrusted code is a security concern.
+> - JS configuration files must be provided via the `--config` argument; they are not automatically loaded because running untrusted code is a security concern.
+> - TOML configuration files must be provided via the `--config` argument; they are not automatically loaded.
 
 ## Exit codes
 

markdownlint.js

@@ -36,6 +36,11 @@ function yamlParse(text) {
   return require('js-yaml').load(text);
 }
 
+function tomlParse(text) {
+  // It is necessary to add the prototype manually because of https://github.com/BinaryMuse/toml-node/issues/55
+  return require('deep-extend')({}, require('toml').parse(text));
+}
+
 const exitCodes = {
   lintFindings: 1,
   failedToWriteOutputFile: 2,
@@ -44,7 +49,8 @@ const exitCodes = {
 };
 
 const projectConfigFiles = ['.markdownlint.jsonc', '.markdownlint.json', '.markdownlint.yaml', '.markdownlint.yml'];
-const configParsers = [jsoncParse, yamlParse];
+// TOML files can be (incorrectly) read by yamlParse (but not vice versa), so tomlParse needs to go before yamlParse
+const configParsers = [jsoncParse, tomlParse, yamlParse];
 const fsOptions = {encoding: 'utf8'};
 const processCwd = process.cwd();
 

package-lock.json

@@ -45,7 +45,8 @@
     "jsonc-parser": "~3.2.1",
     "markdownlint": "~0.33.0",
     "minimatch": "~9.0.3",
-    "run-con": "~1.3.2"
+    "run-con": "~1.3.2",
+    "toml": "~3.0.0"
   },
   "devDependencies": {
     "ava": "^6.1.1",

package.json

@@ -6,6 +6,6 @@
 module.exports = {
   MD012: false,
   MD043: {
-    headers: ['# First', '## Second', '### Third']
+    headings: ['# First', '## Second', '### Third']
   }
 };

test/md043-config.js

@@ -1,7 +1,7 @@
 {
   "MD012": false,
   "MD043": {
-    "headers": [
+    "headings": [
       "# First",
       "## Second",
       "### Third"

test/md043-config.json

@@ -0,0 +1,2 @@
+MD012 = false
+MD043 = { headings = ["# First", "## Second", "### Third"] }

test/md043-config.toml

@@ -0,0 +1,14 @@
+default = true
+no-hard-tabs = false
+whitespace = false
+MD033 = false
+MD034 = false
+
+[MD003]
+style = "atx"
+
+[MD007]
+indent = 4
+
+[MD013]
+line_length = 200

test/test-config.toml

@@ -0,0 +1,12 @@
+default: true
+no-hard-tabs: false
+whitespace: false
+MD033: false
+MD034: false
+MD003:
+  style: atx
+MD007:
+  indent: 2
+MD013:
+  line_length: 200
+

test/test-config.yaml

@@ -400,6 +400,35 @@ test('configuration file can be JavaScript', async t => {
   t.is(result.exitCode, 0);
 });
 
+test('configuration file can be TOML', async t => {
+  const result = await execa('../markdownlint.js', ['--config', 'md043-config.toml', 'md043-config.md'], {stripFinalNewline: false});
+  t.is(result.stdout, '');
+  t.is(result.stderr, '');
+  t.is(result.exitCode, 0);
+});
+
+test('linting using a toml configuration file works', async t => {
+  try {
+    await execa('../markdownlint.js', ['--config', 'test-config.toml', '**/*.md'], {stripFinalNewline: false});
+    t.fail();
+  } catch (error) {
+    t.is(error.stdout, '');
+    t.is(error.stderr.match(errorPattern).length, 15);
+    t.is(error.exitCode, 1);
+  }
+});
+
+test('linting using a yaml configuration file works', async t => {
+  try {
+    await execa('../markdownlint.js', ['--config', 'test-config.yaml', '**/*.md'], {stripFinalNewline: false});
+    t.fail();
+  } catch (error) {
+    t.is(error.stdout, '');
+    t.is(error.stderr.match(errorPattern).length, 15);
+    t.is(error.exitCode, 1);
+  }
+});
+
 test('error on configuration file not found', async t => {
   try {
     await execa('../markdownlint.js', ['--config', 'non-existent-file-path.yaml', 'correct.md'], {stripFinalNewline: false});