@jpeakai/mermaidjs-lint 0.4.0 → 0.4.1

package/dist/bin.js

@@ -9,7 +9,7 @@ import { parseArgs } from "node:util";
 // package.json
 var package_default = {
   name: "@jpeakai/mermaidjs-lint",
-  version: "0.4.0",
+  version: "0.4.1",
   type: "module",
   description: "Deterministic lint gates and verified fixers for Mermaid diagrams in markdown",
   license: "MIT",
@@ -79,6 +79,184 @@ var package_default = {
   }
 };
 
+// src/errors.ts
+class MermaidLintError extends Error {
+  code;
+  constructor(code, message) {
+    super(message);
+    this.code = code;
+    this.name = new.target.name;
+  }
+}
+
+class UsageError extends MermaidLintError {
+  constructor(message, code = "usage") {
+    super(code, message);
+  }
+}
+
+class FlagError extends UsageError {
+  flag;
+  constructor(flag, message) {
+    super(message, "flag");
+    this.flag = flag;
+  }
+}
+
+class ConfigFileError extends UsageError {
+  file;
+  constructor(file, message) {
+    super(`${file}: ${message}`, "config-file");
+    this.file = file;
+  }
+}
+
+class ConfigNotFoundError extends UsageError {
+  path;
+  constructor(path) {
+    super(`--config ${path}: no such file`, "config-not-found");
+    this.path = path;
+  }
+}
+
+class ConfigCodeError extends UsageError {
+  file;
+  constructor(file) {
+    super(`${file}: a .mjs config is code, and --no-plugins runs no project code; pass --config with a .json config, or drop --no-plugins`, "config-code");
+    this.file = file;
+  }
+}
+
+class AmbiguousConfigError extends UsageError {
+  files;
+  constructor(root, files) {
+    super(`more than one config file at ${root}: ${files.join(", ")}`, "config-ambiguous");
+    this.files = files;
+  }
+}
+
+class ConfigShapeError extends UsageError {
+  file;
+  key;
+  constructor(file, message, key = null) {
+    super(`${file}: ${message}`, "config-shape");
+    this.file = file;
+    this.key = key;
+  }
+}
+
+class RuleSettingError extends UsageError {
+  file;
+  rule;
+  constructor(file, rule, message) {
+    super(`${file}: rule "${rule}" ${message}`, "rule-setting");
+    this.file = file;
+    this.rule = rule;
+  }
+}
+
+class UnknownRuleError extends UsageError {
+  file;
+  rule;
+  known;
+  constructor(file, rule, known) {
+    super(`${file}: unknown rule "${rule}"; a retired or misspelt id cannot be switched off. Known rules: ${known.join(", ")}`, "unknown-rule");
+    this.file = file;
+    this.rule = rule;
+    this.known = known;
+  }
+}
+
+class RuleOptionError extends UsageError {
+  file;
+  rule;
+  option;
+  constructor(file, rule, option, message) {
+    super(`${file}: ${message}`, "rule-option");
+    this.file = file;
+    this.rule = rule;
+    this.option = option;
+  }
+}
+
+class FixOutsideRootError extends UsageError {
+  file;
+  target;
+  constructor(file, target, root) {
+    super(`${file} is a symbolic link to ${target}, outside the project root ${root}; --fix does not write through it. Fix the target in its own project, or run on the target path itself`, "fix-outside-root");
+    this.file = file;
+    this.target = target;
+  }
+}
+
+class PackageJsonError extends MermaidLintError {
+  file;
+  constructor(file) {
+    super("package-json", `${file} is not a JSON object; fix or remove it`);
+    this.file = file;
+  }
+}
+
+class FixNotConvergingError extends MermaidLintError {
+  file;
+  rules;
+  constructor(file, passes, rules) {
+    super("fix-not-converging", `${file}: --fix did not converge after ${passes} passes; ${rules.join(", ")} kept proposing edits. A fixer must propose nothing once its edit is applied`);
+    this.file = file;
+    this.rules = rules;
+  }
+}
+
+class PluginLoadError extends MermaidLintError {
+  source;
+  constructor(source, reason, code = "plugin") {
+    super(code, `plugin ${source}: ${reason}`);
+    this.source = source;
+  }
+}
+
+class PluginImportError extends PluginLoadError {
+  constructor(source, reason) {
+    super(source, `could not be imported: ${reason}`, "plugin-import");
+  }
+}
+
+class PluginContractError extends PluginLoadError {
+  constructor(source, reason) {
+    super(source, reason, "plugin-contract");
+  }
+}
+
+class PluginConflictError extends PluginLoadError {
+  other;
+  constructor(source, other, reason) {
+    super(source, reason, "plugin-conflict");
+    this.other = other;
+  }
+}
+
+class PluginNotInstalledError extends PluginLoadError {
+  root;
+  constructor(source, root) {
+    super(source, `is declared or listed but not installed; looked from ${root} upward. Install it, or remove it`, "plugin-not-installed");
+    this.root = root;
+  }
+}
+
+class PluginSourceError extends PluginLoadError {
+  constructor(source, reason) {
+    super(source, reason, "plugin-source");
+  }
+}
+
+class PluginFixerError extends MermaidLintError {
+  rule;
+  constructor(rule, reason) {
+    super("plugin-fixer", `plugin rule ${rule} ${reason}`);
+    this.rule = rule;
+  }
+}
+
 // src/model.ts
 import { fromMarkdown } from "mdast-util-from-markdown";
 import { frontmatterFromMarkdown } from "mdast-util-frontmatter";
