nimbus-docs 0.1.3 → 0.1.5

package/dist/diagnostic-DZf0z79l.d.ts

@@ -0,0 +1,123 @@
+//#region src/lint/diagnostic.d.ts
+/**
+ * The diagnostic envelope — the single shape every Nimbus check flows
+ * through, from build validators to authoring rules to (eventually) Vale.
+ *
+ * Locked in Phase 0. Extending it later is a versioned schema bump, not a
+ * field tacked on in a minor — see the cross-phase invariants in the
+ * authoring-lints plan. Positions are the unist `Point` Sätteri's parser
+ * already emits (1-based line/column plus a character offset), so a
+ * diagnostic, a `--fix` edit range, and the pretty formatter's caret all
+ * read from the one AST the renderer built.
+ */
+/**
+ * The stable rule-code registry. Every code Nimbus can emit lives here,
+ * tagged with the tier it belongs to:
+ *
+ *   - `build`    — a build validator. Always on, fails `astro build`, no
+ *                  severity knob. Cannot appear in the `rules` config.
+ *   - `authoring`— an authoring rule. Defaults to `error`, configurable to
+ *                  `warn` / `off`, surfaced by `nimbus-docs lint`.
+ *
+ * Codes are registered here even before their rule is implemented so the
+ * namespace is stable and `RuleCode` stays exhaustive: importing or
+ * configuring an unknown code is a typecheck failure, not a silent no-op.
+ */
+declare const RULE_CODES: {
+  readonly "nimbus/mdx-syntax": {
+    readonly kind: "build";
+  };
+  readonly "nimbus/component-pascalcase": {
+    readonly kind: "build";
+  };
+  readonly "nimbus/partial-exists": {
+    readonly kind: "build";
+  };
+  readonly "nimbus/duplicate-slug": {
+    readonly kind: "build";
+  };
+  readonly "nimbus/frontmatter-shape": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/description-required": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/internal-link": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/orphan-page": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/sidebar-entry": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/single-h1": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/heading-hierarchy": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/code-block-lang": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/code-block-prompt-prefix": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/no-self-host-url": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/heading-punctuation": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/duplicate-heading-text": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/list-marker-style": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/emphasis-style": {
+    readonly kind: "authoring";
+  };
+  readonly "nimbus/bare-url": {
+    readonly kind: "authoring";
+  };
+};
+/** Every rule code Nimbus knows about. */
+type RuleCode = keyof typeof RULE_CODES;
+/** Resolved severity — a rule that resolved to `off` never runs, so it
+ * never reaches a `Diagnostic`. */
+type Severity = "error" | "warn";
+/** Severity as a user configures it. `off` disables the rule entirely. */
+type SeverityConfig = Severity | "off";
+interface DiagnosticFix {
+  /** Human/agent-readable description of what the fix does. */
+  description: string;
+  /**
+   * Edits to apply, as `[start, end]` character offsets into the source
+   * (unist offsets — the same the AST reports), with replacement text.
+   */
+  edits: Array<{
+    range: [number, number];
+    text: string;
+  }>;
+}
+interface Diagnostic {
+  code: RuleCode;
+  severity: Severity;
+  /** Which tool produced this. Reserved so Phase 4 can merge Vale into the
+   * same envelope without a breaking change. */
+  source: "docs-compiler" | "vale";
+  message: string;
+  /** Path relative to the project root. */
+  file: string;
+  /** 1-based, from the Sätteri AST. */
+  line: number;
+  /** 1-based, from the Sätteri AST. */
+  column: number;
+  endLine?: number;
+  endColumn?: number;
+  fix?: DiagnosticFix;
+}
+//#endregion
+export { SeverityConfig as a, Severity as i, DiagnosticFix as n, RuleCode as r, Diagnostic as t };
+//# sourceMappingURL=diagnostic-DZf0z79l.d.ts.map

package/dist/diagnostic-DZf0z79l.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostic-DZf0z79l.d.ts","names":[],"sources":["../src/lint/diagnostic.ts"],"mappings":";;AAyBA;;;;;;;;;;;;;;;;;;;;;;;cAAa,UAAA;EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA0BD,QAAA,gBAAwB,UAAA;;;KAIxB,QAAA;;KAGA,cAAA,GAAiB,QAAA;AAAA,UAEZ,aAAA;EAyBT;EAvBN,WAAA;EAuBmB;;;;EAlBnB,KAAA,EAAO,KAAA;IAAQ,KAAA;IAAyB,IAAA;EAAA;AAAA;AAAA,UAGzB,UAAA;EACf,IAAA,EAAM,QAAA;EACN,QAAA,EAAU,QAAA;;;EAGV,MAAA;EACA,OAAA;;EAEA,IAAA;;EAEA,IAAA;;EAEA,MAAA;EACA,OAAA;EACA,SAAA;EACA,GAAA,GAAM,aAAA;AAAA"}