@akanjs/devkit 3.0.0-alpha.9 → 3.0.0-alpha.91

package/linter.test.ts

@@ -0,0 +1,80 @@
+import { describe, expect, test } from "bun:test";
+import { type BiomeReport, parseBiomeReport } from "./linter";
+
+const reportOf = (diagnostics: BiomeReport["diagnostics"]): string =>
+  JSON.stringify({ summary: { errors: diagnostics?.length ?? 0, warnings: 0 }, diagnostics });
+
+const oneDiagnostic: BiomeReport["diagnostics"] = [
+  {
+    severity: "error",
+    message: "Unexpected any",
+    category: "lint/suspicious/noExplicitAny",
+    location: { path: "apps/demo/ui/Card.tsx", start: { line: 3, column: 10 } },
+  },
+];
+
+describe("parseBiomeReport", () => {
+  test("reads a report that is the whole output", () => {
+    const report = parseBiomeReport(reportOf(oneDiagnostic));
+    expect(report.diagnostics).toHaveLength(1);
+    expect(report.diagnostics?.[0]?.category).toBe("lint/suspicious/noExplicitAny");
+    expect(report.summary?.errors).toBe(1);
+  });
+
+  test("reads a report behind leading text", () => {
+    const output = `Skipped 3 files.\n${reportOf(oneDiagnostic)}`;
+    expect(parseBiomeReport(output).diagnostics).toHaveLength(1);
+  });
+
+  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.
+    const output = [
+      "configuration/deserialize: unknown key `overrides[0].includes { }`",
+      "  the file `biome.jsonc` cannot be read",
+      reportOf(oneDiagnostic),
+    ].join("\n");
+    expect(parseBiomeReport(output).diagnostics).toHaveLength(1);
+  });
+
+  test("skips a complete JSON object in leading text that is not a report", () => {
+    const output = `hint: try {"linter":{"enabled":true}} in your config\n${reportOf(oneDiagnostic)}`;
+    const report = parseBiomeReport(output);
+    expect(report.diagnostics).toHaveLength(1);
+    expect(report.summary?.errors).toBe(1);
+  });
+
+  test("reads a report followed by trailing text", () => {
+    const output = `${reportOf(oneDiagnostic)}\nChecked 12 files in 40ms. Found 1 error.`;
+    expect(parseBiomeReport(output).diagnostics).toHaveLength(1);
+  });
+
+  test("keeps a diagnostic whose message contains braces and quotes", () => {
+    const message = 'Replace {" a "} with { " a " } — the `{}` object syntax is not allowed';
+    const report = parseBiomeReport(reportOf([{ severity: "error", message }]));
+    expect(report.diagnostics?.[0]?.message).toBe(message);
+  });
+
+  test("keeps a diagnostic whose message ends in an escaped backslash before the closing quote", () => {
+    const message = "path separator is \\\\";
+    const report = parseBiomeReport(reportOf([{ severity: "warning", message }]));
+    expect(report.diagnostics?.[0]?.message).toBe(message);
+    expect(report.diagnostics).toHaveLength(1);
+  });
+
+  test("accepts a report carrying only a summary", () => {
+    expect(parseBiomeReport('{"summary":{"errors":0,"warnings":0}}').summary?.errors).toBe(0);
+  });
+
+  test("throws the output when it holds no JSON at all", () => {
+    expect(() => parseBiomeReport("biome: command not found\n")).toThrow("biome: command not found");
+  });
+
+  test("throws the output when the only brace never closes", () => {
+    expect(() => parseBiomeReport('internal error: {"diagnostics":[')).toThrow("internal error");
+  });
+
+  test("throws a named error for empty output", () => {
+    expect(() => parseBiomeReport("   \n")).toThrow("No Biome JSON output");
+  });
+});

package/linter.ts

@@ -3,14 +3,14 @@ import { existsSync, readFileSync } from "node:fs";
 import path from "node:path";
 import chalk from "chalk";
 
-type BiomeSeverity = "error" | "warning" | "information" | "hint";
+export type BiomeSeverity = "error" | "warning" | "information" | "hint";
 
