@akanjs/devkit 3.0.0 → 3.0.2-rc.0

package/workspaceLayout.test.ts

@@ -2,6 +2,7 @@ import { describe, expect, test } from "bun:test";
 import {
   appRootAllowedDirs,
   appRootAllowedFiles,
+  facetIndexShadowOf,
   isAllowedLibFacetRootFile,
   isScannedRootEntry,
   libRootAllowedDirs,
@@ -34,7 +35,7 @@ describe("app root layout allowlist", () => {
   test("names what a Capacitor app kept in its root as a leftover, not an unknown entry", () => {
     for (const name of ["android", "ios", "mobile", "capacitor.config.ts", "capacitor.config.json"]) {
       expect(appRootAllowedFiles.has(name) || appRootAllowedDirs.has(name)).toBe(false);
-      expect(rootEntryHintOf("app", name)).toContain(".akan/native/<target>");
+      expect(rootEntryHintOf("app", name)).toContain("dist/native/<app>/<target>");
     }
     expect(rootEntryHintOf("app", "base")).toBeNull();
     expect(rootEntryHintOf("lib", "ios")).toBeNull();
@@ -78,6 +79,28 @@ describe("lib root layout allowlist", () => {
   });
 });
 
+describe("hand-written facet index", () => {
+  test("flags every index Bun resolves ahead of the generated barrel, at the root of each barrel facet", () => {
+    for (const facet of ["ui", "webkit", "srvkit", "common", "plugin"])
+      for (const filename of ["index.tsx", "index.jsx", "index.mts"])
+        expect(facetIndexShadowOf(`${facet}/${filename}`)).toContain(`shadows the generated ${facet}/index.ts`);
+    expect(facetIndexShadowOf("ui/index.tsx")).toContain("Delete it");
+  });
+
+  test("leaves the generated barrel, a folder namespace, and folders without a barrel alone", () => {
+    for (const relativePath of [
+      "ui/index.ts",
+      "ui/index.js",
+      "ui/Chat/index.tsx",
+      "ui/Chat/index_.tsx",
+      "page/index.tsx",
+      "lib/index.tsx",
+      "index.tsx",
+    ])
+      expect(facetIndexShadowOf(relativePath)).toBeNull();
+  });
+});
+
 describe("lib facet root allowlist", () => {
   test("admits the generated support facets and a root signal test", () => {
     expect(isAllowedLibFacetRootFile("cnst.ts")).toBe(true);

package/workspaceLayout.ts

@@ -84,7 +84,24 @@ const libFacetRootTestPattern = /^[A-Za-z][A-Za-z0-9_-]*\.signal\.(test|spec)\.(
 export const isAllowedLibFacetRootFile = (filename: string) =>
   libFacetRootAllowedFiles.has(filename) || libFacetRootTestPattern.test(filename);
 
-//* What a Capacitor app kept in its root. The native runtime generates its projects under `.akan/native/<target>`, so
+export const barrelFacetDirs = ["ui", "webkit", "srvkit", "common", "plugin"] as const;
+
+//* Bun resolves a folder import to `index.tsx`, `index.jsx` or `index.mts` ahead of `index.ts`, and TypeScript to
+//* `index.ts` first, so one of these beside the generated barrel typechecks every name the barrel adds and serves none.
+const barrelShadowingIndexFiles = new Set(["index.tsx", "index.jsx", "index.mts"]);
+
+export const facetIndexShadowOf = (sysRelativePath: string) => {
+  const [facet, filename = "", ...nested] = sysRelativePath.split("/");
+  if (nested.length || !barrelShadowingIndexFiles.has(filename) || !barrelFacetDirs.some((dir) => dir === facet))
+    return null;
+  return (
+    `shadows the generated ${facet}/index.ts: Bun loads ${filename} and TypeScript checks index.ts, so a name only ` +
+    `the generated barrel exports typechecks and is undefined at runtime. Delete it, since the generated barrel ` +
+    `re-exports every file and folder in ${facet}/; a namespace it builds belongs in ${facet}/<Folder>/index.tsx`
+  );
+};
+
+//* What a Capacitor app kept in its root. The native runtime generates its projects under `dist/native/<app>/<target>`, so
 //* these are named as leftovers instead of as unknown entries.
 const retiredAppRootEntries = new Set([
   "android",
@@ -97,7 +114,7 @@ const retiredAppRootEntries = new Set([
 
 export const rootEntryHintOf = (type: SysType, name: string) =>
   type === "app" && retiredAppRootEntries.has(name)
-    ? "a Capacitor-era entry; the native runtime generates its projects under .akan/native/<target>, so delete it"
+    ? "a Capacitor-era entry; the native runtime generates its projects under dist/native/<app>/<target>, so delete it"
     : null;
 
 // scanSync reads roots through `Bun.Glob("*")`, which skips dotfiles, so doctor skips them the same way.