@@ -854,184 +1032,6 @@ var buildDocModel = (src, kind = "markdown") => {
   return { src, kind, tree, diagrams };
 };
 
-// src/errors.ts
-class MermaidLintError extends Error {
-  code;
-  constructor(code, message) {
-    super(message);
-    this.code = code;
-    this.name = new.target.name;
-  }
-}
-
-class UsageError extends MermaidLintError {
-  constructor(message, code = "usage") {
-    super(code, message);
-  }
-}
-
-class FlagError extends UsageError {
-  flag;
-  constructor(flag, message) {
-    super(message, "flag");
-    this.flag = flag;
-  }
-}
-
-class ConfigFileError extends UsageError {
-  file;
-  constructor(file, message) {
-    super(`${file}: ${message}`, "config-file");
-    this.file = file;
-  }
-}
-
-class ConfigNotFoundError extends UsageError {
-  path;
-  constructor(path) {
-    super(`--config ${path}: no such file`, "config-not-found");
-    this.path = path;
-  }
-}
-
-class ConfigCodeError extends UsageError {
-  file;
-  constructor(file) {
-    super(`${file}: a .mjs config is code, and --no-plugins runs no project code; pass --config with a .json config, or drop --no-plugins`, "config-code");
-    this.file = file;
-  }
-}
-
-class AmbiguousConfigError extends UsageError {
-  files;
-  constructor(root, files) {
-    super(`more than one config file at ${root}: ${files.join(", ")}`, "config-ambiguous");
-    this.files = files;
-  }
-}
-
-class ConfigShapeError extends UsageError {
-  file;
-  key;
-  constructor(file, message, key = null) {
-    super(`${file}: ${message}`, "config-shape");
-    this.file = file;
-    this.key = key;
-  }
-}
-
-class RuleSettingError extends UsageError {
-  file;
-  rule;
-  constructor(file, rule, message) {
-    super(`${file}: rule "${rule}" ${message}`, "rule-setting");
-    this.file = file;
-    this.rule = rule;
-  }
-}
-
-class UnknownRuleError extends UsageError {
-  file;
-  rule;
-  known;
-  constructor(file, rule, known) {
-    super(`${file}: unknown rule "${rule}"; a retired or misspelt id cannot be switched off. Known rules: ${known.join(", ")}`, "unknown-rule");
-    this.file = file;
-    this.rule = rule;
-    this.known = known;
-  }
-}
-
-class RuleOptionError extends UsageError {
-  file;
-  rule;
-  option;
-  constructor(file, rule, option, message) {
-    super(`${file}: ${message}`, "rule-option");
-    this.file = file;
-    this.rule = rule;
-    this.option = option;
-  }
-}
-
-class FixOutsideRootError extends UsageError {
-  file;
-  target;
-  constructor(file, target, root) {
-    super(`${file} is a symbolic link to ${target}, outside the project root ${root}; --fix does not write through it. Fix the target in its own project, or run on the target path itself`, "fix-outside-root");
-    this.file = file;
-    this.target = target;
-  }
-}
-
-class PackageJsonError extends MermaidLintError {
-  file;
-  constructor(file) {
-    super("package-json", `${file} is not a JSON object; fix or remove it`);
-    this.file = file;
-  }
-}
-
-class FixNotConvergingError extends MermaidLintError {
-  file;
-  rules;
-  constructor(file, passes, rules) {
-    super("fix-not-converging", `${file}: --fix did not converge after ${passes} passes; ${rules.join(", ")} kept proposing edits. A fixer must propose nothing once its edit is applied`);
-    this.file = file;
-    this.rules = rules;
-  }
-}
-
-class PluginLoadError extends MermaidLintError {
-  source;
-  constructor(source, reason, code = "plugin") {
-    super(code, `plugin ${source}: ${reason}`);
-    this.source = source;
-  }
-}
-
-class PluginImportError extends PluginLoadError {
-  constructor(source, reason) {
-    super(source, `could not be imported: ${reason}`, "plugin-import");
-  }
-}
-
-class PluginContractError extends PluginLoadError {
-  constructor(source, reason) {
-    super(source, reason, "plugin-contract");
-  }
-}
-
-class PluginConflictError extends PluginLoadError {
-  other;
-  constructor(source, other, reason) {
-    super(source, reason, "plugin-conflict");
-    this.other = other;
-  }
-}
-
-class PluginNotInstalledError extends PluginLoadError {
-  root;
-  constructor(source, root) {
-    super(source, `is declared or listed but not installed; looked from ${root} upward. Install it, or remove it`, "plugin-not-installed");
-    this.root = root;
-  }
-}
-
-class PluginSourceError extends PluginLoadError {
-  constructor(source, reason) {
-    super(source, reason, "plugin-source");
-  }
-}
-
-class PluginFixerError extends MermaidLintError {
-  rule;
-  constructor(rule, reason) {
-    super("plugin-fixer", `plugin rule ${rule} ${reason}`);
-    this.rule = rule;
-  }
-}
-
 // src/parse/contrast.ts
 import { existsSync } from "node:fs";
 import { dirname, join, resolve } from "node:path";
