@akanjs/devkit 3.0.0-beta.9 → 3.0.1

package/lint/gritRules.test.ts

@@ -4,24 +4,14 @@ import { existsSync } from "node:fs";
 import { mkdir, mkdtemp, readdir, readFile, rm, writeFile } from "node:fs/promises";
 import os from "node:os";
 import path from "node:path";
+import { Linter } from "../linter";
 
-/**
- * Fixture tests for the GritQL plugins in this folder.
- *
- * These rules break the apps/libs build, and a rule that stops matching reports **zero diagnostics** rather
- * than an error — so a biome upgrade can retire one silently. GritQL has known sharp edges here (escaped
- * quotes, argument-position matching), which is what makes the quiet failure plausible rather than
- * theoretical.
- *
- * Each rule runs alone, against a config this test writes, so a diagnostic can only have come from that
- * plugin. The path scoping in `biome.base.json` is deliberately not exercised — what is under test is
- * whether the pattern still matches. A rule that reads `$filename` needs a real path anyway, which is what
- * a case's `fixture.json` supplies.
- */
+//? A rule that stops matching reports zero diagnostics, not an error, so a biome upgrade can retire one silently.
+//? Each rule runs alone against a config written here; the path scoping in biome.base.json is deliberately not tested.
 const lintDir = import.meta.dir;
 const fixturesDir = path.join(lintDir, "__fixtures__");
 const workspaceRoot = path.resolve(lintDir, "../../../..");
-const biomeBin = path.join(workspaceRoot, "node_modules/.bin/biome");
+const biomeBin = path.join(workspaceRoot, "node_modules", ".bin", Linter.biomeBinName);
 
 interface BiomeDiagnostic {
   severity: string;
@@ -30,13 +20,10 @@ interface BiomeDiagnostic {
   location?: { start?: { line?: number } };
 }
 
-/**
- * `path` is where the source is written inside the temp workspace, for a rule that gates on `$filename`;
- * its extension also decides whether the file may hold JSX. `expect: "file"` is for a rule whose span is
- * the whole module (`JsModule()`), where there is no per-line diagnostic to match.
- */
 interface FixtureMeta {
+  /** Where the source is written, for a rule that gates on `$filename`; its extension decides whether JSX parses. */
   path?: string;
+  /** `"file"`: the rule's span is the whole module (`JsModule()`), so there is no per-line diagnostic to match. */
   expect?: "lines" | "file";
 }
 
@@ -64,7 +51,6 @@ const runBiome = (args: string[], cwd: string) =>
     proc.on("close", () => resolve(stdout || stderr));
   });
 
