@lyse-labs/lyse 0.1.0-alpha.2 → 0.2.0-alpha.1

package/dist/rules/ai-governance-ai-loading-error-states.d.ts

@@ -0,0 +1,9 @@
+import type { Rule } from "../types.js";
+export declare function detectNamedLoadingWithText(source: string, componentName: string): boolean;
+export declare function detectAiErrorState(source: string, componentName: string): boolean;
+export declare const _internal: {
+    detectNamedLoadingWithText: typeof detectNamedLoadingWithText;
+    detectAiErrorState: typeof detectAiErrorState;
+    isAllowlisted: (repoRoot: string) => boolean;
+};
+export declare const rule: Rule;

package/dist/rules/ai-governance-ai-loading-error-states.js

@@ -0,0 +1,214 @@
+import { join } from "node:path";
+import fg from "fast-glob";
+import { createLyseRule } from "./_rule-module.js";
+import { isAiMarkerName, safeReadText, extractNamesFromSource, extractVueNames, COMPONENT_GLOB, SCAN_IGNORE, deriveComponentNameFromPath, makeAllowlistCheck, } from "./ai-governance-ai-marker-component-present.js";
+const RULE_ID = "ai-governance/ai-loading-error-states";
+const DISABLE_DIRECTIVE = `lyse-disable ${RULE_ID}`;
+const isAllowlisted = makeAllowlistCheck(DISABLE_DIRECTIVE);
+// Component names whose presence alone implies a named AI loading state.
+const LOADING_NAME_PATTERNS = [
+    "generating",
+    "thinking",
+    "ailoading",
+    "streamingindicator",
+    "loadingstate",
+    "aistatus",
+];
+// Text signals that pair with the component to confirm it is not a bare spinner.
+// Matches: loadingText prop, aria-label attribute, or a visible AI-progress
+// status string (quoted or unquoted in JSX text content).
+const PAIRED_TEXT_RE = /loadingText|aria-label\s*=|["` >]Generating|["` >]Thinking|Please wait|["` >]Loading AI/i;
+// Names that are unambiguously descriptive and carry implicit text semantics.
+const SELF_DESCRIBING_LOADING = ["generating", "thinking", "streamingindicator"];
+export function detectNamedLoadingWithText(source, componentName) {
+    const lower = componentName.toLowerCase();
+    const hasNamedMatch = LOADING_NAME_PATTERNS.some((p) => lower.includes(p));
+    if (!hasNamedMatch)
+        return false;
+    if (SELF_DESCRIBING_LOADING.some((p) => lower.includes(p)))
+        return true;
+    return PAIRED_TEXT_RE.test(source);
+}
+// Match "ai" only on a word/segment boundary to avoid false positives from
+// substrings like "email", "retail", "cocktail".
+const AI_WORD_RE = /(^|[^a-z])ai([^a-z]|$)/;
+const AI_COMPOUND_KEYWORDS = ["generation", "genai", "llm", "generative"];
+const ERROR_KEYWORDS = ["error", "failure", "failed", "timeout"];
+const ERROR_NAME_PATTERNS = [
+    "aierror",
+    "generationerror",
+    "aifailure",
+    "generationfailed",
+    "aitimeout",
+];
+export function detectAiErrorState(source, componentName) {
+    const lower = componentName.toLowerCase();
+    if (ERROR_NAME_PATTERNS.some((p) => lower.includes(p)))
+        return true;
+    const hasAi = AI_WORD_RE.test(lower) || AI_COMPOUND_KEYWORDS.some((k) => lower.includes(k));
+    const hasError = ERROR_KEYWORDS.some((k) => lower.includes(k));
+    return hasAi && hasError;
+}
+export const _internal = { detectNamedLoadingWithText, detectAiErrorState, isAllowlisted };
+function namesFromFile(source, relPath) {
+    if (relPath.endsWith(".vue"))
+        return extractVueNames(source);
+    const fromSource = extractNamesFromSource(source);
+    if (fromSource.length > 0)
+        return fromSource;
+    return [deriveComponentNameFromPath(relPath)];
+}
+function hasAiSurface(files, repoRoot) {
+    for (const rel of files) {
+        const source = safeReadText(join(repoRoot, rel));
+        if (!source)
+            continue;
+        const names = namesFromFile(source, rel);
+        const pathName = deriveComponentNameFromPath(rel);
+        const allNames = [...names, pathName];
+        if (allNames.some((n) => isAiMarkerName(n)))
+            return true;
+    }
+    return false;
+}
+const evaluate = async (ctx, _files) => {
+    const findings = [];
+    if (!ctx.repoRoot)
+        return { findings, opportunities: 0 };
+    if (isAllowlisted(ctx.repoRoot))
+        return { findings, opportunities: 0 };
+    let componentFiles = [];
+    try {
+        componentFiles = fg.sync(COMPONENT_GLOB, {
+            cwd: ctx.repoRoot,
+            absolute: false,
+            dot: false,
+            ignore: SCAN_IGNORE,
+            onlyFiles: true,
+            unique: true,
+        }).sort();
+    }
+    catch {
+        return { findings, opportunities: 0 };
+    }
+    if (!hasAiSurface(componentFiles, ctx.repoRoot)) {
+        return { findings, opportunities: 0 };
+    }
+    let foundNamedLoading = false;
+    let foundAiError = false;
+    for (const rel of componentFiles) {
+        const source = safeReadText(join(ctx.repoRoot, rel));
+        if (!source)
+            continue;
+        const names = namesFromFile(source, rel);
+        const pathName = deriveComponentNameFromPath(rel);
+        const allNames = [...names, pathName];
+        for (const name of allNames) {
+            if (!foundNamedLoading && detectNamedLoadingWithText(source, name)) {
+                foundNamedLoading = true;
+            }
+            if (!foundAiError && detectAiErrorState(source, name)) {
+                foundAiError = true;
+            }
+            if (foundNamedLoading && foundAiError)
+                break;
+        }
+        if (foundNamedLoading && foundAiError)
+            break;
+    }
+    const location = { file: "src/index.ts", line: 1, column: 1 };
+    if (foundNamedLoading && foundAiError) {
+        findings.push({
+            ruleId: RULE_ID,
+            axis: "ai-governance",
+            severity: "info",
+            location,
+            message: "AI loading state (named, with paired text) and AI-specific error state detected — both present.",
+            suggestion: "Ensure the error state communicates the AI context clearly and the loading state always carries visible or accessible text (AWS Cloudscape gen-AI pattern).",
+        });
+    }
+    else {
+        if (!foundNamedLoading) {
+            findings.push({
+                ruleId: RULE_ID,
+                axis: "ai-governance",
+                severity: "warning",
+                location,
+                message: "AI surface detected but no named AI loading state with paired text found — a bare spinner is not sufficient (AWS Cloudscape gen-AI: loading states must carry visible text, e.g. \"Generating response…\").",
+                suggestion: "Add a named component such as Generating, Thinking, AILoading, or StreamingIndicator that always renders a visible/accessible status string alongside the spinner.",
+            });
+        }
+        if (!foundAiError) {
+            findings.push({
+                ruleId: RULE_ID,
+                axis: "ai-governance",
+                severity: "warning",
+                location,
+                message: "AI surface detected but no AI-specific error state found — generic error boundaries do not communicate AI-specific failure context.",
+                suggestion: "Add a component such as AIError or GenerationError that clearly communicates the AI operation failed and what the user can do next.",
+            });
+        }
+    }
+    return { findings, opportunities: componentFiles.length };
+};
+export const rule = createLyseRule({
+    meta: {
+        axis: "ai-governance",
+        lyseRuleId: RULE_ID,
+        defaultSeverity: "warning",
+        shortDescription: "Named AI loading state with paired text + AI-specific error state present",
+        fullDescription: "Scans component files (`**/*.{tsx,jsx,vue}`) for (a) a named AI loading state that carries paired visible or accessible text — not a bare spinner — and (b) an AI-specific error state component. Recognised loading vocabulary: `*Generating*`, `*Thinking*`, `*AILoading*`, `*StreamingIndicator*`, `*AIStatus*`, `*LoadingState*`. A bare generic spinner (`Spinner`, `LoadingSpinner`) without an AI-named wrapper and without a `loadingText` prop or visible status string does NOT satisfy the requirement. Recognised error vocabulary: `*AIError*`, `*GenerationError*`, `*AIFailure*`, `*GenerationFailed*`, `*AITimeout*`, or any name combining an AI keyword (`ai`, `generation`, `genai`, `llm`, `generative`) with an error keyword (`error`, `failure`, `failed`, `timeout`). Emits `warning` for each absent state type when an AI marker surface is detected; emits `info` when both are present; emits nothing when no AI surface is detected. Recovery-flow detection (retry orchestration, post-error behavior) is out of scope — tracked in Track 4 (#16).",
+        helpUri: "https://github.com/lyse-labs/lyse/blob/main/docs/rules/ai-governance-ai-loading-error-states.md",
+        rationale: `Why it matters
+
+AI-generating surfaces have two failure modes invisible to generic DS rules: (1) a loading state that gives no context — users see a spinner but don't know if the model is generating, stuck, or done — and (2) a generic error boundary that offers no AI-specific message, leaving users without guidance when a generation fails.
+
+AWS Cloudscape's generative-AI patterns mandate that every AI loading state carry named, visible text (e.g. "Generating response…") so users understand what the system is doing and can judge when to wait vs. cancel. A bare, unlabelled spinner violates this requirement.
+
+An AI-specific error component is equally critical: it must communicate that the AI operation failed (not a generic network error) and ideally suggest next steps — though the recovery-flow logic itself is deferred to Track 4.
+
+This rule detects the static presence of both states. It cross-conditions: if an AI marker is found but either state is absent, a warning is emitted; if both are present, an info finding confirms the DS is provisioned for AI-state handling.`,
+        examples: [
+            {
+                good: `// Generating.tsx
+export const Generating = () => (
+  <div role="status" aria-live="polite">
+    <Spinner /> Generating response…
+  </div>
+);`,
+                bad: `// LoadingSpinner.tsx — bare spinner, no AI name, no paired text
+export const LoadingSpinner = () => <svg className="spin" />;`,
+            },
+            {
+                good: `// AILoading.tsx — loadingText prop satisfies paired-text requirement
+export function AILoading({ loadingText }: { loadingText: string }) {
+  return <div><Spinner /><span>{loadingText}</span></div>;
+}`,
+                bad: `// No AI-named loading state at all — only generic Spinner exported`,
+            },
+            {
+                good: `// AIError.tsx
+export const AIError = ({ message }: { message: string }) => (
+  <div role="alert">
+    <strong>Generation failed</strong>
+    <p>{message}</p>
+  </div>
+);`,
+                bad: `// ErrorBoundary.tsx — generic, gives no AI context
+export class ErrorBoundary extends React.Component {
+  render() { return this.props.children; }
+}`,
+            },
+        ],
+        allowlist: [
+            "repos containing `lyse-disable ai-governance/ai-loading-error-states` in an adjacent README, README.md, README.mdx, .lyse.yaml, or .lyse.yml — rule is N/A",
+            "repos with no AI marker surface detected (no AILabel, AIBadge, magic-* etc.) — no AI surface, rule emits nothing",
+            "files larger than 1 MB — skipped to avoid pathological cases",
+            "files under `node_modules/`, `dist/`, `build/`, `.git/`, `.next/`, `out/`, `coverage/`",
+            "recovery-flow detection (retry orchestration, post-error navigation) — explicitly deferred to Track 4 (#16)",
+        ],
+    },
+    defaultOptions: [],
+    create: () => ({ evaluate }),
+});
+//# sourceMappingURL=ai-governance-ai-loading-error-states.js.map

