markdownlint-cli2 0.12.0 → 0.12.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.12.1
+
+- Update JSONC parsing to handle trailing commas
+- Add documentation links to JSON schema
+- Update dependencies
+
 ## 0.12.0
 
 - Remove deprecated `markdownlint-cli2-config` entry point

package/README.md

@@ -147,7 +147,7 @@ A container image [`davidanson/markdownlint-cli2`][docker-hub-markdownlint-cli2]
 can also be used (e.g., as part of a CI pipeline):
 
 ```bash
-docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.12.0 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.12.1 "**/*.md" "#node_modules"
 ```
 
 Notes:
@@ -164,7 +164,7 @@ Notes:
   - A custom working directory can be specified with Docker's `-w` flag:
 
     ```bash
-    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.12.0 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.12.1 "**/*.md" "#node_modules"
     ```
 
 For convenience, the container image
@@ -396,7 +396,7 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 
 ```yaml
 - repo: https://github.com/DavidAnson/markdownlint-cli2
-  rev: v0.12.0
+  rev: v0.12.1
   hooks:
   - id: markdownlint-cli2
 ```

package/markdownlint-cli2.js

@@ -26,7 +26,7 @@ const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.12.0";
+const packageVersion = "0.12.1";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
 const dotOnlySubstitute = "*.{md,markdown}";
@@ -35,12 +35,18 @@ const utf8 = "utf8";
 // No-op function
 const noop = () => null;
 
