@akanjs/devkit 3.1.0-rc.4 → 3.1.0-rc.5

package/transforms/browserDirnamePlugin.test.ts

@@ -0,0 +1,88 @@
+import { describe, expect, test } from "bun:test";
+import { realpathSync } from "node:fs";
+import path from "node:path";
+import { tempDirs, writeText } from "../testHelpers";
+import { createBrowserDirnamePlugin } from "./browserDirnamePlugin";
+
+const makeTempRoot = tempDirs("akan-devkit-browser-dirname-");
+
+const build = async (entry: string) => {
+  const result = await Bun.build({
+    entrypoints: [entry],
+    target: "browser",
+    minify: true,
+    plugins: [createBrowserDirnamePlugin()],
+  });
+  expect(result.success).toBe(true);
+  return (await Promise.all(result.outputs.map((output) => output.text()))).join("\n");
+};
+
+describe("createBrowserDirnamePlugin", () => {
+  test("gives a vendor module its path from node_modules on, never the absolute one", async () => {
+    const root = await makeTempRoot();
+    await writeText(path.join(root, "node_modules/cjsdep/package.json"), '{ "name": "cjsdep", "main": "index.js" }\n');
+    await writeText(
+      path.join(root, "node_modules/cjsdep/index.js"),
+      "module.exports = { dir: __dirname, file: __filename };\n",
+    );
+    await writeText(
+      path.join(root, "node_modules/esmdep/package.json"),
+      '{ "name": "esmdep", "type": "module", "main": "index.js" }\n',
+    );
+    await writeText(
+      path.join(root, "node_modules/esmdep/index.js"),
+      // biome-ignore lint/suspicious/noTemplateCurlyInString: the fixture module's own source holds a template literal
+      'export const dir = typeof __dirname !== "undefined" ? `${__dirname}/` : "browser";\n',
+    );
+    await writeText(path.join(root, "node_modules/esmdep/legacy.cjs"), "module.exports = __filename;\n");
+    const entry = path.join(root, "entry.ts");
+    await writeText(
+      entry,
+      'import cjs from "cjsdep";\nimport { dir } from "esmdep";\nimport legacy from "esmdep/legacy.cjs";\nconsole.info(cjs, dir, legacy);\n',
+    );
+
+    const output = await build(entry);
+
+    expect(output).not.toContain(root);
+    expect(output).not.toContain(realpathSync(root));
+    expect(output).toContain('"/node_modules/cjsdep"');
+    expect(output).toContain('"/node_modules/cjsdep/index.js"');
+    expect(output).toContain('"/node_modules/esmdep/"');
+    expect(output).toContain('"/node_modules/esmdep/legacy.cjs"');
+  });
+
+  test("leaves a module's own __dirname binding alone", async () => {
+    const root = await makeTempRoot();
+    await writeText(path.join(root, "node_modules/owndep/package.json"), '{ "name": "owndep", "main": "index.js" }\n');
+    await writeText(
+      path.join(root, "node_modules/owndep/index.js"),
+      'const __dirname = "own-binding";\nmodule.exports = __dirname;\n',
+    );
+    const entry = path.join(root, "entry.ts");
+    await writeText(entry, 'import own from "owndep";\nconsole.info(own);\n');
+
+    const output = await build(entry);
+
+    expect(output).toContain('"own-binding"');
+    expect(output).not.toContain("/node_modules/owndep");
+  });
+
+  //? `define` would leak here: Bun applies it to the server modules a macro runs, which then read `/`.
+  test("keeps the real __dirname in the modules a macro runs", async () => {
+    const root = await makeTempRoot();
+    await writeText(path.join(root, "node_modules/fsdep/package.json"), '{ "name": "fsdep", "main": "index.js" }\n');
+    await writeText(path.join(root, "node_modules/fsdep/marker.txt"), "beside-me\n");
+    await writeText(
+      path.join(root, "node_modules/fsdep/index.js"),
+      'const fs = require("node:fs");\nmodule.exports = () => fs.readFileSync(__dirname + "/marker.txt", "utf8").trim();\n',
+    );
+    await writeText(
+      path.join(root, "macro.ts"),
+      'import readMarker from "fsdep";\nexport const marker = () => readMarker();\n',
+    );
+    const entry = path.join(root, "entry.ts");
+    await writeText(entry, 'import { marker } from "./macro" with { type: "macro" };\nconsole.info(marker());\n');
+
+    expect(await build(entry)).toContain('"beside-me"');
+  });
+});