-/** Every directory holding a `bad.*`, named `<rule>` or `<rule>/<case>`. */
 const collectCases = async (): Promise<FixtureCase[]> => {
   const cases: FixtureCase[] = [];
   const walk = async (dir: string, rule: string, name: string) => {
@@ -92,7 +78,6 @@ const sourceName = (fixture: FixtureCase, kind: "bad" | "good") => {
 const readFixture = async (fixture: FixtureCase, kind: "bad" | "good") =>
   await readFile(path.join(fixture.dir, sourceName(fixture, kind).read), "utf-8");
 
-/** Diagnostics from one plugin against one fixture, keyed by the 1-based line each was reported on. */
 const lintFixture = async (fixture: FixtureCase, kind: "bad" | "good") => {
   const dir = await mkdtemp(path.join(os.tmpdir(), `grit-${fixture.rule}-`));
   tempDirs.push(dir);
@@ -127,7 +112,7 @@ const lintFixture = async (fixture: FixtureCase, kind: "bad" | "good") => {
   };
 };
 
-/** The 1-based line of every line carrying `marker`. One case per line is the fixture contract. */
+//? One case per line is the fixture contract.
 const markedLines = async (fixture: FixtureCase, kind: "bad" | "good", marker: string) =>
   (await readFixture(fixture, kind))
     .split("\n")
@@ -164,8 +149,7 @@ describe("grit lint rules", () => {
       }
       const expected = await markedLines(fixture, "bad", "// @flag");
       expect(expected.length).toBeGreaterThan(0);
-      // Set equality, not containment: a marked line nobody reported is a pattern that stopped matching,
-      // and a reported line nobody marked is the rule reaching further than the fixture claims.
+      // Set equality: an unreported mark is a pattern that stopped matching, an unmarked report is overreach.
       expect(lines).toEqual(expected);
     });
 

package/lint/no-deep-internal-import.grit

@@ -15,7 +15,7 @@ or {
   JsModuleSource() as $source where {
     $source <: within JsImport(),
     not $filename <: r".*\.(?:test|spec)\.tsx?",
-    $filename <: r".*(?:apps|libs)/[^/]+/lib/[^/]+/[^/]+\.(?:ts|tsx)",
+    $filename <: r".*(?:apps|libs)[/\\][^/\\]+[/\\]lib[/\\][^/\\]+[/\\][^/\\]+\.(?:ts|tsx)",
     $source <: r"\"\.\./\.\./.*\"",
     register_diagnostic(
       span = $source,
@@ -25,7 +25,7 @@ or {
   JsModuleSource() as $source where {
     $source <: within JsImport(),
     not $filename <: r".*\.(?:test|spec)\.tsx?",
-    $filename <: r".*/lib/.+\.tsx",
+    $filename <: r".*[/\\]lib[/\\].+\.tsx",
     $source <: r"\"\.\./.*\"",
     register_diagnostic(
       span = $source,

package/lint/no-document-cookie.grit

@@ -0,0 +1,29 @@
+engine biome(1.0)
+language js(typescript, jsx)
+
+// A native shell serves the page from app://localhost on iOS, macOS and Linux, a custom scheme WebKit keeps no
+// cookie jar for: `document.cookie` reads "" and a write is dropped without an error, so the value exists in the
+// browser and silently vanishes in the app. akanjs/client's cookie helpers keep an app:// page's cookies in a
+// storage-backed jar, which is the only spelling that works in every shell.
+//
+// Pinned to the member nodes: a bare snippet also matches JSX text that spells the same words (a docs page), and a
+// write is its own node (JsStaticMemberAssignment) that the expression form does not match.
+or {
+  JsStaticMemberExpression() as $access where {
+    $access <: or { `document.cookie`, `window.document.cookie`, `globalThis.document.cookie`, `self.document.cookie` },
+    register_diagnostic(
+      span = $access,
+      message = "`document.cookie` is always empty on a native app page (app://localhost keeps no cookies), so this value vanishes in the app. Use `getCookie` / `setCookie` / `removeCookie` from `akanjs/client`.",
+      severity = "error"
+    )
+  },
+  JsStaticMemberAssignment(object = $object, member = $member) as $access where {
+    $member <: `cookie`,
+    $object <: or { `document`, `window.document`, `globalThis.document`, `self.document` },
+    register_diagnostic(
+      span = $access,
+      message = "`document.cookie` is always empty on a native app page (app://localhost keeps no cookies), so this value vanishes in the app. Use `getCookie` / `setCookie` / `removeCookie` from `akanjs/client`.",
+      severity = "error"
+    )
+  }
+}

package/lint/no-redeclare-predefined-endpoint.grit

@@ -14,7 +14,8 @@ language js(typescript, jsx)
     $base <: contains `endpoint`,
     $className <: r"([A-Z][a-zA-Z0-9]*)Endpoint"($Cap)
   },
-  $filename <: r".*/([a-z][a-zA-Z0-9]*)\.signal\.ts"($model),
+  // `$filename` carries backslashes on Windows, so a separator here must accept both.
+  $filename <: r".*[/\\]([a-z][a-zA-Z0-9]*)\.signal\.ts"($model),
   or {
     $key <: $model,
     $key <: r"(?:light|create|update|remove|view|edit|merge)([A-Z][a-zA-Z0-9]*)"($keyCap) where {

package/lint/no-static-in-object-light-model.grit

@@ -0,0 +1,27 @@
+engine biome(1.0)
+language js(typescript, jsx)
+
+// `via(XObject, LightX, ...)` mixes in only the prototypes of XObject and LightX (applyMixins in
+// akanjs/common), so a static declared on either never reaches the full model `X`. Statics belong on
+// XInput (or a scalar), X, or XInsight. The Object class is recognised by its `*Object` name, because its
+// via() shape is identical to the Insight's; the Light class also by its `[...] as const` field tuple.
+or {
+  JsMethodClassMember(),
+  JsPropertyClassMember(),
+  JsGetterClassMember(),
+  JsSetterClassMember(),
+  JsStaticInitializationBlockClassMember()
+} as $member where {
+  $member <: r"(?:(?:public|protected|private|declare|override|readonly|accessor)\s+)*static\b[\s\S]*",
+  $member <: within JsClassDeclaration() as $model where {
+    $model <: or {
+      r"class\s+(?:Light[A-Za-z0-9_$]*|[A-Za-z0-9_$]*Object)\s+extends\s+via\([\s\S]*",
+      r"class\s+[A-Za-z0-9_$]+\s+extends\s+via\(\s*[A-Za-z0-9_$.]+\s*,\s*\[[\s\S]*"
+    }
+  },
+  register_diagnostic(
+    span = $member,
+    message = "A static on an XObject or LightX class never reaches the full model, because via() mixes in their prototypes only. Declare it on XInput, the full model X, or XInsight instead.",
+    severity = "error"
+  )
+}

package/lint/no-web-only-api-outside-webkit.grit

@@ -0,0 +1,44 @@
+engine biome(1.0)
+language js(typescript, jsx)
+
+// Browser APIs a native shell's WebView lacks: Android's WebView has no Web Share, an app:// page on iOS has no
+// service worker, no WebView has the Notification API, and iOS has no vibration. They stay legal on the web, so the
+// rule does not ban them — it keeps them in `webkit/`, the layer whose hooks branch on the platform (and is
+// excluded from this rule's scope in biome.base.json), and names the native side where one exists.
+//
+// Pinned to member access, so JSX text naming an API does not match; `Notification` only through its static entry
+// points, because the name is also the libs/shared model (`Notification.View`, `cnst.Notification`).
+or {
+  JsStaticMemberExpression() as $access where {
+    $access <: or { `navigator.share`, `navigator.canShare` },
+    register_diagnostic(
+      span = $access,
+      message = "Android's WebView has no Web Share, so this does nothing in the app. Move it into a `webkit/` hook that branches on `isNativeApp()` from `akanjs/client/native`; the runtime's `share` plugin is the app side.",
+      severity = "warn"
+    )
+  },
+  JsStaticMemberExpression() as $access where {
+    $access <: or { `navigator.serviceWorker`, `Notification.requestPermission`, `Notification.permission` },
+    register_diagnostic(
+      span = $access,
+      message = "A native app page has no service worker or Notification API. Keep this in a `webkit/` hook behind `isNativeApp()`; native push is `push` from `akanjs/client/native`, and `usePushNotification` in libs/util wraps both.",
+      severity = "warn"
+    )
+  },
+  JsStaticMemberExpression() as $access where {
+    $access <: `navigator.geolocation`,
+    register_diagnostic(
+      span = $access,
+      message = "`navigator.geolocation` skips the app's location plugin and its permission flow. Use `useGeoLocation` from `akanjs/webkit`.",
+      severity = "warn"
+    )
+  },
+  JsStaticMemberExpression() as $access where {
+    $access <: `navigator.vibrate`,
+    register_diagnostic(
+      span = $access,
+      message = "iOS has no `navigator.vibrate`. Use `haptics` from `akanjs/client/native` in a `webkit/` hook.",
+      severity = "warn"
+    )
+  }
+}

package/lint/no-web-storage.grit

@@ -0,0 +1,30 @@
+engine biome(1.0)
+language js(typescript, jsx)
+
+// Web Storage works inside the native shells, so this is not about a crash: akanjs/client's `storage` is where the
+// backend is chosen per platform (the shell's Preferences — UserDefaults, SharedPreferences, a JSON file on the
+// desktop — in an app, localStorage on the web), `secretStorage` keeps credentials in the Keychain/Keystore and
+// clears them on a reinstall, and both answer nothing on the server where a bare `localStorage` read during SSR
+// throws.
+//
+// Only the global is matched — a reference, or a member of window/globalThis/self — pinned to those node kinds: a
+// bare snippet matches the name in any position, a field, an object key or JSX text included.
+or {
+  JsIdentifierExpression() as $access where {
+    $access <: or { `localStorage`, `sessionStorage` },
+    register_diagnostic(
+      span = $access,
+      message = "Web Storage bypasses the store akanjs picks per platform (the shell's Preferences in an app) and throws during SSR. Use `storage` from `akanjs/client`, or `secretStorage` for tokens and credentials; a value that may be lost with the tab belongs in component state or the store.",
+      severity = "error"
+    )
+  },
+  JsStaticMemberExpression(object = $root, member = $name) as $access where {
+    $root <: or { `window`, `globalThis`, `self` },
+    $name <: or { `localStorage`, `sessionStorage` },
+    register_diagnostic(
+      span = $access,
+      message = "Web Storage bypasses the store akanjs picks per platform (the shell's Preferences in an app) and throws during SSR. Use `storage` from `akanjs/client`, or `secretStorage` for tokens and credentials; a value that may be lost with the tab belongs in component state or the store.",
+      severity = "error"
+    )
+  }
+}

package/linter.test.ts

@@ -27,8 +27,7 @@ describe("parseBiomeReport", () => {
   });
 
   test("reads a report behind leading text that carries a brace", () => {
-    // The whole reason the first-brace-to-last-brace slice was wrong: Biome prints configuration and IO
-    // diagnostics onto the same stream as the report, and those messages quote source and config.
+    // Biome prints configuration and IO diagnostics onto the report's stream, and they quote source and config.
     const output = [
       "configuration/deserialize: unknown key `overrides[0].includes { }`",
       "  the file `biome.jsonc` cannot be read",

package/linter.ts

@@ -58,16 +58,8 @@ interface LintResponse {
   warnings: LintMessage[];
 }
 
-/**
- * Extracts the `--reporter=json` report from Biome's output.
- *
- * Biome mixes configuration and IO diagnostics into the same stream as the report, so the output is not
- * always JSON alone. Slicing from the first `{` to the last `}` mis-parses as soon as that leading text
- * carries a brace of its own, which is not hypothetical: a config error printed ahead of the report made
- * one unchanged command alternate between 2 and 10 diagnostics. So every `{` is tried as a start, its
- * match is found by depth while string literals are skipped, and the first candidate that both parses and
- * carries a report field wins — a brace in prose parses as nothing, and `{"a":1}` in prose is not a report.
- */
+// Biome mixes config and IO diagnostics into the report stream, and that text can carry braces of its own, so every
+// `{` is tried as a start (string literals skipped) and the first candidate that parses and carries a report field wins.
 export const parseBiomeReport = (output: string): BiomeReport => {
   for (let start = output.indexOf("{"); start !== -1; start = output.indexOf("{", start + 1)) {
     const end = objectEndAt(output, start);
@@ -111,7 +103,19 @@ const asBiomeReport = (candidate: string): BiomeReport | null => {
 /** Biome reads `biome.json` first and `biome.jsonc` second; only the latter may carry comments. */
 const BIOME_CONFIG_FILES = ["biome.json", "biome.jsonc"] as const;
 
+const emptyResult = (filePath: string): LintResult => ({
+  filePath,
+  messages: [],
+  errorCount: 0,
+  warningCount: 0,
+  fixableErrorCount: 0,
+  fixableWarningCount: 0,
+});
+
 export class Linter {
+  //? Bun links a package bin as `<name>.exe` (plus a `.bunx` stub) on Windows, and a bare `<name>` elsewhere.
+  static readonly biomeBinName = process.platform === "win32" ? "biome.exe" : "biome";
+
   lintRoot: string;
   configPath: string;
   #biomeBin: string;
@@ -119,7 +123,7 @@ export class Linter {
   constructor(cwdPath: string) {
     this.lintRoot = this.#findBiomeRootPath(cwdPath);
     this.configPath = Linter.#configPathIn(this.lintRoot) ?? path.join(this.lintRoot, "biome.json");
-    const localBiomeBin = path.join(this.lintRoot, "node_modules/.bin/biome");
+    const localBiomeBin = path.join(this.lintRoot, "node_modules", ".bin", Linter.biomeBinName);
     this.#biomeBin = existsSync(localBiomeBin) ? localBiomeBin : "biome";
   }
 
@@ -199,16 +203,7 @@ export class Linter {
     for (const diagnostic of report.diagnostics ?? []) {
       if (diagnostic.severity !== "error" && diagnostic.severity !== "warning") continue;
       const diagnosticFilePath = this.#diagnosticFilePath(diagnostic, filePath);
-      const result =
-        resultsByPath.get(diagnosticFilePath) ??
-        ({
-          filePath: diagnosticFilePath,
-          messages: [],
-          errorCount: 0,
-          warningCount: 0,
-          fixableErrorCount: 0,
-          fixableWarningCount: 0,
-        } satisfies LintResult);
+      const result = resultsByPath.get(diagnosticFilePath) ?? emptyResult(diagnosticFilePath);
       const message = this.#createLintMessage(diagnostic);
       result.messages.push(message);
       if (message.severity === 2) result.errorCount += 1;
@@ -217,15 +212,7 @@ export class Linter {
     }
 
     return [
-      resultsByPath.get(filePath) ??
-        ({
-          filePath,
-          messages: [],
-          errorCount: 0,
-          warningCount: 0,
-          fixableErrorCount: 0,
-          fixableWarningCount: 0,
-        } satisfies LintResult),
+      resultsByPath.get(filePath) ?? emptyResult(filePath),
       ...[...resultsByPath.entries()].filter(([resultPath]) => resultPath !== filePath).map(([, result]) => result),
     ];
   }
@@ -269,22 +256,12 @@ export class Linter {
     return await this.lintFile(filePath);
   }
 
-  /**
-   * Lint a single file using Biome.
-   * @param filePath - Path to the file to lint
-   * @returns Array of Biome results in the legacy lint result shape
-   */
   async lintFile(filePath: string): Promise<LintResponse> {
     const resolvedFilePath = this.#resolveFilePath(filePath);
     if (!existsSync(resolvedFilePath)) throw new Error(`File not found: ${filePath}`);
     return await this.#checkFile(resolvedFilePath);
   }
 
-  /**
-   * Format lint results for console output
-   * @param results - Array of Biome results
-   * @returns Formatted string
-   */
   formatLintResults(results: LintResult[]): string {
     if (results.length === 0) return "No files to lint";
 
@@ -305,7 +282,7 @@ export class Linter {
             const sourceContent = readFileSync(result.filePath, "utf8");
             sourceLines = sourceContent.split("\n");
           } catch {
-            // Ignore read errors
+            //? An unreadable source only loses its code frame.
           }
         }
 
@@ -318,14 +295,12 @@ export class Linter {
           output.push(`\n  ${icon} ${typeColor(type)}: ${message.message}${ruleInfo}`);
           output.push(`     ${chalk.gray("at")} ${result.filePath}:${chalk.bold(`${message.line}:${message.column}`)}`);
 
-          // Show source line with underline
           if (sourceLines.length > 0 && message.line <= sourceLines.length) {
             const sourceLine = sourceLines[message.line - 1];
             const lineNumber = message.line.toString().padStart(5, " ");
 
             output.push(`\n${chalk.dim(`${lineNumber} |`)} ${sourceLine}`);
 
-            // Create underline
             const underlinePrefix = " ".repeat(message.column - 1);
             const underlineLength = message.endColumn ? message.endColumn - message.column : 1;
             const underline = "^".repeat(Math.max(1, underlineLength));
@@ -345,27 +320,7 @@ export class Linter {
     return summary.concat(output).join("\n");
   }
 
-  /**
-   * Get detailed lint information
-   * @param filePath - Path to the file to lint
-   * @returns Object containing detailed lint information
-   */
-  async getDetailedLintInfo(filePath: string): Promise<{
-    results: LintResult[];
-    details: {
-      line: number;
-      column: number;
-      message: string;
-      ruleId: string | null;
-      severity: "error" | "warning";
-    }[];
-    stats: {
-      errorCount: number;
-      warningCount: number;
-      fixableErrorCount: number;
-      fixableWarningCount: number;
-    };
-  }> {
+  async getDetailedLintInfo(filePath: string) {
     const { results } = await this.lintFile(filePath);
 
     const details = results.flatMap((result) =>
@@ -385,22 +340,13 @@ export class Linter {
         fixableErrorCount: acc.fixableErrorCount + result.fixableErrorCount,
         fixableWarningCount: acc.fixableWarningCount + result.fixableWarningCount,
       }),
-      {
-        errorCount: 0,
-        warningCount: 0,
-        fixableErrorCount: 0,
-        fixableWarningCount: 0,
-      },
+      { errorCount: 0, warningCount: 0, fixableErrorCount: 0, fixableWarningCount: 0 },
     );
 
     return { results, details, stats };
   }
 
-  /**
-   * Check if a file has lint errors
-   * @param filePath - Path to the file to check
-   * @returns true if there are no errors, false otherwise
-   */
+  /** Also false when the file cannot be linted at all. */
   async hasNoLintErrors(filePath: string): Promise<boolean> {
     try {
       const { results } = await this.lintFile(filePath);
@@ -410,32 +356,17 @@ export class Linter {
     }
   }
 
-  /**
-   * Get only error messages (excluding warnings)
-   * @param filePath - Path to the file to lint
-   * @returns Array of error messages
-   */
   async getErrors(filePath: string): Promise<LintMessage[]> {
     const { results } = await this.lintFile(filePath);
     return results.flatMap((result) => result.messages.filter((message) => message.severity === 2));
   }
 
-  /**
-   * Get only warning messages
-   * @param filePath - Path to the file to lint
-   * @returns Array of warning messages
-   */
   async getWarnings(filePath: string): Promise<LintMessage[]> {
     const { results } = await this.lintFile(filePath);
     return results.flatMap((result) => result.messages.filter((message) => message.severity === 1));
   }
 
-  /**
-   * Fix lint errors automatically
-   * @param filePath - Path to the file to fix
-   * @param dryRun - If true, returns the fixed content without writing to file
-   * @returns Fixed content and remaining issues
-   */
+  /** `dryRun` returns the fixed content in `output` without writing the file. */
   async fixFile(filePath: string, dryRun = false): Promise<LintResponse> {
     const resolvedFilePath = this.#resolveFilePath(filePath);
     if (!existsSync(resolvedFilePath)) throw new Error(`File not found: ${filePath}`);
@@ -451,19 +382,8 @@ export class Linter {
     return { ...lintResult, fixed: stdout !== source, output: stdout };
   }
 
-  /**
-   * Get Biome configuration for a file
-   * @param filePath - Path to the file
-   * @returns Biome configuration object
-   */
-  /**
-   * Applies Biome's safe fixes to many files in one process.
-   *
-   * One spawn, not one per file: Biome's startup dominates a small file, so the per-file path turns a
-   * fifteen-file scaffold into three seconds of process launches. Paths that do not exist are dropped
-   * rather than thrown on, because the caller is usually reporting what a template just wrote and a
-   * template is allowed to decline a file.
-   */
+  // One spawn for all files: Biome's startup dominates a small file. Missing paths are dropped (a template may
+  // decline a file).
   async fixFiles(filePaths: string[]): Promise<{ fixed: string[] }> {
     const resolved = filePaths.map((filePath) => this.#resolveFilePath(filePath)).filter(existsSync);
     if (resolved.length === 0) return { fixed: [] };
@@ -489,21 +409,11 @@ export class Linter {
     return JSON.parse(readFileSync(this.configPath, "utf8")) as unknown;
   }
 
-  /**
-   * Get rules that are causing errors in a file
-   * @param filePath - Path to the file to check
-   * @returns Object mapping rule IDs to their error counts
-   */
   async getProblematicRules(filePath: string): Promise<Record<string, number>> {
     const { results } = await this.lintFile(filePath);
     const ruleCounts: Record<string, number> = {};
-
-    results.forEach((result) => {
-      result.messages.forEach((message) => {
-        if (message.ruleId) ruleCounts[message.ruleId] = (ruleCounts[message.ruleId] || 0) + 1;
-      });
-    });
-
+    for (const message of results.flatMap((result) => result.messages))
+      if (message.ruleId) ruleCounts[message.ruleId] = (ruleCounts[message.ruleId] || 0) + 1;
     return ruleCounts;
   }
 }