@jpeakai/mermaidjs-lint 0.6.1 → 0.6.3

package/dist/bin.js

@@ -9,7 +9,7 @@ import { parseArgs } from "node:util";
 // package.json
 var package_default = {
   name: "@jpeakai/mermaidjs-lint",
-  version: "0.6.1",
+  version: "0.6.3",
   type: "module",
   description: "Deterministic lint gates and verified fixers for Mermaid diagrams in markdown",
   license: "MIT",
@@ -2828,7 +2828,7 @@ var setUp = async ({
 // src/cli.ts
 var SYNOPSIS = `usage: mermaidjs-lint <path...> [--fix] [--json] [--preset NAME] [--profile NAME] [--config FILE]
                      [--canvas-light COLOUR] [--canvas-dark COLOUR] [--no-plugins | --lenient-plugins]
-       mermaidjs-lint --list-rules
+       mermaidjs-lint --list-rules [--config FILE] [--no-plugins | --lenient-plugins]
        mermaidjs-lint --validate-plugins [--json] [--config FILE]
        mermaidjs-lint --version | -h, --help`;
 var ruleRow = (r, width) => `${`${r.id}${r.fix ? "*" : ""}`.padEnd(width)}  ${r.summary}`;
@@ -2869,7 +2869,7 @@ Plugins load on their own from .mermaidjs-lint/rules, from dependencies named me
 --lenient-plugins skips a plugin that fails to load and says so, instead of stopping the run.
 --validate-plugins imports and checks every plugin, reports every failure, and runs no check or fix.
 --list-rules prints every active rule by category, including plugin rules, and where each plugin came from.
-  It imports the plugins to list them.
+  It imports the plugins to list them, and takes no path or other flag.
 --version prints the version, to quote in a bug report.
 Exits 0 when no findings remain, 1 when findings remain, a plugin fails to load or the run fails (a lenient run
 skips a broken plugin, so it alone does not exit 1), and 2 on a usage error.`;
@@ -3004,6 +3004,15 @@ var run = async (argv, cwd) => {
   if (validating && (values["no-plugins"] || values.fix || listing)) {
     throw new FlagError("--validate-plugins", "--validate-plugins takes no --no-plugins, --fix or --list-rules");
   }
+  if (listing && !validating) {
+    const ignored = [
+      ...["fix", "json", "preset", "profile", "canvas-light", "canvas-dark"].filter((name) => values[name] !== undefined && values[name] !== false).map((name) => `--${name}`),
+      ...positionals.length > 0 ? ["a path"] : []
+    ];
+    if (ignored.length > 0) {
+      throw new FlagError("--list-rules", `--list-rules takes only --config and --no-plugins or --lenient-plugins, not ${ignored.join(", ")}`);
+    }
+  }
   if (validating && positionals.length > 0) {
     throw new FlagError("files", "--validate-plugins runs no check, so it takes no files");
   }
@@ -3043,9 +3052,9 @@ var run = async (argv, cwd) => {
     throw new FlagError("files", "no matching files");
   if (values.fix)
     await refuseOutsideLinks(files, root, cwd);
-  const setAside = files.filter((file) => canvasSetAside(file, flags, registry));
+  const setAside = files.filter((file) => canvasSetAside(file, flags, registry)).map((f) => display(f, cwd));
   if (setAside.length > 0) {
-    console.error(`mermaidjs-lint: config canvas set aside for ${plural(setAside.length, "file")} scored under mkdocs-material: ${setAside.map((f) => display(f, cwd)).join(", ")}`);
+    console.error(`mermaidjs-lint: config canvas set aside for ${plural(setAside.length, "file")} scored under mkdocs-material: ${setAside.join(", ")}`);
   }
   const perFile = await Promise.all(files.map(async (file) => {
     let src = await readFile3(file, "utf8");
@@ -3068,7 +3077,7 @@ var run = async (argv, cwd) => {
       code: f.error.code,
       message: reasonOf(f)
     }));
-    console.log(JSON.stringify({ findings: all, files: files.length, plugins: registry.sources, skippedPlugins }, null, 2));
+    console.log(JSON.stringify({ findings: all, files: files.length, plugins: registry.sources, skippedPlugins, canvasSetAside: setAside }, null, 2));
   } else {
     for (const f of all)
       console.log(reportLine(f, f.file));

package/dist/index.js

@@ -2023,7 +2023,7 @@ import { parseArgs } from "node:util";
 // package.json
 var package_default = {
   name: "@jpeakai/mermaidjs-lint",
-  version: "0.6.1",
+  version: "0.6.3",
   type: "module",
   description: "Deterministic lint gates and verified fixers for Mermaid diagrams in markdown",
   license: "MIT",
@@ -2828,7 +2828,7 @@ var setUp = async ({
 // src/cli.ts
 var SYNOPSIS = `usage: mermaidjs-lint <path...> [--fix] [--json] [--preset NAME] [--profile NAME] [--config FILE]
                      [--canvas-light COLOUR] [--canvas-dark COLOUR] [--no-plugins | --lenient-plugins]
-       mermaidjs-lint --list-rules
+       mermaidjs-lint --list-rules [--config FILE] [--no-plugins | --lenient-plugins]
        mermaidjs-lint --validate-plugins [--json] [--config FILE]
        mermaidjs-lint --version | -h, --help`;
 var ruleRow = (r, width) => `${`${r.id}${r.fix ? "*" : ""}`.padEnd(width)}  ${r.summary}`;
@@ -2869,7 +2869,7 @@ Plugins load on their own from .mermaidjs-lint/rules, from dependencies named me
 --lenient-plugins skips a plugin that fails to load and says so, instead of stopping the run.
 --validate-plugins imports and checks every plugin, reports every failure, and runs no check or fix.
 --list-rules prints every active rule by category, including plugin rules, and where each plugin came from.
-  It imports the plugins to list them.
+  It imports the plugins to list them, and takes no path or other flag.
 --version prints the version, to quote in a bug report.
 Exits 0 when no findings remain, 1 when findings remain, a plugin fails to load or the run fails (a lenient run
 skips a broken plugin, so it alone does not exit 1), and 2 on a usage error.`;
@@ -3004,6 +3004,15 @@ var run = async (argv, cwd) => {
   if (validating && (values["no-plugins"] || values.fix || listing)) {
     throw new FlagError("--validate-plugins", "--validate-plugins takes no --no-plugins, --fix or --list-rules");
   }
+  if (listing && !validating) {
+    const ignored = [
+      ...["fix", "json", "preset", "profile", "canvas-light", "canvas-dark"].filter((name) => values[name] !== undefined && values[name] !== false).map((name) => `--${name}`),
+      ...positionals.length > 0 ? ["a path"] : []
+    ];
+    if (ignored.length > 0) {
+      throw new FlagError("--list-rules", `--list-rules takes only --config and --no-plugins or --lenient-plugins, not ${ignored.join(", ")}`);
+    }
+  }
   if (validating && positionals.length > 0) {
     throw new FlagError("files", "--validate-plugins runs no check, so it takes no files");
   }
@@ -3043,9 +3052,9 @@ var run = async (argv, cwd) => {
     throw new FlagError("files", "no matching files");
   if (values.fix)
     await refuseOutsideLinks(files, root, cwd);
-  const setAside = files.filter((file) => canvasSetAside(file, flags, registry));
+  const setAside = files.filter((file) => canvasSetAside(file, flags, registry)).map((f) => display(f, cwd));
   if (setAside.length > 0) {
-    console.error(`mermaidjs-lint: config canvas set aside for ${plural(setAside.length, "file")} scored under mkdocs-material: ${setAside.map((f) => display(f, cwd)).join(", ")}`);
+    console.error(`mermaidjs-lint: config canvas set aside for ${plural(setAside.length, "file")} scored under mkdocs-material: ${setAside.join(", ")}`);
   }
   const perFile = await Promise.all(files.map(async (file) => {
     let src = await readFile3(file, "utf8");
@@ -3068,7 +3077,7 @@ var run = async (argv, cwd) => {
       code: f.error.code,
       message: reasonOf(f)
     }));
-    console.log(JSON.stringify({ findings: all, files: files.length, plugins: registry.sources, skippedPlugins }, null, 2));
+    console.log(JSON.stringify({ findings: all, files: files.length, plugins: registry.sources, skippedPlugins, canvasSetAside: setAside }, null, 2));
   } else {
     for (const f of all)
       console.log(reportLine(f, f.file));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jpeakai/mermaidjs-lint",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "type": "module",
   "description": "Deterministic lint gates and verified fixers for Mermaid diagrams in markdown",
   "license": "MIT",

package/src/cli.ts

@@ -22,7 +22,7 @@ import { CATEGORIES, type Finding, type Rule } from "./rules/types.ts";
 // buried, and first in --help.
 const SYNOPSIS = `usage: mermaidjs-lint <path...> [--fix] [--json] [--preset NAME] [--profile NAME] [--config FILE]
                      [--canvas-light COLOUR] [--canvas-dark COLOUR] [--no-plugins | --lenient-plugins]
-       mermaidjs-lint --list-rules
+       mermaidjs-lint --list-rules [--config FILE] [--no-plugins | --lenient-plugins]
        mermaidjs-lint --validate-plugins [--json] [--config FILE]
        mermaidjs-lint --version | -h, --help`;
 
@@ -68,7 +68,7 @@ Plugins load on their own from .mermaidjs-lint/rules, from dependencies named me
 --lenient-plugins skips a plugin that fails to load and says so, instead of stopping the run.
 --validate-plugins imports and checks every plugin, reports every failure, and runs no check or fix.
 --list-rules prints every active rule by category, including plugin rules, and where each plugin came from.
-  It imports the plugins to list them.
+  It imports the plugins to list them, and takes no path or other flag.
 --version prints the version, to quote in a bug report.
 Exits 0 when no findings remain, 1 when findings remain, a plugin fails to load or the run fails (a lenient run
 skips a broken plugin, so it alone does not exit 1), and 2 on a usage error.`;
@@ -246,6 +246,22 @@ const run = async (argv: string[], cwd: string): Promise<number> => {
   if (validating && (values["no-plugins"] || values.fix || listing)) {
     throw new FlagError("--validate-plugins", "--validate-plugins takes no --no-plugins, --fix or --list-rules");
   }
+  // --list-rules prints the rules the config and the plugin flags leave
+  // active. Any other flag or a path would be silently ignored, so it is refused.
+  if (listing && !validating) {
+    const ignored = [
+      ...(["fix", "json", "preset", "profile", "canvas-light", "canvas-dark"] as const)
+        .filter((name) => values[name] !== undefined && values[name] !== false)
+        .map((name) => `--${name}`),
+      ...(positionals.length > 0 ? ["a path"] : []),
+    ];
+    if (ignored.length > 0) {
+      throw new FlagError(
+        "--list-rules",
+        `--list-rules takes only --config and --no-plugins or --lenient-plugins, not ${ignored.join(", ")}`,
+      );
+    }
+  }
   if (validating && positionals.length > 0) {
     throw new FlagError("files", "--validate-plugins runs no check, so it takes no files");
   }
@@ -284,11 +300,12 @@ const run = async (argv: string[], cwd: string): Promise<number> => {
 
   // A config canvas is set aside for a file the auto profile reads as
   // mkdocs-material, and one line names every such file, so the run says what
-  // it scored without the canvas.
-  const setAside = files.filter((file) => canvasSetAside(file, flags, registry));
+  // it scored without the canvas. The --json object carries the same paths, so
+  // a job that reads only stdout still learns the canvas was dropped.
+  const setAside = files.filter((file) => canvasSetAside(file, flags, registry)).map((f) => display(f, cwd));
   if (setAside.length > 0) {
     console.error(
-      `mermaidjs-lint: config canvas set aside for ${plural(setAside.length, "file")} scored under mkdocs-material: ${setAside.map((f) => display(f, cwd)).join(", ")}`,
+      `mermaidjs-lint: config canvas set aside for ${plural(setAside.length, "file")} scored under mkdocs-material: ${setAside.join(", ")}`,
     );
   }
 
@@ -321,7 +338,11 @@ const run = async (argv: string[], cwd: string): Promise<number> => {
       message: reasonOf(f),
     }));
     console.log(
-      JSON.stringify({ findings: all, files: files.length, plugins: registry.sources, skippedPlugins }, null, 2),
+      JSON.stringify(
+        { findings: all, files: files.length, plugins: registry.sources, skippedPlugins, canvasSetAside: setAside },
+        null,
+        2,
+      ),
     );
   } else {
     for (const f of all) console.log(reportLine(f, f.file));