package/transforms/browserDirnamePlugin.ts

@@ -0,0 +1,25 @@
+import path from "node:path";
+import type { BunPlugin } from "bun";
+
+const vendorScript = /[\\/]node_modules[\\/].+\.[cm]?js$/;
+
+//* Bun's browser build declares `__dirname` / `__filename` in each module naming them as the absolute path it read the
+//* module from, so a CSR bundle carried the checkout location and its hash moved with it. A vendor module gets its path
+//* from `node_modules` on instead. Not `define`: Bun applies that to the modules a macro imports and runs, where a
+//* server module reading files beside itself would read `/`, while a plugin never sees the macro graph.
+export const createBrowserDirnamePlugin = (): BunPlugin => ({
+  name: "akan-browser-dirname",
+  setup(build) {
+    build.onLoad({ filter: vendorScript }, async (args) => {
+      const source = await Bun.file(args.path).text();
+      if (!source.includes("__dirname") && !source.includes("__filename")) return undefined;
+      const posixPath = args.path.replaceAll("\\", "/");
+      const filename = posixPath.slice(posixPath.indexOf("/node_modules/"));
+      const define = { __dirname: JSON.stringify(path.posix.dirname(filename)), __filename: JSON.stringify(filename) };
+      return {
+        loader: "js",
+        contents: new Bun.Transpiler({ loader: "js", target: "browser", define }).transformSync(source),
+      };
+    });
+  },
+});

package/transforms/rscUseClientTransform.ts

@@ -2,9 +2,9 @@ import path from "node:path";
 import ts from "typescript";
 import { loaderFor } from "./moduleSyntax";
 
