@templatical/quality 0.8.0 → 0.8.1

package/dist/index.d.ts

@@ -6,6 +6,12 @@ import { TemplateSettings } from '../../types/src/index.ts';
 
 export declare const ACCESSIBILITY_RULES: Rule[];
 
+/** Options consumed only by the accessibility linter. */
+export declare interface AccessibilityLintOptions {
+    rules?: RuleOverrides;
+    thresholds?: Partial<LintThresholds>;
+}
+
 export declare interface AnchorInfo {
     href: string;
     text: string;
@@ -148,6 +154,16 @@ export declare function getMessages(locale: string): MessageMap;
 
 export declare function getStructureMessages(locale: string): StructureMessageMap;
 
+/**
+ * `true` when no linter would run for the given options — either the
+ * global `disabled` flag is set, or every per-tool key is `false`.
+ *
+ * The editor uses this to skip lazy-loading `@templatical/quality`, hide
+ * the Issues sidebar tab, and suppress inline canvas badges. Headless
+ * callers can use it to short-circuit before any linter call.
+ */
+export declare function isLintFullyDisabled(options: LintOptions | undefined): boolean;
+
 export declare function isOpaqueHex(input: string | undefined | null): boolean;
 
 export declare const LINK_RULES: Rule[];
@@ -156,6 +172,21 @@ export declare type LinkMessageMap = typeof en_4;
 
 export declare type LinkRuleMessageId = keyof LinkMessageMap;
 
+/** Options consumed only by the links linter. */
+export declare interface LinksLintOptions {
+    rules?: RuleOverrides;
+    /**
+     * Host patterns that should flag as "staging / non-production".
+     * Each entry is a glob-style pattern matched against the URL host.
+     * `*` matches any run of characters (including `.`), so `*.staging.*`
+     * matches `app.staging.example.com`.
+     *
+     * Default: ['localhost', '127.0.0.1', '0.0.0.0', '*.local',
+     *           '*.staging.*', '*.dev.*']
+     */
+    nonProductionHosts?: string[];
+}
+
 export declare function lintAccessibility(content: TemplateContent, options?: LintOptions): LintIssue[];
 
 export declare interface LintIssue {
@@ -169,19 +200,6 @@ export declare interface LintIssue {
 
 export declare function lintLinks(content: TemplateContent, options?: LintOptions): LintIssue[];
 
-export declare interface LintLinksOptions {
-    /**
-     * Host patterns that should flag as "staging / non-production".
-     * Each entry is a glob-style pattern matched against the URL host.
-     * `*` matches any run of characters (including `.`), so `*.staging.*`
-     * matches `app.staging.example.com`.
-     *
-     * Default: ['localhost', '127.0.0.1', '0.0.0.0', '*.local',
-     *           '*.staging.*', '*.dev.*']
-     */
-    nonProductionHosts?: string[];
-}
-
 export declare interface LintOptions {
     /**
      * Fully disable linting. When true, the editor skips lazy-loading the
@@ -190,11 +208,21 @@ export declare interface LintOptions {
     disabled?: boolean;
     /** Locale for vague-text dictionaries and message text. Falls back to `en`. */
     locale?: string;
-    /** Per-rule severity override. Set to `'off'` to disable a specific rule. */
-    rules?: Record<string, Severity>;
-    thresholds?: Partial<LintThresholds>;
-    /** Per-linter knobs. Only `lintLinks` reads `links` today. */
-    links?: LintLinksOptions;
+    /**
+     * Accessibility linter config. Set to `false` to disable the whole
+     * `lintAccessibility` linter without enumerating its rules.
+     */
+    accessibility?: false | AccessibilityLintOptions;
+    /**
+     * Structure linter config. Set to `false` to disable the whole
+     * `lintStructure` linter without enumerating its rules.
+     */
+    structure?: false | StructureLintOptions;
+    /**
+     * Links linter config. Set to `false` to disable the whole `lintLinks`
+     * linter without enumerating its rules.
+     */
+    links?: false | LinksLintOptions;
 }
 
 export declare interface LintPatch {
@@ -227,7 +255,7 @@ export declare interface ResolvedLinksOptions {
 
 export declare interface ResolvedOptions {
     locale: string;
-    rules: Record<string, Severity>;
+    rules: RuleOverrides;
     thresholds: LintThresholds;
     links: ResolvedLinksOptions;
     /** Returns the effective severity for a rule (override or default). */
@@ -269,10 +297,22 @@ export declare interface RuleMeta {
     severity: Exclude<Severity, "off">;
 }
 
+/**
+ * Per-rule severity override. Set a rule to `'off'` to disable it.
+ * Keys are the full prefixed rule IDs (`a11y.*`, `structure.*`, `link.*`)
+ * so a value copied from `LintIssue.ruleId` pastes straight in.
+ */
+export declare type RuleOverrides = Record<string, Severity>;
+
 export declare type Severity = "error" | "warning" | "info" | "off";
 
 export declare const STRUCTURE_RULES: Rule[];
 
+/** Options consumed only by the structure linter. */
+export declare interface StructureLintOptions {
+    rules?: RuleOverrides;
+}
+
 export declare type StructureMessageMap = typeof en_3;
 
 export declare type StructureRuleMessageId = keyof StructureMessageMap;