@jpeakai/mermaidjs-lint 0.1.0 → 0.2.0

package/src/rules/registry.ts

@@ -1,7 +1,8 @@
 // The registry: the rules a run actually uses. It starts from the built-in
 // catalogue, adds whatever plugins loaded, then applies the config, so a rule
-// that is off loses its check and its fixer together. Nothing else reads the
-// catalogue directly, which is what lets a plugin rule behave as a built-in.
+// that is off loses its check and its fixer together. Every check and fix reads
+// the registry, which is what lets a plugin rule behave as a built-in. The CLI
+// help reads the built-in catalogue directly.
 
 import type { Config } from "../config.ts";
 import { RuleOptionError, UnknownRuleError } from "../errors.ts";
@@ -45,7 +46,8 @@ export interface RegistryInput {
   categories: ReadonlyMap<string, string>;
   sources?: LoadedSource[];
   config?: Config;
-  // A lenient run drops a setting for an unknown plugin rule instead of failing.
+  // A lenient or collect (validating) run drops a setting for an unloaded
+  // plugin rule instead of failing. A built-in id always fails.
   ignoreUnknownPluginIds?: boolean;
 }
 
@@ -92,7 +94,8 @@ export const buildRegistry = (input: RegistryInput): Registry => {
     const rule = rules.find((r) => r.id === id);
     if (!rule) {
       // A plugin that was skipped cannot have its rules configured, so a lenient
-      // run drops the setting and says so. A built-in id is never forgiven.
+      // or collect (validating) run drops the setting and says so. A built-in id
+      // always fails.
       if (ignoreUnknownPluginIds && isPluginRuleId(id)) {
         ignored.push(id);
         continue;

package/src/rules/shared.ts

@@ -93,5 +93,5 @@ export const contrastOf = (diagram: Diagram, profile: Profile): ContrastResult =
   return result;
 };
 
-// A directive line as a file line.
+// Maps a diagram-relative line to a file line.
 export const fileLine = (diagram: Diagram, line: number): number => diagram.firstLine + line - 1;

package/src/rules/types.ts

@@ -20,14 +20,14 @@ export const RULE = {
   UNAUDITABLE: "contrast-directive-unauditable",
 } as const;
 
-// A core id has no slash. A plugin id is always namespace/name, so the slash
-// is what tells the two apart.
 export type CoreRuleId = (typeof RULE)[keyof typeof RULE];
 
 export type Awaitable<T> = T | Promise<T>;
 
 export type PluginRuleId = `${string}/${string}`;
 
+// A core id has no slash. A plugin id is always namespace/name, so the slash
+// is what tells the two apart.
 export const isPluginRuleId = (id: string): id is PluginRuleId => id.includes("/");
 
 export type RuleId = CoreRuleId | PluginRuleId;

package/src/testing.ts

@@ -1,7 +1,8 @@
 // A test helper for plugin authors: run one plugin rule over real strings, with
-// the same loader checks, the same context and the same verified fix engine as
-// a real run. It is a separate entry point so a plugin's tests import it and
-// production code never does.
+// the same contract checks as the loader, the same context and the same
+// verified fix engine as a real run. It skips the reserved `local` namespace
+// and cross-plugin conflict checks. It is a separate entry point so a plugin's
+// tests import it and production code never does.
 
 import { checkMarkdown, type RunFlags } from "./check.ts";
 import { type FixReport, fixSourceReport } from "./fix/engine.ts";