@@ -1827,6 +1827,15 @@ var buildRegistry = (input) => {
 var BUILTIN = buildRegistry({ rules: RULES, fixOrder: FIX_ORDER, categories: BUILTIN_CATEGORIES });
 
 // src/check.ts
+var checkRunFlags = (flags, prefix = "") => {
+  const { preset, profile } = flags;
+  if (preset !== undefined && canonicalPreset(preset) === null) {
+    throw new FlagError(`${prefix}preset`, `${prefix}preset must be one of ${PRESET_NAMES.join(", ")}, not "${preset}"`);
+  }
+  if (profile !== undefined && !PROFILES.includes(profile)) {
+    throw new FlagError(`${prefix}profile`, `${prefix}profile must be one of ${PROFILES.join(", ")}, not "${profile}"`);
+  }
+};
 var optionsFor = (rule, configured, flags) => {
   const options = { ...configured };
   for (const name of ["preset", "profile"]) {
@@ -1837,6 +1846,7 @@ var optionsFor = (rule, configured, flags) => {
   return options;
 };
 var checkModel = async (doc, file, flags = {}, registry = BUILTIN) => {
+  checkRunFlags(flags);
   const perRule = registry.rules.map((rule) => rule.check({ doc, file, options: optionsFor(rule, registry.options.get(rule.id), flags), helpers: HELPERS }));
   const findings = (await Promise.all(perRule)).flat();
   return findings.sort((a, b) => a.line - b.line || a.rule.localeCompare(b.rule));
@@ -1987,6 +1997,7 @@ var overlaps = (edits) => {
 };
 var wellFormed = (e, length) => Number.isInteger(e.start) && Number.isInteger(e.end) && e.start >= 0 && e.start <= e.end && e.end <= length && typeof e.text === "string";
 var fixSourceReport = async (src, file, flags = {}, registry = BUILTIN) => {
+  checkRunFlags(flags);
   const kind = documentKind(file);
   const applied = [];
   const refused = [];
@@ -2600,6 +2611,7 @@ Examples of every rule, with fixes: https://jpeakai.github.io/jpai-mermaidjs-lin
   numeric threshold set in the config overrides both.
 --profile NAME sets how contrast is read: ${PROFILES.join(", ")}. It overrides a profile set in the config.
   auto reads mkdocs-material when any parent folder holds mkdocs.yml or mkdocs.yaml, else github.
+--json prints one JSON object instead of text lines.
 --fix applies every fix it can prove safe, then reports what remains.
 A fixer that is unsure leaves the text alone and the finding stays.
 --config FILE reads that config instead of mermaidjs-lint.config.json or .mjs at the project root.
@@ -2727,12 +2739,7 @@ var run = async (argv, cwd) => {
   }
   const listing = values["list-rules"];
   const validating = values["validate-plugins"];
-  if (values.preset !== undefined && canonicalPreset(values.preset) === null) {
-    throw new FlagError("--preset", `--preset must be one of ${PRESET_NAMES.join(", ")}, not "${values.preset}"`);
-  }
-  if (values.profile !== undefined && !PROFILES.includes(values.profile)) {
-    throw new FlagError("--profile", `--profile must be one of ${PROFILES.join(", ")}, not "${values.profile}"`);
-  }
+  checkRunFlags({ preset: values.preset, profile: values.profile }, "--");
   if (values["no-plugins"] && values["lenient-plugins"]) {
     throw new FlagError("--lenient-plugins", "--no-plugins and --lenient-plugins contradict each other");
   }

package/dist/index.js

@@ -1,6 +1,184 @@
 import { createRequire } from "node:module";
 var __require = /* @__PURE__ */ createRequire(import.meta.url);
 
+// src/errors.ts
+class MermaidLintError extends Error {
+  code;
+  constructor(code, message) {
+    super(message);
+    this.code = code;
+    this.name = new.target.name;
+  }
+}
+
+class UsageError extends MermaidLintError {
+  constructor(message, code = "usage") {
+    super(code, message);
+  }
+}
+
+class FlagError extends UsageError {
+  flag;
+  constructor(flag, message) {
+    super(message, "flag");
+    this.flag = flag;
+  }
+}
+
+class ConfigFileError extends UsageError {
+  file;
+  constructor(file, message) {
+    super(`${file}: ${message}`, "config-file");
+    this.file = file;
+  }
+}
+
+class ConfigNotFoundError extends UsageError {
+  path;
+  constructor(path) {
+    super(`--config ${path}: no such file`, "config-not-found");
+    this.path = path;
+  }
+}
+
+class ConfigCodeError extends UsageError {
+  file;
+  constructor(file) {
+    super(`${file}: a .mjs config is code, and --no-plugins runs no project code; pass --config with a .json config, or drop --no-plugins`, "config-code");
+    this.file = file;
+  }
+}
+
+class AmbiguousConfigError extends UsageError {
+  files;
+  constructor(root, files) {
+    super(`more than one config file at ${root}: ${files.join(", ")}`, "config-ambiguous");
+    this.files = files;
+  }
+}
+
+class ConfigShapeError extends UsageError {
+  file;
+  key;
+  constructor(file, message, key = null) {
+    super(`${file}: ${message}`, "config-shape");
+    this.file = file;
+    this.key = key;
+  }
+}
+
+class RuleSettingError extends UsageError {
+  file;
+  rule;
+  constructor(file, rule, message) {
+    super(`${file}: rule "${rule}" ${message}`, "rule-setting");
+    this.file = file;
+    this.rule = rule;
+  }
+}
+
+class UnknownRuleError extends UsageError {
+  file;
+  rule;
+  known;
+  constructor(file, rule, known) {
+    super(`${file}: unknown rule "${rule}"; a retired or misspelt id cannot be switched off. Known rules: ${known.join(", ")}`, "unknown-rule");
+    this.file = file;
+    this.rule = rule;
+    this.known = known;
+  }
+}
+
+class RuleOptionError extends UsageError {
+  file;
+  rule;
+  option;
+  constructor(file, rule, option, message) {
+    super(`${file}: ${message}`, "rule-option");
+    this.file = file;
+    this.rule = rule;
+    this.option = option;
+  }
+}
+
+class FixOutsideRootError extends UsageError {
+  file;
+  target;
+  constructor(file, target, root) {
+    super(`${file} is a symbolic link to ${target}, outside the project root ${root}; --fix does not write through it. Fix the target in its own project, or run on the target path itself`, "fix-outside-root");
+    this.file = file;
+    this.target = target;
+  }
+}
+
+class PackageJsonError extends MermaidLintError {
+  file;
+  constructor(file) {
+    super("package-json", `${file} is not a JSON object; fix or remove it`);
+    this.file = file;
+  }
+}
+
+class FixNotConvergingError extends MermaidLintError {
+  file;
+  rules;
+  constructor(file, passes, rules) {
+    super("fix-not-converging", `${file}: --fix did not converge after ${passes} passes; ${rules.join(", ")} kept proposing edits. A fixer must propose nothing once its edit is applied`);
+    this.file = file;
+    this.rules = rules;
+  }
+}
+
+class PluginLoadError extends MermaidLintError {
+  source;
+  constructor(source, reason, code = "plugin") {
+    super(code, `plugin ${source}: ${reason}`);
+    this.source = source;
+  }
+}
+
+class PluginImportError extends PluginLoadError {
+  constructor(source, reason) {
+    super(source, `could not be imported: ${reason}`, "plugin-import");
+  }
+}
+
+class PluginContractError extends PluginLoadError {
+  constructor(source, reason) {
+    super(source, reason, "plugin-contract");
+  }
+}
+
+class PluginConflictError extends PluginLoadError {
+  other;
+  constructor(source, other, reason) {
+    super(source, reason, "plugin-conflict");
+    this.other = other;
+  }
+}
+
+class PluginNotInstalledError extends PluginLoadError {
+  root;
+  constructor(source, root) {
+    super(source, `is declared or listed but not installed; looked from ${root} upward. Install it, or remove it`, "plugin-not-installed");
+    this.root = root;
+  }
+}
+
+class PluginSourceError extends PluginLoadError {
+  constructor(source, reason) {
+    super(source, reason, "plugin-source");
+  }
+}
+
+class PluginFixerError extends MermaidLintError {
+  rule;
+  constructor(rule, reason) {
+    super("plugin-fixer", `plugin rule ${rule} ${reason}`);
+    this.rule = rule;
+  }
+}
+
 // src/model.ts
 import { fromMarkdown } from "mdast-util-from-markdown";
 import { frontmatterFromMarkdown } from "mdast-util-frontmatter";
@@ -776,184 +954,6 @@ var buildDocModel = (src, kind = "markdown") => {
   return { src, kind, tree, diagrams };
 };
 
-// src/errors.ts
-class MermaidLintError extends Error {
-  code;
-  constructor(code, message) {
-    super(message);
-    this.code = code;
-    this.name = new.target.name;
-  }
-}
-
-class UsageError extends MermaidLintError {
-  constructor(message, code = "usage") {
-    super(code, message);
-  }
-}
-
-class FlagError extends UsageError {
-  flag;
-  constructor(flag, message) {
-    super(message, "flag");
-    this.flag = flag;
-  }
-}
-
-class ConfigFileError extends UsageError {
-  file;
-  constructor(file, message) {
-    super(`${file}: ${message}`, "config-file");
-    this.file = file;
-  }
-}
-
-class ConfigNotFoundError extends UsageError {
-  path;
-  constructor(path) {
-    super(`--config ${path}: no such file`, "config-not-found");
-    this.path = path;
-  }
-}
-
-class ConfigCodeError extends UsageError {
-  file;
-  constructor(file) {
-    super(`${file}: a .mjs config is code, and --no-plugins runs no project code; pass --config with a .json config, or drop --no-plugins`, "config-code");
-    this.file = file;
-  }
-}
-
-class AmbiguousConfigError extends UsageError {
-  files;
-  constructor(root, files) {
-    super(`more than one config file at ${root}: ${files.join(", ")}`, "config-ambiguous");
-    this.files = files;
-  }
-}
-
-class ConfigShapeError extends UsageError {
-  file;
-  key;
-  constructor(file, message, key = null) {
-    super(`${file}: ${message}`, "config-shape");
-    this.file = file;
-    this.key = key;
-  }
-}
-
-class RuleSettingError extends UsageError {
-  file;
-  rule;
-  constructor(file, rule, message) {
-    super(`${file}: rule "${rule}" ${message}`, "rule-setting");
-    this.file = file;
-    this.rule = rule;
-  }
-}
-
-class UnknownRuleError extends UsageError {
-  file;
-  rule;
-  known;
-  constructor(file, rule, known) {
-    super(`${file}: unknown rule "${rule}"; a retired or misspelt id cannot be switched off. Known rules: ${known.join(", ")}`, "unknown-rule");
-    this.file = file;
-    this.rule = rule;
-    this.known = known;
-  }
-}
-
-class RuleOptionError extends UsageError {
-  file;
-  rule;
-  option;
-  constructor(file, rule, option, message) {
-    super(`${file}: ${message}`, "rule-option");
-    this.file = file;
-    this.rule = rule;
-    this.option = option;
-  }
-}
-
-class FixOutsideRootError extends UsageError {
-  file;
-  target;
-  constructor(file, target, root) {
-    super(`${file} is a symbolic link to ${target}, outside the project root ${root}; --fix does not write through it. Fix the target in its own project, or run on the target path itself`, "fix-outside-root");
-    this.file = file;
-    this.target = target;
-  }
-}
-
-class PackageJsonError extends MermaidLintError {
-  file;
-  constructor(file) {
-    super("package-json", `${file} is not a JSON object; fix or remove it`);
-    this.file = file;
-  }
-}
-
-class FixNotConvergingError extends MermaidLintError {
-  file;
-  rules;
-  constructor(file, passes, rules) {
-    super("fix-not-converging", `${file}: --fix did not converge after ${passes} passes; ${rules.join(", ")} kept proposing edits. A fixer must propose nothing once its edit is applied`);
-    this.file = file;
-    this.rules = rules;
-  }
-}
-
-class PluginLoadError extends MermaidLintError {
-  source;
-  constructor(source, reason, code = "plugin") {
-    super(code, `plugin ${source}: ${reason}`);
-    this.source = source;
-  }
-}
-
-class PluginImportError extends PluginLoadError {
-  constructor(source, reason) {
-    super(source, `could not be imported: ${reason}`, "plugin-import");
-  }
-}
-
-class PluginContractError extends PluginLoadError {
-  constructor(source, reason) {
-    super(source, reason, "plugin-contract");
-  }
-}
-
-class PluginConflictError extends PluginLoadError {
-  other;
-  constructor(source, other, reason) {
-    super(source, reason, "plugin-conflict");
-    this.other = other;
-  }
-}
-
-class PluginNotInstalledError extends PluginLoadError {
-  root;
-  constructor(source, root) {
-    super(source, `is declared or listed but not installed; looked from ${root} upward. Install it, or remove it`, "plugin-not-installed");
-    this.root = root;
-  }
-}
-
-class PluginSourceError extends PluginLoadError {
-  constructor(source, reason) {
-    super(source, reason, "plugin-source");
-  }
-}
-
-class PluginFixerError extends MermaidLintError {
-  rule;
-  constructor(rule, reason) {
-    super("plugin-fixer", `plugin rule ${rule} ${reason}`);
-    this.rule = rule;
-  }
-}
-
 // src/parse/contrast.ts
 import { existsSync } from "node:fs";
 import { dirname, join, resolve } from "node:path";
@@ -1749,6 +1749,15 @@ var buildRegistry = (input) => {
 var BUILTIN = buildRegistry({ rules: RULES, fixOrder: FIX_ORDER, categories: BUILTIN_CATEGORIES });
 
 // src/check.ts
+var checkRunFlags = (flags, prefix = "") => {
+  const { preset, profile } = flags;
+  if (preset !== undefined && canonicalPreset(preset) === null) {
+    throw new FlagError(`${prefix}preset`, `${prefix}preset must be one of ${PRESET_NAMES.join(", ")}, not "${preset}"`);
+  }
+  if (profile !== undefined && !PROFILES.includes(profile)) {
+    throw new FlagError(`${prefix}profile`, `${prefix}profile must be one of ${PROFILES.join(", ")}, not "${profile}"`);
+  }
+};
 var optionsFor = (rule, configured, flags) => {
   const options = { ...configured };
   for (const name of ["preset", "profile"]) {
@@ -1759,6 +1768,7 @@ var optionsFor = (rule, configured, flags) => {
   return options;
 };
 var checkModel = async (doc, file, flags = {}, registry = BUILTIN) => {
+  checkRunFlags(flags);
   const perRule = registry.rules.map((rule) => rule.check({ doc, file, options: optionsFor(rule, registry.options.get(rule.id), flags), helpers: HELPERS }));
   const findings = (await Promise.all(perRule)).flat();
   return findings.sort((a, b) => a.line - b.line || a.rule.localeCompare(b.rule));
@@ -1771,7 +1781,7 @@ import { parseArgs } from "node:util";
 // package.json
 var package_default = {
   name: "@jpeakai/mermaidjs-lint",
-  version: "0.4.0",
+  version: "0.4.1",
   type: "module",
   description: "Deterministic lint gates and verified fixers for Mermaid diagrams in markdown",
   license: "MIT",
@@ -1986,6 +1996,7 @@ var overlaps = (edits) => {
 };
 var wellFormed = (e, length) => Number.isInteger(e.start) && Number.isInteger(e.end) && e.start >= 0 && e.start <= e.end && e.end <= length && typeof e.text === "string";
 var fixSourceReport = async (src, file, flags = {}, registry = BUILTIN) => {
+  checkRunFlags(flags);
   const kind = documentKind(file);
   const applied = [];
   const refused = [];
@@ -2600,6 +2611,7 @@ Examples of every rule, with fixes: https://jpeakai.github.io/jpai-mermaidjs-lin
   numeric threshold set in the config overrides both.
 --profile NAME sets how contrast is read: ${PROFILES.join(", ")}. It overrides a profile set in the config.
   auto reads mkdocs-material when any parent folder holds mkdocs.yml or mkdocs.yaml, else github.
+--json prints one JSON object instead of text lines.
 --fix applies every fix it can prove safe, then reports what remains.
 A fixer that is unsure leaves the text alone and the finding stays.
 --config FILE reads that config instead of mermaidjs-lint.config.json or .mjs at the project root.
@@ -2727,12 +2739,7 @@ var run = async (argv, cwd) => {
   }
   const listing = values["list-rules"];
   const validating = values["validate-plugins"];
-  if (values.preset !== undefined && canonicalPreset(values.preset) === null) {
-    throw new FlagError("--preset", `--preset must be one of ${PRESET_NAMES.join(", ")}, not "${values.preset}"`);
-  }
-  if (values.profile !== undefined && !PROFILES.includes(values.profile)) {
-    throw new FlagError("--profile", `--profile must be one of ${PROFILES.join(", ")}, not "${values.profile}"`);
-  }
+  checkRunFlags({ preset: values.preset, profile: values.profile }, "--");
   if (values["no-plugins"] && values["lenient-plugins"]) {
     throw new FlagError("--lenient-plugins", "--no-plugins and --lenient-plugins contradict each other");
   }

package/dist/testing.js

@@ -1,6 +1,82 @@
 import { createRequire } from "node:module";
 var __require = /* @__PURE__ */ createRequire(import.meta.url);
 
+// src/errors.ts
+class MermaidLintError extends Error {
+  code;
+  constructor(code, message) {
+    super(message);
+    this.code = code;
+    this.name = new.target.name;
+  }
+}
+
+class UsageError extends MermaidLintError {
+  constructor(message, code = "usage") {
+    super(code, message);
+  }
+}
+
+class FlagError extends UsageError {
+  flag;
+  constructor(flag, message) {
+    super(message, "flag");
+    this.flag = flag;
+  }
+}
+class UnknownRuleError extends UsageError {
+  file;
+  rule;
+  known;
+  constructor(file, rule, known) {
+    super(`${file}: unknown rule "${rule}"; a retired or misspelt id cannot be switched off. Known rules: ${known.join(", ")}`, "unknown-rule");
+    this.file = file;
+    this.rule = rule;
+    this.known = known;
+  }
+}
+
+class RuleOptionError extends UsageError {
+  file;
+  rule;
+  option;
+  constructor(file, rule, option, message) {
+    super(`${file}: ${message}`, "rule-option");
+    this.file = file;
+    this.rule = rule;
+    this.option = option;
+  }
+}
+class FixNotConvergingError extends MermaidLintError {
+  file;
+  rules;
+  constructor(file, passes, rules) {
+    super("fix-not-converging", `${file}: --fix did not converge after ${passes} passes; ${rules.join(", ")} kept proposing edits. A fixer must propose nothing once its edit is applied`);
+    this.file = file;
+    this.rules = rules;
+  }
+}
+
+class PluginLoadError extends MermaidLintError {
+  source;
+  constructor(source, reason, code = "plugin") {
+    super(code, `plugin ${source}: ${reason}`);
+    this.source = source;
+  }
+}
+class PluginContractError extends PluginLoadError {
+  constructor(source, reason) {
+    super(source, reason, "plugin-contract");
+  }
+}
+class PluginFixerError extends MermaidLintError {
+  rule;
+  constructor(rule, reason) {
+    super("plugin-fixer", `plugin rule ${rule} ${reason}`);
+    this.rule = rule;
+  }
+}
+
 // src/model.ts
 import { fromMarkdown } from "mdast-util-from-markdown";
 import { frontmatterFromMarkdown } from "mdast-util-frontmatter";
@@ -776,74 +852,6 @@ var buildDocModel = (src, kind = "markdown") => {
   return { src, kind, tree, diagrams };
 };
 
-// src/errors.ts
-class MermaidLintError extends Error {
-  code;
-  constructor(code, message) {
-    super(message);
-    this.code = code;
-    this.name = new.target.name;
-  }
-}
-
-class UsageError extends MermaidLintError {
-  constructor(message, code = "usage") {
-    super(code, message);
-  }
-}
-class UnknownRuleError extends UsageError {
-  file;
-  rule;
-  known;
-  constructor(file, rule, known) {
-    super(`${file}: unknown rule "${rule}"; a retired or misspelt id cannot be switched off. Known rules: ${known.join(", ")}`, "unknown-rule");
-    this.file = file;
-    this.rule = rule;
-    this.known = known;
-  }
-}
-
-class RuleOptionError extends UsageError {
-  file;
-  rule;
-  option;
-  constructor(file, rule, option, message) {
-    super(`${file}: ${message}`, "rule-option");
-    this.file = file;
-    this.rule = rule;
-    this.option = option;
-  }
-}
-class FixNotConvergingError extends MermaidLintError {
-  file;
-  rules;
-  constructor(file, passes, rules) {
-    super("fix-not-converging", `${file}: --fix did not converge after ${passes} passes; ${rules.join(", ")} kept proposing edits. A fixer must propose nothing once its edit is applied`);
-    this.file = file;
-    this.rules = rules;
-  }
-}
-
-class PluginLoadError extends MermaidLintError {
-  source;
-  constructor(source, reason, code = "plugin") {
-    super(code, `plugin ${source}: ${reason}`);
-    this.source = source;
-  }
-}
-class PluginContractError extends PluginLoadError {
-  constructor(source, reason) {
-    super(source, reason, "plugin-contract");
-  }
-}
-class PluginFixerError extends MermaidLintError {
-  rule;
-  constructor(rule, reason) {
-    super("plugin-fixer", `plugin rule ${rule} ${reason}`);
-    this.rule = rule;
-  }
-}
-
 // src/parse/contrast.ts
 import { existsSync } from "node:fs";
 import { dirname, join, resolve } from "node:path";
@@ -1638,6 +1646,15 @@ var buildRegistry = (input) => {
 var BUILTIN = buildRegistry({ rules: RULES, fixOrder: FIX_ORDER, categories: BUILTIN_CATEGORIES });
 
 // src/check.ts
+var checkRunFlags = (flags, prefix = "") => {
+  const { preset, profile } = flags;
+  if (preset !== undefined && canonicalPreset(preset) === null) {
+    throw new FlagError(`${prefix}preset`, `${prefix}preset must be one of ${PRESET_NAMES.join(", ")}, not "${preset}"`);
+  }
+  if (profile !== undefined && !PROFILES.includes(profile)) {
+    throw new FlagError(`${prefix}profile`, `${prefix}profile must be one of ${PROFILES.join(", ")}, not "${profile}"`);
+  }
+};
 var optionsFor = (rule, configured, flags) => {
   const options = { ...configured };
   for (const name of ["preset", "profile"]) {
@@ -1648,6 +1665,7 @@ var optionsFor = (rule, configured, flags) => {
   return options;
 };
 var checkModel = async (doc, file, flags = {}, registry = BUILTIN) => {
+  checkRunFlags(flags);
   const perRule = registry.rules.map((rule) => rule.check({ doc, file, options: optionsFor(rule, registry.options.get(rule.id), flags), helpers: HELPERS }));
   const findings = (await Promise.all(perRule)).flat();
   return findings.sort((a, b) => a.line - b.line || a.rule.localeCompare(b.rule));
@@ -1739,6 +1757,7 @@ var overlaps = (edits) => {
 };
 var wellFormed = (e, length) => Number.isInteger(e.start) && Number.isInteger(e.end) && e.start >= 0 && e.start <= e.end && e.end <= length && typeof e.text === "string";
 var fixSourceReport = async (src, file, flags = {}, registry = BUILTIN) => {
+  checkRunFlags(flags);
   const kind = documentKind(file);
   const applied = [];
   const refused = [];

package/dist/types/check.d.ts

@@ -5,6 +5,7 @@ export interface RunFlags {
     preset?: string;
     profile?: string;
 }
+export declare const checkRunFlags: (flags: RunFlags, prefix?: string) => void;
 export declare const optionsFor: (rule: Rule, configured: RuleOptions | undefined, flags: RunFlags) => RuleOptions;
 export declare const checkModel: (doc: DocModel, file: string, flags?: RunFlags, registry?: Registry) => Promise<Finding[]>;
 export declare const checkMarkdown: (src: string, file: string, flags?: RunFlags, registry?: Registry) => Promise<Finding[]>;

package/package.json

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

package/src/check.ts

@@ -4,7 +4,10 @@
 // them. A rule may be synchronous or return a promise, so a rule that waits on
 // a tool or a service overlaps with the others.
 
+import { FlagError } from "./errors.ts";
 import { buildDocModel, type DocModel, documentKind } from "./model.ts";
+import { PROFILES } from "./parse/contrast.ts";
+import { canonicalPreset, PRESET_NAMES } from "./parse/metrics.ts";
 import { BUILTIN, HELPERS, type Registry } from "./rules/registry.ts";
 import type { Finding, Rule, RuleOptions } from "./rules/types.ts";
 
@@ -15,6 +18,22 @@ export interface RunFlags {
   profile?: string;
 }
 
+// A preset or profile that no rule can take fails as a usage error, with the
+// code the command gives a bad flag, so a library caller can branch on it. The
+// command passes "--" as the prefix, so the message names its own flag.
+export const checkRunFlags = (flags: RunFlags, prefix = ""): void => {
+  const { preset, profile } = flags;
+  if (preset !== undefined && canonicalPreset(preset) === null) {
+    throw new FlagError(
+      `${prefix}preset`,
+      `${prefix}preset must be one of ${PRESET_NAMES.join(", ")}, not "${preset}"`,
+    );
+  }
+  if (profile !== undefined && !PROFILES.includes(profile as (typeof PROFILES)[number])) {
+    throw new FlagError(`${prefix}profile`, `${prefix}profile must be one of ${PROFILES.join(", ")}, not "${profile}"`);
+  }
+};
+
 // The options a rule runs with: its configured options, then a flag for any
 // option the rule declares.
 export const optionsFor = (rule: Rule, configured: RuleOptions | undefined, flags: RunFlags): RuleOptions => {
@@ -32,6 +51,7 @@ export const checkModel = async (
   flags: RunFlags = {},
   registry: Registry = BUILTIN,
 ): Promise<Finding[]> => {
+  checkRunFlags(flags);
   const perRule = registry.rules.map((rule) =>
     rule.check({ doc, file, options: optionsFor(rule, registry.options.get(rule.id), flags), helpers: HELPERS }),
   );

package/src/cli.ts

@@ -5,13 +5,13 @@ import { lstat, readFile, realpath, writeFile } from "node:fs/promises";
 import { isAbsolute, relative, resolve } from "node:path";
 import { parseArgs } from "node:util";
 import pkg from "../package.json" with { type: "json" };
-import { checkModel, type RunFlags } from "./check.ts";
+import { checkModel, checkRunFlags, type RunFlags } from "./check.ts";
 import { FixOutsideRootError, FlagError, MermaidLintError, UsageError } from "./errors.ts";
 import { collectFiles, DIAGRAM_FILE_EXTS, SKIP_DIRS } from "./files.ts";
 import { fixSourceReport } from "./fix/engine.ts";
 import { buildDocModel, DIAGRAM_EXTS, documentKind } from "./model.ts";
 import { PROFILES } from "./parse/contrast.ts";
-import { canonicalPreset, PRESET_NAMES } from "./parse/metrics.ts";
+import { PRESET_NAMES } from "./parse/metrics.ts";
 import type { PluginFailure } from "./plugins/index.ts";
 import { setUp } from "./project.ts";
 import { RULES } from "./rules/index.ts";
@@ -52,6 +52,7 @@ Examples of every rule, with fixes: https://jpeakai.github.io/jpai-mermaidjs-lin
   numeric threshold set in the config overrides both.
 --profile NAME sets how contrast is read: ${PROFILES.join(", ")}. It overrides a profile set in the config.
   auto reads mkdocs-material when any parent folder holds mkdocs.yml or mkdocs.yaml, else github.
+--json prints one JSON object instead of text lines.
 --fix applies every fix it can prove safe, then reports what remains.
 A fixer that is unsure leaves the text alone and the finding stays.
 --config FILE reads that config instead of mermaidjs-lint.config.json or .mjs at the project root.
@@ -220,12 +221,7 @@ const run = async (argv: string[], cwd: string): Promise<number> => {
   }
   const listing = values["list-rules"];
   const validating = values["validate-plugins"];
-  if (values.preset !== undefined && canonicalPreset(values.preset) === null) {
-    throw new FlagError("--preset", `--preset must be one of ${PRESET_NAMES.join(", ")}, not "${values.preset}"`);
-  }
-  if (values.profile !== undefined && !PROFILES.includes(values.profile as (typeof PROFILES)[number])) {
-    throw new FlagError("--profile", `--profile must be one of ${PROFILES.join(", ")}, not "${values.profile}"`);
-  }
+  checkRunFlags({ preset: values.preset, profile: values.profile }, "--");
   if (values["no-plugins"] && values["lenient-plugins"]) {
     throw new FlagError("--lenient-plugins", "--no-plugins and --lenient-plugins contradict each other");
   }

package/src/fix/engine.ts

@@ -3,7 +3,7 @@
 // or single edit that survives verification. Offsets are only valid for the source they were
 // computed from, so every accepted edit restarts the pass.
 
-import { optionsFor, type RunFlags } from "../check.ts";
+import { checkRunFlags, optionsFor, type RunFlags } from "../check.ts";
 import { FixNotConvergingError } from "../errors.ts";
 import { buildDocModel, documentKind } from "../model.ts";
 import { BUILTIN, HELPERS, type Registry } from "../rules/registry.ts";
@@ -46,6 +46,7 @@ export const fixSourceReport = async (
   flags: RunFlags = {},
   registry: Registry = BUILTIN,
 ): Promise<FixReport> => {
+  checkRunFlags(flags);
   const kind = documentKind(file);
   const applied: Edit[] = [];
   const refused: Edit[] = [];