-// Gets a synchronous function to parse JSONC text
-const getJsoncParse = async () => {
-  const { "default": stripJsonComments } =
-    // eslint-disable-next-line no-inline-comments
-    await import(/* webpackMode: "eager" */ "strip-json-comments");
-  return (text) => JSON.parse(stripJsonComments(text));
+// Synchronous function to parse JSONC text
+const jsoncParse = (text) => {
+  const { parse, printParseErrorCode } = require("jsonc-parser");
+  const errors = [];
+  const result = parse(text, errors, { "allowTrailingComma": true });
+  if (errors.length > 0) {
+    const aggregate = errors.map(
+      (err) => `${printParseErrorCode(err.error)} (offset ${err.offset}, length ${err.length})`
+    ).join(", ");
+    throw new Error(`Unable to parse JSON(C) content, ${aggregate}`);
+  }
+  return result;
 };
 
 // Synchronous function to parse YAML text
@@ -67,12 +73,10 @@ const readConfig = (fs, dir, name, otherwise) => {
   const file = pathPosix.join(dir, name);
   return () => fs.promises.access(file).
     then(
-      () => getJsoncParse().then(
-        (jsoncParse) => markdownlintReadConfig(
-          file,
-          [ jsoncParse, yamlParse ],
-          fs
-        )
+      () => markdownlintReadConfig(
+        file,
+        [ jsoncParse, yamlParse ],
+        fs
       ),
       otherwise
     );
@@ -139,9 +143,8 @@ const importOrRequireConfig = (fs, dir, name, noRequire, otherwise) => {
 };
 
 // Extend a config object if it has 'extends' property
-const getExtendedConfig = async (config, configPath, fs) => {
+const getExtendedConfig = (config, configPath, fs) => {
   if (config.extends) {
-    const jsoncParse = await getJsoncParse();
     return markdownlintExtendConfig(
       config,
       configPath,
@@ -150,7 +153,7 @@ const getExtendedConfig = async (config, configPath, fs) => {
     );
   }
 
-  return config;
+  return Promise.resolve(config);
 };
 
 // Read an options or config file in any format and return the object
@@ -160,7 +163,6 @@ const readOptionsOrConfig = async (configPath, fs, noRequire) => {
   let options = null;
   let config = null;
   if (basename.endsWith(".markdownlint-cli2.jsonc")) {
-    const jsoncParse = await getJsoncParse();
     options = jsoncParse(await fs.promises.readFile(configPath, utf8));
   } else if (basename.endsWith(".markdownlint-cli2.yaml")) {
     options = yamlParse(await fs.promises.readFile(configPath, utf8));
@@ -177,7 +179,6 @@ const readOptionsOrConfig = async (configPath, fs, noRequire) => {
     basename.endsWith(".markdownlint.yaml") ||
     basename.endsWith(".markdownlint.yml")
   ) {
-    const jsoncParse = await getJsoncParse();
     config =
       await markdownlintReadConfig(configPath, [ jsoncParse, yamlParse ], fs);
   } else if (
@@ -319,10 +320,7 @@ const getAndProcessDirInfo = (
         then(
           () => fs.promises.
             readFile(markdownlintCli2Jsonc, utf8).
-            then(
-              (content) => getJsoncParse().
-                then((jsoncParse) => jsoncParse(content))
-            ),
+            then(jsoncParse),
           () => fs.promises.access(markdownlintCli2Yaml).
             then(
               () => fs.promises.
@@ -346,11 +344,8 @@ const getAndProcessDirInfo = (
                     then(
                       () => fs.promises.
                         readFile(packageJson, utf8).
-                        then(
-                          (content) => getJsoncParse().
-                            then((jsoncParse) => jsoncParse(content)).
-                            then((obj) => obj[packageName])
-                        ),
+                        then(jsoncParse).
+                        then((obj) => obj[packageName]),
                       noop
                     )
                 )
@@ -743,8 +738,7 @@ const createDirInfos = async (
 };
 
 // Lint files in groups by shared configuration
-const lintFiles = async (fs, dirInfos, fileContents) => {
-  const jsoncParse = await getJsoncParse();
+const lintFiles = (fs, dirInfos, fileContents) => {
   const tasks = [];
   // For each dirInfo
   for (const dirInfo of dirInfos) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
@@ -33,7 +33,7 @@
     "lint-watch": "git ls-files | entr npm run lint",
     "schema": "cpy ./node_modules/markdownlint/schema/markdownlint-config-schema.json ./schema --flat",
     "test": "ava --timeout=1m test/append-to-array-test.js test/fs-mock-test.js test/markdownlint-cli2-test.js test/markdownlint-cli2-test-exec.js test/markdownlint-cli2-test-fs.js test/markdownlint-cli2-test-main.js test/merge-options-test.js test/resolve-and-require-test.js",
-    "test-cover": "c8 --100 npm test -- --concurrency=1",
+    "test-cover": "c8 --100 npm test",
     "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\"",
     "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\"",
     "test-docker-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:v$VERSION \"*.md\"",
@@ -63,17 +63,17 @@
   ],
   "dependencies": {
     "globby": "14.0.0",
+    "jsonc-parser": "3.2.0",
     "markdownlint": "0.33.0",
     "markdownlint-cli2-formatter-default": "0.0.4",
     "micromatch": "4.0.5",
-    "strip-json-comments": "5.0.1",
     "yaml": "2.3.4"
   },
   "devDependencies": {
     "@iktakahiro/markdown-it-katex": "4.0.1",
     "ajv": "8.12.0",
     "ava": "6.0.1",
-    "c8": "9.0.0",
+    "c8": "9.1.0",
     "cpy": "11.0.0",
     "cpy-cli": "5.0.0",
     "del": "7.1.0",

package/schema/markdownlint-cli2-config-schema.json

@@ -1,21 +1,21 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.12.0/schema/markdownlint-cli2-config-schema.json",
+  "$id": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.12.1/schema/markdownlint-cli2-config-schema.json",
   "title": "markdownlint-cli2 configuration schema",
   "type": "object",
   "properties": {
     "$schema": {
       "description": "JSON Schema URI (expected by some editors)",
       "type": "string",
-      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.12.0/schema/markdownlint-cli2-config-schema.json"
+      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.12.1/schema/markdownlint-cli2-config-schema.json"
     },
     "config": {
-      "description": "markdownlint-cli2 configuration schema",
+      "description": "markdownlint configuration schema : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/schema/.markdownlint.jsonc",
       "$ref": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.33.0/schema/markdownlint-config-schema.json",
       "default": {}
     },
     "customRules": {
-      "description": "Module names or paths of custom rules to load and use when linting",
+      "description": "Module names or paths of custom rules to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -25,18 +25,18 @@
       }
     },
     "fix": {
-      "description": "Whether to enable fixing of linting errors reported by rules that emit fix information",
+      "description": "Whether to enable fixing of linting errors reported by rules that emit fix information : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     },
     "frontMatter": {
-      "description": "Regular expression used to match and ignore any front matter at the beginning of a document",
+      "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.12.1/README.md#markdownlint-cli2jsonc",
       "type": "string",
       "minLength": 1,
       "default": ""
     },
     "globs": {
-      "description": "Glob expressions to include when linting (only valid at the root)",
+      "description": "Glob expressions to include when linting (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -46,7 +46,7 @@
       }
     },
     "ignores": {
-      "description": "Glob expressions to ignore when linting",
+      "description": "Glob expressions to ignore when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -56,7 +56,7 @@
       }
     },
     "markdownItPlugins": {
-      "description": "markdown-it plugins to load and use when linting",
+      "description": "markdown-it plugins to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -76,7 +76,7 @@
       }
     },
     "modulePaths": {
-      "description": "Additional paths to resolve module locations from",
+      "description": "Additional paths to resolve module locations from : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -86,17 +86,17 @@
       }
     },
     "noInlineConfig": {
-      "description": "Whether to disable support of HTML comments within Markdown content",
+      "description": "Whether to disable support of HTML comments within Markdown content : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     },
     "noProgress": {
-      "description": "Whether to disable the display of progress on stdout (only valid at the root)",
+      "description": "Whether to disable the display of progress on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     },
     "outputFormatters": {
-      "description": "Output formatters to load and use to customize markdownlint-cli2 output (only valid at the root)",
+      "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.12.1/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -116,7 +116,7 @@
       }
     },
     "showFound": {
-      "description": "Whether to show the list of found files on stdout (only valid at the root)",
+      "description": "Whether to show the list of found files on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     }