package/dist/rules/ai-governance-ai-loading-error-states.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-governance-ai-loading-error-states.js","sourceRoot":"","sources":["../../src/rules/ai-governance-ai-loading-error-states.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,WAAW,CAAC;AAQ3B,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EACL,cAAc,EACd,YAAY,EACZ,sBAAsB,EACtB,eAAe,EACf,cAAc,EACd,WAAW,EACX,2BAA2B,EAC3B,kBAAkB,GACnB,MAAM,gDAAgD,CAAC;AAExD,MAAM,OAAO,GAAG,uCAAuC,CAAC;AACxD,MAAM,iBAAiB,GAAG,gBAAgB,OAAO,EAAE,CAAC;AAEpD,MAAM,aAAa,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;AAE5D,yEAAyE;AACzE,MAAM,qBAAqB,GAAG;IAC5B,YAAY;IACZ,UAAU;IACV,WAAW;IACX,oBAAoB;IACpB,cAAc;IACd,UAAU;CACX,CAAC;AAEF,iFAAiF;AACjF,4EAA4E;AAC5E,0DAA0D;AAC1D,MAAM,cAAc,GAClB,0FAA0F,CAAC;AAE7F,8EAA8E;AAC9E,MAAM,uBAAuB,GAAG,CAAC,YAAY,EAAE,UAAU,EAAE,oBAAoB,CAAC,CAAC;AAEjF,MAAM,UAAU,0BAA0B,CAAC,MAAc,EAAE,aAAqB;IAC9E,MAAM,KAAK,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;IAC1C,MAAM,aAAa,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3E,IAAI,CAAC,aAAa;QAAE,OAAO,KAAK,CAAC;IACjC,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACxE,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACrC,CAAC;AAED,2EAA2E;AAC3E,iDAAiD;AACjD,MAAM,UAAU,GAAG,wBAAwB,CAAC;AAC5C,MAAM,oBAAoB,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;AAC1E,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;AAEjE,MAAM,mBAAmB,GAAG;IAC1B,SAAS;IACT,iBAAiB;IACjB,WAAW;IACX,kBAAkB;IAClB,WAAW;CACZ,CAAC;AAEF,MAAM,UAAU,kBAAkB,CAAC,MAAc,EAAE,aAAqB;IACtE,MAAM,KAAK,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;IAC1C,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACpE,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5F,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,OAAO,KAAK,IAAI,QAAQ,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC;AAE3F,SAAS,aAAa,CAAC,MAAc,EAAE,OAAe;IACpD,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;IAC7D,MAAM,UAAU,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAClD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,UAAU,CAAC;IAC7C,OAAO,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,YAAY,CAAC,KAAe,EAAE,QAAgB;IACrD,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM;YAAE,SAAS;QACtB,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,2BAA2B,CAAC,GAAG,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC,CAAC;QACtC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;IAC3D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,QAAQ,GAAG,KAAK,EACpB,GAAgB,EAChB,MAAmB,EACM,EAAE;IAC3B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,IAAI,CAAC,GAAG,CAAC,QAAQ;QAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IACzD,IAAI,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IAEvE,IAAI,cAAc,GAAa,EAAE,CAAC;IAClC,IAAI,CAAC;QACH,cAAc,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,GAAG,EAAE,GAAG,CAAC,QAAQ;YACjB,QAAQ,EAAE,KAAK;YACf,GAAG,EAAE,KAAK;YACV,MAAM,EAAE,WAAW;YACnB,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,IAAI;SACb,CAAC,CAAC,IAAI,EAAE,CAAC;IACZ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IACxC,CAAC;IAED,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IACxC,CAAC;IAED,IAAI,iBAAiB,GAAG,KAAK,CAAC;IAC9B,IAAI,YAAY,GAAG,KAAK,CAAC;IAEzB,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM;YAAE,SAAS;QACtB,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,2BAA2B,CAAC,GAAG,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC,CAAC;QAEtC,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC,iBAAiB,IAAI,0BAA0B,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;gBACnE,iBAAiB,GAAG,IAAI,CAAC;YAC3B,CAAC;YACD,IAAI,CAAC,YAAY,IAAI,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;gBACtD,YAAY,GAAG,IAAI,CAAC;YACtB,CAAC;YACD,IAAI,iBAAiB,IAAI,YAAY;gBAAE,MAAM;QAC/C,CAAC;QACD,IAAI,iBAAiB,IAAI,YAAY;YAAE,MAAM;IAC/C,CAAC;IAED,MAAM,QAAQ,GAAG,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAE9D,IAAI,iBAAiB,IAAI,YAAY,EAAE,CAAC;QACtC,QAAQ,CAAC,IAAI,CAAC;YACZ,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,eAAe;YACrB,QAAQ,EAAE,MAAM;YAChB,QAAQ;YACR,OAAO,EACL,iGAAiG;YACnG,UAAU,EACR,6JAA6J;SAChK,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC;gBACZ,MAAM,EAAE,OAAO;gBACf,IAAI,EAAE,eAAe;gBACrB,QAAQ,EAAE,SAAS;gBACnB,QAAQ;gBACR,OAAO,EACL,6MAA6M;gBAC/M,UAAU,EACR,oKAAoK;aACvK,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,QAAQ,CAAC,IAAI,CAAC;gBACZ,MAAM,EAAE,OAAO;gBACf,IAAI,EAAE,eAAe;gBACrB,QAAQ,EAAE,SAAS;gBACnB,QAAQ;gBACR,OAAO,EACL,qIAAqI;gBACvI,UAAU,EACR,qIAAqI;aACxI,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,cAAc,CAAC,MAAM,EAAE,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS,cAAc,CAAC;IACvC,IAAI,EAAE;QACJ,IAAI,EAAE,eAAe;QACrB,UAAU,EAAE,OAAO;QACnB,eAAe,EAAE,SAAS;QAC1B,gBAAgB,EAAE,2EAA2E;QAC7F,eAAe,EACb,khCAAkhC;QACphC,OAAO,EACL,iGAAiG;QACnG,SAAS,EAAE;;;;;;;;iPAQkO;QAC7O,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE;;;;;GAKX;gBACK,GAAG,EAAE;8DACiD;aACvD;YACD;gBACE,IAAI,EAAE;;;EAGZ;gBACM,GAAG,EAAE,qEAAqE;aAC3E;YACD;gBACE,IAAI,EAAE;;;;;;GAMX;gBACK,GAAG,EAAE;;;EAGX;aACK;SACF;QACD,SAAS,EAAE;YACT,4JAA4J;YAC5J,kHAAkH;YAClH,8DAA8D;YAC9D,wFAAwF;YACxF,6GAA6G;SAC9G;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC7B,CAAC,CAAC"}