-interface BiomePosition {
+export interface BiomePosition {
   line: number;
   column: number;
 }
 
-interface BiomeDiagnostic {
+export interface BiomeDiagnostic {
   severity: BiomeSeverity;
   message: string;
   category?: string;
@@ -21,7 +21,7 @@ interface BiomeDiagnostic {
   };
 }
 
-interface BiomeReport {
+export interface BiomeReport {
   summary?: {
     changed?: number;
     errors?: number;
@@ -58,19 +58,81 @@ 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.
+ */
+export const parseBiomeReport = (output: string): BiomeReport => {
+  for (let start = output.indexOf("{"); start !== -1; start = output.indexOf("{", start + 1)) {
+    const end = objectEndAt(output, start);
+    if (end === -1) break;
+    const report = asBiomeReport(output.slice(start, end + 1));
+    if (report) return report;
+  }
+  throw new Error(output.trim() || "No Biome JSON output");
+};
+
+const objectEndAt = (output: string, start: number): number => {
+  let depth = 0;
+  let inString = false;
+  let escaped = false;
+  for (let idx = start; idx < output.length; idx += 1) {
+    const char = output[idx];
+    if (inString) {
+      if (escaped) escaped = false;
+      else if (char === "\\") escaped = true;
+      else if (char === '"') inString = false;
+      continue;
+    }
+    if (char === '"') inString = true;
+    else if (char === "{") depth += 1;
+    else if (char === "}" && --depth === 0) return idx;
+  }
+  return -1;
+};
+
+const asBiomeReport = (candidate: string): BiomeReport | null => {
+  try {
+    const parsed = JSON.parse(candidate) as unknown;
+    if (!parsed || typeof parsed !== "object") return null;
+    if (!("diagnostics" in parsed) && !("summary" in parsed)) return null;
+    return parsed as BiomeReport;
+  } catch {
+    return 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;
+
 export class Linter {
   lintRoot: string;
+  configPath: string;
   #biomeBin: string;
 
   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");
     this.#biomeBin = existsSync(localBiomeBin) ? localBiomeBin : "biome";
   }
 
+  static #configPathIn(dir: string): string | null {
+    for (const fileName of BIOME_CONFIG_FILES) {
+      const configPath = path.join(dir, fileName);
+      if (existsSync(configPath)) return configPath;
+    }
+    return null;
+  }
+
   #findBiomeRootPath(dir: string): string {
-    const configPath = path.join(dir, "biome.json");
-    if (existsSync(configPath)) return dir;
+    if (Linter.#configPathIn(dir)) return dir;
     const parentDir = path.dirname(dir);
     if (parentDir === dir) throw new Error(`biome.json not found from ${dir}`);
     return this.#findBiomeRootPath(parentDir);
@@ -111,14 +173,6 @@ export class Linter {
     });
   }
 
-  #parseBiomeReport(output: string): BiomeReport {
-    const jsonStart = output.indexOf("{");
-    const jsonEnd = output.lastIndexOf("}");
-    if (jsonStart === -1 || jsonEnd === -1 || jsonEnd < jsonStart)
-      throw new Error(output.trim() || "No Biome JSON output");
-    return JSON.parse(output.slice(jsonStart, jsonEnd + 1)) as BiomeReport;
-  }
-
   #diagnosticFilePath(diagnostic: BiomeDiagnostic, fallbackFilePath: string) {
     const diagnosticPath = diagnostic.location?.path;
     if (!diagnosticPath) return fallbackFilePath;
@@ -193,10 +247,10 @@ export class Linter {
       "--max-diagnostics=none",
       "--no-errors-on-unmatched",
       "--config-path",
-      path.join(this.lintRoot, "biome.json"),
+      this.configPath,
       this.#toBiomePath(filePath),
     ]);
-    const report = this.#parseBiomeReport(stdout || stderr);
+    const report = parseBiomeReport(stdout || stderr);
     const results = this.#toLintResults(report, filePath);
     const { errors, warnings } = this.#splitMessages(results);
     const output = write && existsSync(filePath) ? readFileSync(filePath, "utf8") : undefined;
@@ -390,14 +444,7 @@ export class Linter {
 
     const source = readFileSync(resolvedFilePath, "utf8");
     const { stdout } = await this.#runBiome(
-      [
-        "check",
-        "--write",
-        "--config-path",
-        path.join(this.lintRoot, "biome.json"),
-        "--stdin-file-path",
-        this.#toBiomePath(resolvedFilePath),
-      ],
+      ["check", "--write", "--config-path", this.configPath, "--stdin-file-path", this.#toBiomePath(resolvedFilePath)],
       source,
     );
     const lintResult = await this.lintFile(resolvedFilePath);
@@ -409,10 +456,37 @@ export class Linter {
    * @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.
+   */
+  async fixFiles(filePaths: string[]): Promise<{ fixed: string[] }> {
+    const resolved = filePaths.map((filePath) => this.#resolveFilePath(filePath)).filter(existsSync);
+    if (resolved.length === 0) return { fixed: [] };
+    const before = new Map(resolved.map((filePath) => [filePath, readFileSync(filePath, "utf8")]));
+    await this.#runBiome([
+      "check",
+      "--write",
+      "--reporter=json",
+      "--max-diagnostics=none",
+      "--no-errors-on-unmatched",
+      "--config-path",
+      this.configPath,
+      ...resolved.map((filePath) => this.#toBiomePath(filePath)),
+    ]);
+    return {
+      fixed: resolved.filter((filePath) => readFileSync(filePath, "utf8") !== before.get(filePath)),
+    };
+  }
+
   async getConfigForFile(filePath: string): Promise<unknown> {
     const resolvedFilePath = this.#resolveFilePath(filePath);
     if (!existsSync(resolvedFilePath)) throw new Error(`File not found: ${filePath}`);
-    return JSON.parse(readFileSync(path.join(this.lintRoot, "biome.json"), "utf8")) as unknown;
+    return JSON.parse(readFileSync(this.configPath, "utf8")) as unknown;
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akanjs/devkit",
-  "version": "3.0.0-alpha.9",
+  "version": "3.0.0-alpha.91",
   "sourceType": "module",
   "type": "module",
   "publishConfig": {
@@ -14,7 +14,7 @@
     "directory": "pkgs/@akanjs/devkit"
   },
   "engines": {
-    "bun": ">=1.3.13"
+    "bun": ">=1.4.0"
   },
   "exports": {
     ".": {
@@ -33,7 +33,6 @@
     "./incrementalBuilder": "./incrementalBuilder/index.ts",
     "./mobile": "./mobile/index.ts",
     "./transforms": "./transforms/index.ts",
-    "./ui": "./ui/index.ts",
     "./workflow": "./workflow/index.ts",
     "./*.ts": "./*.ts",
     "./*": "./*.ts"
@@ -45,15 +44,13 @@
     "@langchain/openai": "^1.4.6",
     "@tailwindcss/node": "^4.3.0",
     "@trapezedev/project": "^7.1.4",
-    "akanjs": "3.0.0-alpha.9",
+    "akanjs": "3.0.0-alpha.91",
     "chalk": "^5.6.2",
     "commander": "^14.0.3",
     "dayjs": "^1.11.20",
     "fontaine": "^0.8.0",
     "fonteditor-core": "^2.6.3",
     "ignore": "^7.0.5",
-    "ink": "^6.8.0",
-    "js-yaml": "^4.1.1",
     "ora": "^9.4.0",
     "ssh2": "^1.17.0",
     "subset-font": "^2.5.0",
@@ -63,7 +60,7 @@
   },
   "peerDependencies": {
     "@capacitor/cli": "^8.3.4",
-    "react": "19.2.6"
+    "react": "19.2.7"
   },
   "peerDependenciesMeta": {
     "@capacitor/cli": {
@@ -77,4 +74,4 @@
   "bun": {
     "platform": "bun"
   }
-}
+}

package/prompter.ts

@@ -24,7 +24,6 @@ export class Prompter {
   }
 
   static async selectGuideline() {
-    const guidelineRoot = await Prompter.#getGuidelineRoot();
     const guideNames = await Prompter.listGuidelines();
     return await select({
       message: "Select a guideline",
@@ -41,11 +40,17 @@ export class Prompter {
     const guideJson = await fsPromise.readFile(filePath, "utf-8");
     return JSON.parse(guideJson) as GuideGenerateJson;
   }
+  /**
+   * The name is checked against the directory listing rather than interpolated straight into a path:
+   * it arrives from an MCP tool argument, and an unknown one has to name the valid set instead of
+   * surfacing an ENOENT that carries the host's own paths.
+   */
   static async getInstruction(guideName: string): Promise<string> {
+    const guideNames = await Prompter.listGuidelines();
+    if (!guideNames.includes(guideName))
+      throw new Error(`Unknown guideline "${guideName}". Available: ${guideNames.join(", ")}`);
     const guidelineRoot = await Prompter.#getGuidelineRoot();
-    const filePath = `${guidelineRoot}/${guideName}/${guideName}.instruction.md`;
-    const content = await fsPromise.readFile(filePath, "utf-8");
-    return content;
+    return await fsPromise.readFile(`${guidelineRoot}/${guideName}/${guideName}.instruction.md`, "utf-8");
   }
   static async getUpdateRequest(guideName: string) {
     return await input({

package/qualityScanner.test.ts

@@ -184,6 +184,15 @@ describe("AkanQualityScanner ssr rules", () => {
   });
 });
 
+const signalOf = (entries: string) =>
+  [
+    `import { endpoint, slice } from "akanjs/signal";`,
+    `export class PostSlice extends slice(srv.post, { guards: {}, mcp: { get: true } }, (init) => ({`,
+    entries,
+    `})) {}`,
+    "",
+  ].join("\n");
+
 describe("AkanQualityScanner layout rules", () => {
   test("flags an unknown app root file but not a facet entrypoint", async () => {
     const root = await makeWorkspace({
@@ -196,4 +205,111 @@ describe("AkanQualityScanner layout rules", () => {
     expect(warnings).toHaveLength(1);
     expect(warnings[0]?.file).toBe("apps/demo/helper.ts");
   });
+
+  test("flags an unknown lib root file but not a facet entrypoint", async () => {
+    const root = await makeWorkspace({
+      "libs/demo/client.ts": "export const client = 1;\n",
+      "libs/demo/helper.ts": "export const helper = 1;\n",
+    });
+
+    const warnings = rulesOf(await new AkanQualityScanner().scan(root), "akan.layout.lib-root-file");
+
+    expect(warnings).toHaveLength(1);
+    expect(warnings[0]?.file).toBe("libs/demo/helper.ts");
+  });
+
+  test("flags a root folder no facet owns, on both sides", async () => {
+    const root = await makeWorkspace({
+      "apps/demo/base/helper.ts": "export const helper = 1;\n",
+      "apps/demo/common/helper.ts": "export const helper = 1;\n",
+      "libs/demo/base/helper.ts": "export const helper = 1;\n",
+      "libs/demo/common/helper.ts": "export const helper = 1;\n",
+    });
+
+    const result = await new AkanQualityScanner().scan(root);
+
+    expect(rulesOf(result, "akan.layout.app-root-folder").map((warning) => warning.file)).toEqual([
+      "apps/demo/base/helper.ts",
+    ]);
+    expect(rulesOf(result, "akan.layout.lib-root-folder").map((warning) => warning.file)).toEqual([
+      "libs/demo/base/helper.ts",
+    ]);
+  });
+
+  test("keeps a root signal test out of the lib facet rule", async () => {
+    const root = await makeWorkspace({
+      "libs/demo/lib/cnst.ts": "export const cnst = 1;\n",
+      "libs/demo/lib/user.signal.test.ts": "export const test = 1;\n",
+      "libs/demo/lib/helper.ts": "export const helper = 1;\n",
+    });
+
+    const warnings = rulesOf(await new AkanQualityScanner().scan(root), "akan.layout.lib-facet-file");
+
+    expect(warnings).toHaveLength(1);
+    expect(warnings[0]?.file).toBe("libs/demo/lib/helper.ts");
+  });
+});
+
+describe("bang comments in browser-reachable files", () => {
+  const bangWarningsIn = async (files: Record<string, string>) => {
+    const result = await new AkanQualityScanner().scan(await makeWorkspace(files));
+    return rulesOf(result, "akan.file.bang-comment-in-client");
+  };
+
+  test("flags the first and last line, which the grit rule cannot reach", async () => {
+    const warnings = await bangWarningsIn({
+      "apps/demo/ui/First.tsx": "//! FIXME: broken\nexport const First = () => null;\n",
+      "apps/demo/ui/Last.tsx": "export const Last = () => null;\n//! left behind\n",
+    });
+
+    expect(warnings.map((warning) => `${warning.file}:${warning.line}`).sort()).toEqual([
+      "apps/demo/ui/First.tsx:1",
+      "apps/demo/ui/Last.tsx:2",
+    ]);
+    expect(warnings[0]?.fix).toContain("// FIXME:");
+  });
+
+  test("flags the block form and a marker trailing code", async () => {
+    const warnings = await bangWarningsIn({
+      "apps/demo/lib/task/Task.Zone.tsx": ["/*! keep me */", "export const Zone = () => null; //! and me", ""].join(
+        "\n",
+      ),
+    });
+
+    expect(warnings.map((warning) => warning.line)).toEqual([1, 2]);
+  });
+
+  test("ignores a double slash inside a string literal", async () => {
+    expect(
+      await bangWarningsIn({ "apps/demo/ui/Url.tsx": 'export const url = "https://host//!path";\n' }),
+    ).toHaveLength(0);
+  });
+
+  test("stays out of server files and tests", async () => {
+    const body = "//! server-only marker\nexport const value = 1;\n";
+    expect(
+      await bangWarningsIn({
+        "apps/demo/srvkit/storage.ts": body,
+        "apps/demo/lib/task/task.service.ts": body,
+        "apps/demo/ui/Card.test.tsx": body,
+        "apps/demo/lib/task/task.signal.spec.ts": body,
+      }),
+    ).toHaveLength(0);
+  });
+
+  test("covers every path role the grit rule is scoped to", async () => {
+    const body = "//! marker\nexport const value = 1;\n";
+    const files = [
+      "apps/demo/ui/Card.tsx",
+      "apps/demo/webkit/useThing.tsx",
+      "apps/demo/common/format.ts",
+      "apps/demo/page/task/_index.tsx",
+      "apps/demo/lib/task/task.constant.ts",
+      "apps/demo/lib/task/task.store.ts",
+      "apps/demo/lib/task/Task.Unit.tsx",
+    ];
+    const warnings = await bangWarningsIn(Object.fromEntries(files.map((file) => [file, body])));
+
+    expect(warnings.map((warning) => warning.file).sort()).toEqual([...files].sort());
+  });
 });