markdownlint-cli2 0.20.0 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +83 -35
  3. package/constants.mjs +30 -0
  4. package/markdownlint-cli2.mjs +216 -243
  5. package/package.json +25 -21
  6. package/parsers/parsers.mjs +2 -0
  7. package/parsers/toml-parse.mjs +11 -0
  8. package/schema/markdownlint-cli2-config-schema.json +15 -15
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "markdownlint-cli2",
3
- "version": "0.20.0",
3
+ "version": "0.22.0",
4
4
  "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
5
5
  "author": {
6
6
  "name": "David Anson",
@@ -15,6 +15,7 @@
15
15
  "./markdownlint/promise": "./export-markdownlint-promise.mjs",
16
16
  "./parsers": "./parsers/parsers.mjs",
17
17
  "./parsers/jsonc": "./parsers/jsonc-parse.mjs",
18
+ "./parsers/toml": "./parsers/toml-parse.mjs",
18
19
  "./parsers/yaml": "./parsers/yaml-parse.mjs"
19
20
  },
20
21
  "bin": {
@@ -35,11 +36,11 @@
35
36
  "lint-dockerfile": "docker run --rm -i hadolint/hadolint:latest-alpine < docker/Dockerfile",
36
37
  "lint-watch": "git ls-files | entr npm run lint",
37
38
  "playwright-install-bare": "npm run playwright-install-npm && playwright install",
38
- "playwright-install-npm": "npm install --no-save playwright@1.57.0",
39
+ "playwright-install-npm": "npm install --no-save playwright@1.58.2",
39
40
  "playwright-test": "playwright test --config ./webworker/playwright.config.mjs",
40
- "playwright-test-docker": "docker run --rm --volume $PWD:/home/workdir --workdir /home/workdir --ipc=host mcr.microsoft.com/playwright:v1.57.0 npm run playwright-test",
41
+ "playwright-test-docker": "docker run --rm --volume $PWD:/home/workdir --workdir /home/workdir --ipc=host mcr.microsoft.com/playwright:v1.58.2 npm run playwright-test",
41
42
  "schema": "cpy ./node_modules/markdownlint/schema/markdownlint-config-schema.json ./schema --flat",
42
- "test": "ava --timeout=1m test/append-to-array-test.mjs test/fs-mock-test.mjs test/fs-virtual-test.mjs test/markdownlint-cli2-test.mjs test/markdownlint-cli2-test-exec.mjs test/markdownlint-cli2-test-exports.mjs test/markdownlint-cli2-test-formatters.mjs test/markdownlint-cli2-test-fs.mjs test/markdownlint-cli2-test-main.mjs test/merge-options-test.mjs",
43
+ "test": "ava --timeout=1m test/append-to-array-test.mjs test/constants-test.mjs test/fs-virtual-test.mjs test/markdownlint-cli2-test.mjs test/markdownlint-cli2-test-exec.mjs test/markdownlint-cli2-test-exports.mjs test/markdownlint-cli2-test-formatters.mjs test/markdownlint-cli2-test-fs.mjs test/markdownlint-cli2-test-main.mjs test/merge-options-test.mjs",
43
44
  "test-cover": "c8 --100 npm test",
44
45
  "test-docker-hub-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker image rm davidanson/markdownlint-cli2:v$VERSION davidanson/markdownlint-cli2:latest || true && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:v$VERSION \"*.md\" && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:latest \"*.md\"",
45
46
  "test-docker-hub-image-rules": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker image rm davidanson/markdownlint-cli2-rules:v$VERSION davidanson/markdownlint-cli2-rules:latest || true && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2-rules:v$VERSION \"*.md\" && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2-rules:latest \"*.md\"",
@@ -57,6 +58,7 @@
57
58
  "files": [
58
59
  "append-to-array.mjs",
59
60
  "CHANGELOG.md",
61
+ "constants.mjs",
60
62
  "export-markdownlint.mjs",
61
63
  "export-markdownlint-helpers.mjs",
62
64
  "export-markdownlint-promise.mjs",
@@ -66,6 +68,7 @@
66
68
  "merge-options.mjs",
67
69
  "parsers/parsers.mjs",
68
70
  "parsers/jsonc-parse.mjs",
71
+ "parsers/toml-parse.mjs",
69
72
  "parsers/yaml-parse.mjs",
70
73
  "README.md",
71
74
  "schema/markdownlint-cli2-config-schema.json",
@@ -73,35 +76,36 @@
73
76
  "schema/ValidatingConfiguration.md"
74
77
  ],
75
78
  "dependencies": {
76
- "globby": "15.0.0",
79
+ "globby": "16.1.1",
77
80
  "js-yaml": "4.1.1",
78
81
  "jsonc-parser": "3.3.1",
82
+ "jsonpointer": "5.0.1",
79
83
  "markdownlint": "0.40.0",
80
84
  "markdownlint-cli2-formatter-default": "0.0.6",
81
- "markdown-it": "14.1.0",
82
- "micromatch": "4.0.8"
85
+ "markdown-it": "14.1.1",
86
+ "micromatch": "4.0.8",
87
+ "smol-toml": "1.6.0"
83
88
  },
84
89
  "devDependencies": {
85
- "@eslint/js": "9.39.1",
86
- "@playwright/test": "1.57.0",
87
- "@stylistic/eslint-plugin": "5.6.1",
88
- "ajv": "8.17.1",
89
- "ava": "6.4.1",
90
- "c8": "10.1.3",
91
- "chalk": "5.6.2",
92
- "cpy": "12.1.0",
93
- "cpy-cli": "6.0.0",
94
- "eslint": "9.39.1",
95
- "eslint-plugin-jsdoc": "61.4.1",
96
- "eslint-plugin-n": "17.23.1",
97
- "eslint-plugin-unicorn": "62.0.0",
90
+ "@eslint/js": "10.0.1",
91
+ "@playwright/test": "1.58.2",
92
+ "@stylistic/eslint-plugin": "5.10.0",
93
+ "ajv": "8.18.0",
94
+ "ava": "7.0.0",
95
+ "c8": "11.0.0",
96
+ "cpy": "13.2.1",
97
+ "cpy-cli": "7.0.0",
98
+ "eslint": "10.1.0",
99
+ "eslint-plugin-jsdoc": "62.8.0",
100
+ "eslint-plugin-n": "17.24.0",
101
+ "eslint-plugin-unicorn": "63.0.0",
98
102
  "execa": "9.6.1",
99
103
  "markdown-it-emoji": "3.0.0",
100
104
  "markdown-it-for-inline": "2.0.1",
101
105
  "markdownlint-cli2-formatter-codequality": "0.0.7",
102
106
  "markdownlint-cli2-formatter-json": "0.0.9",
103
107
  "markdownlint-cli2-formatter-junit": "0.0.14",
104
- "markdownlint-cli2-formatter-pretty": "0.0.9",
108
+ "markdownlint-cli2-formatter-pretty": "0.0.10",
105
109
  "markdownlint-cli2-formatter-sarif": "0.0.4",
106
110
  "markdownlint-cli2-formatter-summarize": "0.0.8",
107
111
  "markdownlint-cli2-formatter-template": "0.0.4",
package/parsers/parsers.mjs CHANGED
@@ -1,6 +1,7 @@
1
1
  // @ts-check
2
2
 
3
3
  import jsoncParse from "./jsonc-parse.mjs";
4
+ import tomlParse from "./toml-parse.mjs";
4
5
  import yamlParse from "./yaml-parse.mjs";
5
6
 
6
7
  /**
@@ -9,6 +10,7 @@ import yamlParse from "./yaml-parse.mjs";
9
10
  */
10
11
  const parsers = [
11
12
  jsoncParse,
13
+ tomlParse,
12
14
  yamlParse
13
15
  ];
14
16
 
package/parsers/toml-parse.mjs ADDED
@@ -0,0 +1,11 @@
1
+ // @ts-check
2
+
3
+ import { parse } from "smol-toml";
4
+
5
+ /**
6
+ * Parses a TOML string, returning the corresponding object.
7
+ * @type {import("markdownlint").ConfigurationParser}
8
+ */
9
+ const tomlParse = (text) => parse(text);
10
+
11
+ export default tomlParse;
package/schema/markdownlint-cli2-config-schema.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$id": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.20.0/schema/markdownlint-cli2-config-schema.json",
3
+ "$id": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.22.0/schema/markdownlint-cli2-config-schema.json",
4
4
  "title": "markdownlint-cli2 configuration schema",
5
5
  "type": "object",
6
6
  "properties": {
7
7
  "$schema": {
8
8
  "description": "JSON Schema URI (expected by some editors)",
9
9
  "type": "string",
10
- "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.20.0/schema/markdownlint-cli2-config-schema.json"
10
+ "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.22.0/schema/markdownlint-cli2-config-schema.json"
11
11
  },
12
12
  "config": {
13
13
  "description": "markdownlint configuration schema : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/schema/.markdownlint.jsonc",
@@ -15,7 +15,7 @@
15
15
  "default": {}
16
16
  },
17
17
  "customRules": {
18
- "description": "Module names or paths of custom rules to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
18
+ "description": "Module names or paths of custom rules to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
19
19
  "type": "array",
20
20
  "default": [],
21
21
  "items": {
@@ -25,18 +25,18 @@
25
25
  }
26
26
  },
27
27
  "fix": {
28
- "description": "Whether to enable fixing of linting errors reported by rules that emit fix information : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
28
+ "description": "Whether to enable fixing of linting errors reported by rules that emit fix information : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
29
29
  "type": "boolean",
30
30
  "default": false
31
31
  },
32
32
  "frontMatter": {
33
- "description": "Regular expression used to match and ignore any front matter at the beginning of a document : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
33
+ "description": "Regular expression used to match and ignore any front matter at the beginning of a document : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
34
34
  "type": "string",
35
35
  "minLength": 1,
36
36
  "default": ""
37
37
  },
38
38
  "gitignore": {
39
- "description": "Whether to ignore files referenced by .gitignore (or glob expression) (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
39
+ "description": "Whether to ignore files referenced by .gitignore (or glob expression) (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
40
40
  "type": [
41
41
  "boolean",
42
42
  "string"
@@ -44,7 +44,7 @@
44
44
  "default": false
45
45
  },
46
46
  "globs": {
47
- "description": "Glob expressions to include when linting (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
47
+ "description": "Glob expressions to include when linting (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
48
48
  "type": "array",
49
49
  "default": [],
50
50
  "items": {
@@ -54,7 +54,7 @@
54
54
  }
55
55
  },
56
56
  "ignores": {
57
- "description": "Glob expressions to ignore when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
57
+ "description": "Glob expressions to ignore when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
58
58
  "type": "array",
59
59
  "default": [],
60
60
  "items": {
@@ -64,7 +64,7 @@
64
64
  }
65
65
  },
66
66
  "markdownItPlugins": {
67
- "description": "markdown-it plugins to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
67
+ "description": "markdown-it plugins to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
68
68
  "type": "array",
69
69
  "default": [],
70
70
  "items": {
@@ -84,7 +84,7 @@
84
84
  }
85
85
  },
86
86
  "modulePaths": {
87
- "description": "Additional paths to resolve module locations from : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
87
+ "description": "Additional paths to resolve module locations from : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
88
88
  "type": "array",
89
89
  "default": [],
90
90
  "items": {
@@ -94,22 +94,22 @@
94
94
  }
95
95
  },
96
96
  "noBanner": {
97
- "description": "Whether to disable the display of the banner message and version numbers on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
97
+ "description": "Whether to disable the display of the banner message and version numbers on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
98
98
  "type": "boolean",
99
99
  "default": false
100
100
  },
101
101
  "noInlineConfig": {
102
- "description": "Whether to disable support of HTML comments within Markdown content : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
102
+ "description": "Whether to disable support of HTML comments within Markdown content : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
103
103
  "type": "boolean",
104
104
  "default": false
105
105
  },
106
106
  "noProgress": {
107
- "description": "Whether to disable the display of progress on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
107
+ "description": "Whether to disable the display of progress on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
108
108
  "type": "boolean",
109
109
  "default": false
110
110
  },
111
111
  "outputFormatters": {
112
- "description": "Output formatters to load and use to customize markdownlint-cli2 output (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
112
+ "description": "Output formatters to load and use to customize markdownlint-cli2 output (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
113
113
  "type": "array",
114
114
  "default": [],
115
115
  "items": {
@@ -129,7 +129,7 @@
129
129
  }
130
130
  },
131
131
  "showFound": {
132
- "description": "Whether to show the list of found files on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.20.0/README.md#markdownlint-cli2jsonc",
132
+ "description": "Whether to show the list of found files on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.22.0/README.md#markdownlint-cli2jsonc",
133
133
  "type": "boolean",
134
134
  "default": false
135
135
  }