-const USE_CLIENT_RE = /^\s*(?:\/\*[\s\S]*?\*\/\s*|\/\/[^\n]*\n\s*)*["']use client["']/;
+const USE_CLIENT_RE = /^\s*(?:\/\*[^*]*\*+(?:[^/*][^*]*\*+)*\/\s*|\/\/[^\n]*\n\s*)*["']use client["']/;
 const IMPLICIT_ROOT_LAYOUT_RE =
-  /[/\\]\.akan[/\\]generated[/\\](?:implicit-root-layout|root-layouts[/\\].*__root_layout)\.(tsx|ts|jsx|js)$/;
+  /[/\\]\.akan[/\\]generated[/\\](?:implicit-root-layout|root-layouts[/\\][^/\\]*__root_layout)\.(tsx|ts|jsx|js)$/;
 const STAR_REEXPORT_HINT_RE = /\bexport\s*\*\s*from\b/;
 
 export interface UseClientTransformArgs {

package/transforms/transforms.test.ts

@@ -4,7 +4,12 @@ import { ApplicationBuildReporter } from "../applicationBuildReporter";
 import { tempDirs, writeText as write } from "../testHelpers";
 import { BarrelAnalyzer, type BarrelExportTarget } from "./barrelAnalyzer";
 import { rewriteBarrelImports } from "./barrelImportsPlugin";
-import { scanUseClientExports, toClientReferencePath, transformUseClient } from "./rscUseClientTransform";
+import {
+  hasUseClientDirective,
+  scanUseClientExports,
+  toClientReferencePath,
+  transformUseClient,
+} from "./rscUseClientTransform";
 import { createUseClientBundlePlugin } from "./useClientBundlePlugin";
 
 const makeTempRoot = tempDirs("akan-devkit-transform-");
@@ -27,6 +32,12 @@ describe("transformUseClient", () => {
     ).toBeNull();
   });
 
+  test("reads the directive through the leading comments only, in linear time", () => {
+    expect(hasUseClientDirective('/* a */\n// b /* c\n/** d **/\n"use client";')).toBe(true);
+    expect(hasUseClientDirective('/* a */ x /* b */ "use client";')).toBe(false);
+    expect(hasUseClientDirective(`${"/* a */\n".repeat(40)}export const value = 1;`)).toBe(false);
+  });
+
   test("a client module with no exports stays server code and is not reported as a client module", () => {
     const reported: string[] = [];
     const onClientModule = (file: string) => reported.push(file);
@@ -93,7 +104,12 @@ describe('export * in a "use client" module', () => {
       "export const text = \"export * from './a string'\";",
       "",
     ].join("\n");
-    expect(scanUseClientExports(shapes, file).sort()).toEqual(["LeaveInfo", "Voc", "ns", "text"]);
+    expect(scanUseClientExports(shapes, file).sort((a, b) => (a < b ? -1 : a > b ? 1 : 0))).toEqual([
+      "LeaveInfo",
+      "Voc",
+      "ns",
+      "text",
+    ]);
     expect(scanUseClientExports('export * from "./a";\nexport const X = 1;\n', file)).toEqual(["X"]);
     const stub = transformUseClient(shapes, { path: file, workspaceRoot: "/repo" });
     expect(stub).toContain("export const LeaveInfo = registerClientReference");

package/transforms/tsconfigPackageResolver.test.ts

@@ -167,6 +167,15 @@ describe("createTsconfigPackageResolver — node_modules fallback", () => {
     expect((await resolve("akanjs/signal"))?.entryFile).toBe(entryFile);
   });
 
+  test("substitutes every * of a wildcard target, as Node does", async () => {
+    const root = await makeTempRoot();
+    await writePackageJson(root, "akanjs", { exports: { "./*": "./*/*.js" } });
+    const entryFile = await write(root, "node_modules/akanjs/signal/signal.js");
+    const resolve = await resolverFor(root, {});
+
+    expect((await resolve("akanjs/signal"))?.entryFile).toBe(entryFile);
+  });
+
   test("resolves a scoped package subpath", async () => {
     // Vendor-neutral on purpose: `packageExports.test.ts` reads every `"@akanjs/devkit/<x>"` literal here as an import.
     const root = await makeTempRoot();

package/types.ts

@@ -44,4 +44,5 @@ export interface BaseDevEnv {
   env: "testing" | "debug" | "develop" | "main" | "local";
   portOffset: number;
   appName?: string | undefined;
+  defaulted?: ("AKAN_PUBLIC_REPO_NAME" | "AKAN_PUBLIC_SERVE_DOMAIN")[];
 }

package/workflow/artifacts.ts

@@ -205,7 +205,7 @@ const syncStateSlug = (target: string) =>
   target
     .trim()
     .replace(/[^a-zA-Z0-9]+/g, "-")
-    .replace(/^-+|-+$/g, "")
+    .replace(/^-|-$/g, "")
     .toLowerCase();
 
 export const workflowSyncStatePath = (target: string) => `${workflowSyncDir}/${syncStateSlug(target) || "target"}.json`;

package/workflow/rolloutGate.test.ts

@@ -56,7 +56,11 @@ describe("tooling rollout gate", () => {
       }),
     );
 
-    expect(violations.map((violation) => `${violation.packageName}:${violation.status}`).sort()).toEqual([
+    expect(
+      violations
+        .map((violation) => `${violation.packageName}:${violation.status}`)
+        .sort((a, b) => (a < b ? -1 : a > b ? 1 : 0)),
+    ).toEqual([
       "@ttsc/graph:reference-only",
       "ast-grep:experiment-only",
       "recast:experiment-only",

package/workflow/source.ts

@@ -32,7 +32,7 @@ export const sourceFile = (sys: Sys, path: string, action: PrimitiveChangedFile[
 export const moduleComponentName = (moduleName: string) =>
   moduleName
     .replace(/[-_]+/g, " ")
-    .replace(/(?:^|\s+)([a-zA-Z0-9])/g, (_, char: string) => char.toUpperCase())
+    .replace(/(?<=^|\s)[a-zA-Z0-9]/g, (char) => char.toUpperCase())
     .replace(/\s+/g, "");
 
 export const moduleSourcePaths = (moduleName: string) => {
@@ -768,7 +768,7 @@ export const insertTemplateField = ({
 
 export const ensureEnumImport = (content: string) => {
   if (content.includes("enumOf")) return content;
-  const baseImport = /import \{ ([^}]+) \} from "akanjs\/base";/.exec(content);
+  const baseImport = /import \{ ([^{}]+) \} from "akanjs\/base";/.exec(content);
   if (baseImport) {
     const names = baseImport[1]?.split(",").map((name) => name.trim()) ?? [];
     return content.replace(baseImport[0], `import { ${[...names, "enumOf"].sort().join(", ")} } from "akanjs/base";`);