package/dist/rules/ai-governance-ai-marker-anti-patterns.d.ts

@@ -0,0 +1,15 @@
+import type { Rule } from "../types.js";
+export declare function detectSparkleOnlyMarker(source: string): boolean;
+export declare function fileHasAiContext(source: string): boolean;
+export declare function detectAiInCtaLabel(source: string): {
+    label: string;
+}[];
+export declare const rule: Rule;
+export declare const _internal: {
+    detectSparkleOnlyMarker: typeof detectSparkleOnlyMarker;
+    detectAiInCtaLabel: typeof detectAiInCtaLabel;
+    fileHasAiContext: typeof fileHasAiContext;
+    isAllowlisted: (repoRoot: string) => boolean;
+    DISABLE_DIRECTIVE: string;
+    ALLOWLIST_CANDIDATES: string[];
+};

package/dist/rules/ai-governance-ai-marker-anti-patterns.js

@@ -0,0 +1,178 @@
+import { join } from "node:path";
+import fg from "fast-glob";
+import { createLyseRule } from "./_rule-module.js";
+import { isAiMarkerName, extractNamesFromSource, safeReadText, COMPONENT_GLOB, SCAN_IGNORE, makeAllowlistCheck, } from "./ai-governance-ai-marker-component-present.js";
+const RULE_ID = "ai-governance/ai-marker-anti-patterns";
+const DISABLE_DIRECTIVE = `lyse-disable ${RULE_ID}`;
+const ALLOWLIST_CANDIDATES = [
+    "README.md",
+    "README",
+    "README.mdx",
+    "readme.md",
+    ".lyse.yaml",
+    ".lyse.yml",
+];
+const isAllowlisted = makeAllowlistCheck(DISABLE_DIRECTIVE);
+const SPARKLE_LITERAL = /[✨✩\u{1F31F}❇]/u;
+const SPARKLE_IMPORT = /\b(Sparkle|Sparkles|SparkleIcon)\b/;
+const SPARKLE_ICON_PROP = /icon\s*=\s*["'`]\s*sparkle/i;
+const TEXT_MARKER_COMPOUND = /\b(generated by ai|ai[- ]generated|powered by ai)\b/i;
+const TEXT_MARKER_STANDALONE = /(^|[^A-Za-z])AI([^A-Za-z]|$)/;
+const CTA_STRIP = /<(?:button|Button|a)\b[^>]*>[\s\S]*?<\/(?:button|Button|a)\s*>|<[A-Za-z][\w.-]*\b[^>]*\brole\s*=\s*["']button["'][^>]*>[\s\S]*?<\/[A-Za-z][\w.-]*\s*>/g;
+export function detectSparkleOnlyMarker(source) {
+    const hasSparkle = SPARKLE_LITERAL.test(source) ||
+        SPARKLE_IMPORT.test(source) ||
+        SPARKLE_ICON_PROP.test(source);
+    if (!hasSparkle)
+        return false;
+    if (TEXT_MARKER_COMPOUND.test(source))
+        return false;
+    const stripped = source.replace(CTA_STRIP, " ");
+    if (TEXT_MARKER_STANDALONE.test(stripped))
+        return false;
+    for (const tag of source.matchAll(/<\s*([A-Za-z][\w.-]*)/g)) {
+        if (tag[1] !== undefined && isAiMarkerName(tag[1]))
+            return false;
+    }
+    return true;
+}
+export function fileHasAiContext(source) {
+    for (const name of extractNamesFromSource(source)) {
+        if (isAiMarkerName(name))
+            return true;
+    }
+    for (const tag of source.matchAll(/<\s*([A-Za-z][\w.-]*)/g)) {
+        if (tag[1] !== undefined && isAiMarkerName(tag[1]))
+            return true;
+    }
+    return false;
+}
+const CTA_OPEN = /<(button|Button|a)\b[^>]*>|<[A-Za-z][\w.-]*\b[^>]*\brole\s*=\s*["']button["'][^>]*>/g;
+const STANDALONE_AI = /(^|[^A-Za-z])AI([^A-Za-z]|$)/;
+export function detectAiInCtaLabel(source) {
+    const out = [];
+    let m;
+    CTA_OPEN.lastIndex = 0;
+    while ((m = CTA_OPEN.exec(source)) !== null) {
+        const openTag = m[0];
+        const tagNameMatch = /^<([A-Za-z][\w.-]*)/.exec(openTag);
+        const tagName = tagNameMatch?.[1] ?? "div";
+        const rest = source.slice(m.index + openTag.length);
+        const closeRe = new RegExp(`<\\/\\s*${tagName}\\s*>`);
+        const close = rest.search(closeRe);
+        const inner = (close === -1 ? rest : rest.slice(0, close))
+            .replace(/<[^>]*>/g, " ")
+            .trim();
+        if (inner.length > 0 && STANDALONE_AI.test(inner)) {
+            out.push({ label: inner.replace(/\s+/g, " ") });
+        }
+    }
+    return out;
+}
+const evaluate = async (ctx, _files) => {
+    const findings = [];
+    if (!ctx.repoRoot) {
+        return { findings, opportunities: 0 };
+    }
+    if (isAllowlisted(ctx.repoRoot)) {
+        return { findings, opportunities: 0 };
+    }
+    let componentFiles = [];
+    try {
+        componentFiles = fg
+            .sync(COMPONENT_GLOB, {
+            cwd: ctx.repoRoot,
+            ignore: SCAN_IGNORE,
+            absolute: false,
+            dot: false,
+            onlyFiles: true,
+            unique: true,
+        })
+            .sort();
+    }
+    catch {
+        // non-fatal
+    }
+    for (const rel of componentFiles) {
+        const source = safeReadText(join(ctx.repoRoot, rel));
+        if (!source)
+            continue;
+        if (fileHasAiContext(source) && detectSparkleOnlyMarker(source)) {
+            findings.push({
+                ruleId: RULE_ID,
+                axis: "ai-governance",
+                severity: "warning",
+                location: { file: rel, line: 1, column: 1 },
+                message: "Sparkle used as the sole AI marker — pair it with a text label or AI-marker component (SAP Fiori XAI forbids icon-only AI marking).",
+            });
+        }
+        for (const hit of detectAiInCtaLabel(source)) {
+            findings.push({
+                ruleId: RULE_ID,
+                axis: "ai-governance",
+                severity: "warning",
+                location: { file: rel, line: 1, column: 1 },
+                message: `"AI" used as a CTA action label ("${hit.label}") — describe the action, not the technology (GitLab Pajamas).`,
+            });
+        }
+    }
+    findings.sort((a, b) => {
+        const fa = a.location?.file ?? "";
+        const fb = b.location?.file ?? "";
+        if (fa < fb)
+            return -1;
+        if (fa > fb)
+            return 1;
+        return (a.location?.line ?? 0) - (b.location?.line ?? 0);
+    });
+    return { findings, opportunities: componentFiles.length };
+};
+export const rule = createLyseRule({
+    meta: {
+        axis: "ai-governance",
+        lyseRuleId: RULE_ID,
+        defaultSeverity: "warning",
+        shortDescription: "Lint AI-marker anti-patterns in component source files",
+        fullDescription: "Scans component files (`**/*.{tsx,jsx,vue}`) for two forbidden AI-marking anti-patterns. Anti-pattern A: a sparkle signal (`✨` literal, `Sparkle`/`Sparkles`/`SparkleIcon` import, or `icon=\"sparkle*\"` prop) used as the sole AI marker with no accompanying text label or AI-marker component — SAP Fiori XAI forbids icon-only marking because it fails accessibility and is ambiguous. Anti-pattern B: the standalone, case-sensitive token `AI` used as the primary action label of a `<button>`, `<Button>`, or `<a>` element — GitLab Pajamas forbids this because `AI` describes the technology, not the user action. Both detectors are pure source heuristics with no runtime or behavioral analysis. Emits `warning` for each occurrence. A sparkle accompanied by a text AI-marker or AI-marker component (`AILabel`, `AIBadge`, magic-* etc.) is not flagged. `AI` appearing only in body or descriptor text (headings, paragraphs) is not flagged.",
+        helpUri: "https://github.com/lyse-labs/lyse/blob/main/docs/rules/ai-governance-ai-marker-anti-patterns.md",
+        rationale: `Why it matters
+
+Icon-only AI marking (a lone sparkle ✨) silently fails users who rely on assistive technology: a screen reader announces an image description or nothing at all — not "AI-generated." SAP Fiori XAI made this explicit: sparkle MUST be paired with a text label or dedicated AI-marker component. Lyse enforces the same constraint statically.
+
+Labelling a CTA button "AI" is a UX anti-pattern: "AI" is a noun describing technology, not an action verb. GitLab Pajamas explicitly forbids it, recommending "Summarize," "Explain," or "Generate" instead — words that tell the user what will happen, not what engine does it. Lyse catches this in source before it ships.
+
+Both findings are warnings (not errors) because the fix is mechanical and low-risk.`,
+        examples: [
+            {
+                good: '<span><AILabel>AI</AILabel> <Sparkles aria-hidden/></span>',
+                bad: '<span>✨ {generatedText}</span>',
+            },
+            {
+                good: '<button>Summarize</button>',
+                bad: '<button>AI</button>',
+            },
+            {
+                good: '<button>Draft reply</button>',
+                bad: '<button>Ask AI</button>',
+            },
+        ],
+        allowlist: [
+            "repos containing `lyse-disable ai-governance/ai-marker-anti-patterns` in an adjacent README or `.lyse.yaml` — rule is N/A for the entire repo",
+            "files larger than 1 MB — skipped to avoid pathological cases",
+            "files under `node_modules/`, `dist/`, `build/`",
+            "sparkle accompanied by a text AI-marker (`AILabel`, `AIBadge`, magic-*, GenAI*, etc.) — not flagged",
+            "`AI` in non-CTA elements (headings, paragraphs, spans) — not flagged",
+        ],
+    },
+    defaultOptions: [],
+    create: () => ({ evaluate }),
+});
+export const _internal = {
+    detectSparkleOnlyMarker,
+    detectAiInCtaLabel,
+    fileHasAiContext,
+    isAllowlisted,
+    DISABLE_DIRECTIVE,
+    ALLOWLIST_CANDIDATES,
+};
+//# sourceMappingURL=ai-governance-ai-marker-anti-patterns.js.map

package/dist/rules/ai-governance-ai-marker-anti-patterns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-governance-ai-marker-anti-patterns.js","sourceRoot":"","sources":["../../src/rules/ai-governance-ai-marker-anti-patterns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,WAAW,CAAC;AAQ3B,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,YAAY,EACZ,cAAc,EACd,WAAW,EACX,kBAAkB,GACnB,MAAM,gDAAgD,CAAC;AAExD,MAAM,OAAO,GAAG,uCAAuC,CAAC;AACxD,MAAM,iBAAiB,GAAG,gBAAgB,OAAO,EAAE,CAAC;AACpD,MAAM,oBAAoB,GAAG;IAC3B,WAAW;IACX,QAAQ;IACR,YAAY;IACZ,WAAW;IACX,YAAY;IACZ,WAAW;CACZ,CAAC;AAEF,MAAM,aAAa,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;AAE5D,MAAM,eAAe,GAAG,iBAAiB,CAAC;AAC1C,MAAM,cAAc,GAAG,oCAAoC,CAAC;AAC5D,MAAM,iBAAiB,GAAG,6BAA6B,CAAC;AACxD,MAAM,oBAAoB,GAAG,sDAAsD,CAAC;AACpF,MAAM,sBAAsB,GAAG,8BAA8B,CAAC;AAC9D,MAAM,SAAS,GAAG,wJAAwJ,CAAC;AAE3K,MAAM,UAAU,uBAAuB,CAAC,MAAc;IACpD,MAAM,UAAU,GACd,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC;QAC5B,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC;QAC3B,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,UAAU;QAAE,OAAO,KAAK,CAAC;IAC9B,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,KAAK,CAAC;IACpD,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAChD,IAAI,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAC;IACxD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,CAAC;QAC5D,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;IACnE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC7C,KAAK,MAAM,IAAI,IAAI,sBAAsB,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,IAAI,cAAc,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;IACxC,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,CAAC;QAC5D,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;IAClE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,QAAQ,GAAG,sFAAsF,CAAC;AACxG,MAAM,aAAa,GAAG,8BAA8B,CAAC;AAErD,MAAM,UAAU,kBAAkB,CAAC,MAAc;IAC/C,MAAM,GAAG,GAAwB,EAAE,CAAC;IACpC,IAAI,CAAyB,CAAC;IAC9B,QAAQ,CAAC,SAAS,GAAG,CAAC,CAAC;IACvB,OAAO,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QAC5C,MAAM,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACrB,MAAM,YAAY,GAAG,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,MAAM,OAAO,GAAG,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC;QAC3C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,WAAW,OAAO,OAAO,CAAC,CAAC;QACtD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;aACvD,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;aACxB,IAAI,EAAE,CAAC;QACV,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAClD,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,QAAQ,GAAG,KAAK,EACpB,GAAgB,EAChB,MAAmB,EACM,EAAE;IAC3B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAClB,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IACxC,CAAC;IACD,IAAI,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IACxC,CAAC;IAED,IAAI,cAAc,GAAa,EAAE,CAAC;IAClC,IAAI,CAAC;QACH,cAAc,GAAG,EAAE;aAChB,IAAI,CAAC,cAAc,EAAE;YACpB,GAAG,EAAE,GAAG,CAAC,QAAQ;YACjB,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,KAAK;YACf,GAAG,EAAE,KAAK;YACV,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,IAAI;SACb,CAAC;aACD,IAAI,EAAE,CAAC;IACZ,CAAC;IAAC,MAAM,CAAC;QACP,YAAY;IACd,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM;YAAE,SAAS;QAEtB,IAAI,gBAAgB,CAAC,MAAM,CAAC,IAAI,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC;YAChE,QAAQ,CAAC,IAAI,CAAC;gBACZ,MAAM,EAAE,OAAO;gBACf,IAAI,EAAE,eAAe;gBACrB,QAAQ,EAAE,SAAS;gBACnB,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;gBAC3C,OAAO,EACL,qIAAqI;aACxI,CAAC,CAAC;QACL,CAAC;QAED,KAAK,MAAM,GAAG,IAAI,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7C,QAAQ,CAAC,IAAI,CAAC;gBACZ,MAAM,EAAE,OAAO;gBACf,IAAI,EAAE,eAAe;gBACrB,QAAQ,EAAE,SAAS;gBACnB,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;gBAC3C,OAAO,EAAE,qCAAqC,GAAG,CAAC,KAAK,gEAAgE;aACxH,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACrB,MAAM,EAAE,GAAG,CAAC,CAAC,QAAQ,EAAE,IAAI,IAAI,EAAE,CAAC;QAClC,MAAM,EAAE,GAAG,CAAC,CAAC,QAAQ,EAAE,IAAI,IAAI,EAAE,CAAC;QAClC,IAAI,EAAE,GAAG,EAAE;YAAE,OAAO,CAAC,CAAC,CAAC;QACvB,IAAI,EAAE,GAAG,EAAE;YAAE,OAAO,CAAC,CAAC;QACtB,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,cAAc,CAAC,MAAM,EAAE,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS,cAAc,CAAC;IACvC,IAAI,EAAE;QACJ,IAAI,EAAE,eAAe;QACrB,UAAU,EAAE,OAAO;QACnB,eAAe,EAAE,SAAS;QAC1B,gBAAgB,EAAE,wDAAwD;QAC1E,eAAe,EACb,o6BAAo6B;QACt6B,OAAO,EACL,iGAAiG;QACnG,SAAS,EAAE;;;;;;oFAMqE;QAChF,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,4DAA4D;gBAClE,GAAG,EAAE,gCAAgC;aACtC;YACD;gBACE,IAAI,EAAE,4BAA4B;gBAClC,GAAG,EAAE,qBAAqB;aAC3B;YACD;gBACE,IAAI,EAAE,8BAA8B;gBACpC,GAAG,EAAE,yBAAyB;aAC/B;SACF;QACD,SAAS,EAAE;YACT,+IAA+I;YAC/I,8DAA8D;YAC9D,gDAAgD;YAChD,qGAAqG;YACrG,sEAAsE;SACvE;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC7B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,uBAAuB;IACvB,kBAAkB;IAClB,gBAAgB;IAChB,aAAa;IACb,iBAAiB;IACjB,oBAAoB;CACrB,CAAC"}

package/dist/rules/ai-governance-ai-marker-component-present.d.ts

@@ -0,0 +1,28 @@
+import type { Rule } from "../types.js";
+export declare const AI_MARKER_NAMES: ReadonlySet<string>;
+export declare const COMPONENT_GLOB = "**/*.{tsx,jsx,vue}";
+export declare const SCAN_IGNORE: string[];
+declare function isAllowlisted(repoRoot: string): boolean;
+export declare function isAiMarkerName(name: string): boolean;
+export declare function safeReadText(absPath: string): string | null;
+export declare function extractNamesFromSource(source: string): string[];
+export declare function extractVueNames(source: string): string[];
+export declare function deriveComponentNameFromPath(relPath: string): string;
+export declare function fileHasAiMarker(source: string, relPath: string): boolean;
+export declare function makeAllowlistCheck(disableDirective: string): (repoRoot: string) => boolean;
+export declare function scanForMarkerComponents(repoRoot: string): string[];
+export declare const rule: Rule;
+export declare const _internal: {
+    isAiMarkerName: typeof isAiMarkerName;
+    isAllowlisted: typeof isAllowlisted;
+    scanForMarkerComponents: typeof scanForMarkerComponents;
+    extractNamesFromSource: typeof extractNamesFromSource;
+    DISABLE_DIRECTIVE: string;
+    ALLOWLIST_CANDIDATES: string[];
+    COMPONENT_GLOB: string;
+    SCAN_IGNORE: string[];
+    deriveComponentNameFromPath: typeof deriveComponentNameFromPath;
+    fileHasAiMarker: typeof fileHasAiMarker;
+    makeAllowlistCheck: typeof makeAllowlistCheck;
+};
+export {};