@akanjs/devkit 3.0.0-beta.20 → 3.0.0-beta.21

package/scanInfo.ts

@@ -1,4 +1,3 @@
-import { rm } from "node:fs/promises";
 import path from "node:path";
 import type {
   AppConfigResult,
@@ -11,7 +10,7 @@ import type {
 } from "./akanConfig";
 import { AkanAppConfig } from "./akanConfig";
 import { AppExecutor, LibExecutor, PkgExecutor, WorkspaceExecutor } from "./executors";
-import { isAllowedLibFacetRootFile, rootAllowedDirs, rootAllowedFiles } from "./workspaceLayout";
+import { isAllowedLibFacetRootFile, rootAllowedDirs, rootAllowedFiles, rootEntryHintOf } from "./workspaceLayout";
 
 const scalarFileTypes = ["constant", "dictionary", "document", "template", "unit", "util", "view", "zone"] as const;
 type ScalarFileType = (typeof scalarFileTypes)[number];
@@ -37,7 +36,6 @@ const fileTypeOf = (filename: string) =>
 
 type ModuleKind = "database" | "service" | "scalar";
 
-const generatedRootCapacitorConfigFiles = ["capacitor.config.js", "capacitor.config.json"] as const;
 const internalLibDirs = new Set(["__lib", "__scalar"]);
 const moduleNonUiFileTypes = {
   database: new Set(["constant", "dictionary", "document", "service", "signal", "store"]),
@@ -56,17 +54,12 @@ const createDependencyScanner = async (exec: AppExecutor | LibExecutor | PkgExec
 
 const getScanPath = (exec: AppExecutor | LibExecutor, relativePath: string) =>
   path.posix.join(`${exec.type}s`, exec.name, relativePath.split(path.sep).join("/"));
-async function clearGeneratedRootCapacitorConfigs(exec: AppExecutor | LibExecutor) {
-  if (exec.type !== "app") return;
-  await Promise.all(generatedRootCapacitorConfigFiles.map((filename) => rm(exec.getPath(filename), { force: true })));
-}
 const getModuleNameFromPath = (kind: ModuleKind, modulePath: string) => {
   const dirname = path.basename(modulePath);
   return kind === "service" ? dirname.replace(/^_+/, "") : dirname;
 };
 
 async function assertScanConvention(exec: AppExecutor | LibExecutor, libRoot: { files: string[]; dirs: string[] }) {
-  await clearGeneratedRootCapacitorConfigs(exec);
   const violations: string[] = [];
   const addViolation = (relativePath: string, reason: string) => {
     violations.push(`${getScanPath(exec, relativePath)}: ${reason}`);
@@ -76,9 +69,11 @@ async function assertScanConvention(exec: AppExecutor | LibExecutor, libRoot: {
   const allowedRootDirs: ReadonlySet<string> = rootAllowedDirs[exec.type];
   const { files, dirs } = await exec.getFilesAndDirs(".");
   for (const filename of files)
-    if (!allowedRootFiles.has(filename)) addViolation(filename, `unsupported ${exec.type} root file`);
+    if (!allowedRootFiles.has(filename))
+      addViolation(filename, rootEntryHintOf(exec.type, filename) ?? `unsupported ${exec.type} root file`);
   for (const dirname of dirs)
-    if (!allowedRootDirs.has(dirname)) addViolation(dirname, `unsupported ${exec.type} root folder`);
+    if (!allowedRootDirs.has(dirname))
+      addViolation(dirname, rootEntryHintOf(exec.type, dirname) ?? `unsupported ${exec.type} root folder`);
 
   //* A lib has no `getPageKeys`, so its own route files are validated here.
   if (exec.type === "lib")

package/workspaceLayout.test.ts

@@ -6,6 +6,7 @@ import {
   isScannedRootEntry,
   libRootAllowedDirs,
   libRootAllowedFiles,
+  rootEntryHintOf,
 } from "./workspaceLayout";
 
 describe("app root layout allowlist", () => {
@@ -15,7 +16,7 @@ describe("app root layout allowlist", () => {
   });
 
   test("admits every documented app root folder", () => {
-    for (const dirname of ["mobile", "plugin", "secrets", "srvkit", "webkit"]) {
+    for (const dirname of [".akan", "plugin", "script", "secrets", "srvkit", "webkit"]) {
       expect(appRootAllowedDirs.has(dirname)).toBe(true);
     }
   });
@@ -25,6 +26,15 @@ describe("app root layout allowlist", () => {
     expect(appRootAllowedDirs.has("base")).toBe(false);
   });
 
+  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/mobile/<target>");
+    }
+    expect(rootEntryHintOf("app", "base")).toBeNull();
+    expect(rootEntryHintOf("lib", "ios")).toBeNull();
+  });
+
   test("skips dotfile artifacts the sync glob never sees, but keeps .akan", () => {
     expect(isScannedRootEntry("app", ".DS_Store")).toBe(false);
     expect(isScannedRootEntry("app", ".akan")).toBe(true);
@@ -48,10 +58,10 @@ describe("lib root layout allowlist", () => {
   });
 
   test("rejects the app-only run and mobile entries", () => {
-    for (const filename of ["main.ts", "capacitor.config.ts", "akan.app.json"]) {
+    for (const filename of ["main.ts", "akan.app.json"]) {
       expect(libRootAllowedFiles.has(filename)).toBe(false);
     }
-    for (const dirname of [".akan", "android", "ios", "mobile", "script", "secrets"]) {
+    for (const dirname of [".akan", "script", "secrets"]) {
       expect(libRootAllowedDirs.has(dirname)).toBe(false);
     }
   });

package/workspaceLayout.ts

@@ -8,7 +8,6 @@ export const appRootAllowedFiles = new Set([
   "CLAUDE.md",
   "akan.app.json",
   "akan.config.ts",
-  "capacitor.config.ts",
   "client.ts",
   "main.ts",
   "package.json",
@@ -19,12 +18,9 @@ export const appRootAllowedFiles = new Set([
 
 export const appRootAllowedDirs = new Set([
   ".akan",
-  "android",
   "common",
   "env",
-  "ios",
   "lib",
-  "mobile",
   "page",
   "plugin",
   "private",
@@ -86,6 +82,22 @@ 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/mobile/<target>`, so
+//* these are named as leftovers instead of as unknown entries.
+const retiredAppRootEntries = new Set([
+  "android",
+  "ios",
+  "mobile",
+  "capacitor.config.ts",
+  "capacitor.config.js",
+  "capacitor.config.json",
+]);
+
+export const rootEntryHintOf = (type: SysType, name: string) =>
+  type === "app" && retiredAppRootEntries.has(name)
+    ? "a Capacitor-era entry; the native runtime generates its projects under .akan/mobile/<target>, so delete it"
+    : null;
+
 // scanSync reads roots through `Bun.Glob("*")`, which skips dotfiles, so doctor skips them the same way.
 export const isScannedRootEntry = (type: SysType, name: string) =>
   !name.startsWith(".") || rootAllowedDirs[type].has(name);

package/applicationReleasePackager.ts

@@ -1,189 +0,0 @@
-import { cp, mkdir, rm } from "node:fs/promises";
-import path from "node:path";
-import type { App } from "./commandDecorators";
-import { FileSys } from "./fileSys";
-import { uploadRelease } from "./uploadRelease";
-
-export interface ReleaseSourceOptions {
-  rebuild?: boolean;
-  buildNum?: number;
-  environment?: string;
-  local?: boolean;
-}
-
-interface ApplicationReleasePackagerOptions {
-  build: () => Promise<void>;
-}
-
-export class ApplicationReleasePackager {
-  #app: App;
-  #build: () => Promise<void>;
-
-  constructor(app: App, options: ApplicationReleasePackagerOptions) {
-    this.#app = app;
-    this.#build = options.build;
-  }
-
-  async releaseSource({
-    rebuild,
-    buildNum = 0,
-    environment = "debug",
-    local = true,
-  }: ReleaseSourceOptions = {}): Promise<void> {
-    const { platformVersion } = await this.#prepareReleaseBuild({ rebuild, buildNum });
-    await this.#writeSourceArchive({ readme: this.#confidentialReadme() });
-    await uploadRelease(this.#app.name, {
-      local,
-      buildNum,
-      environment,
-      platformVersion,
-      workspaceRoot: this.#app.workspace.cwdPath,
-    });
-  }
-
-  async compressProjectFiles({ rebuild, buildNum = 0 }: ReleaseSourceOptions = {}): Promise<void> {
-    await this.#prepareReleaseBuild({ rebuild, buildNum });
-    await this.#writeSourceArchive({ readme: this.#publicReadme() });
-  }
-
-  async #prepareReleaseBuild({ rebuild, buildNum }: { rebuild?: boolean; buildNum: number }) {
-    const akanConfig = await this.#app.getConfig();
-    const platformVersion = akanConfig.mobile.version;
-    const buildRoot = `${this.#app.workspace.workspaceRoot}/releases/builds/${this.#app.name}`;
-    if (await FileSys.dirExists(buildRoot)) await rm(buildRoot, { recursive: true, force: true });
-    await mkdir(buildRoot, { recursive: true });
-    if (rebuild || !(await FileSys.dirExists(`${this.#app.dist.cwdPath}/backend`))) await this.#build();
-
-    const buildVersion = `${platformVersion}-${buildNum}`;
-    const buildPath = `${buildRoot}/${buildVersion}`;
-    await mkdir(buildPath, { recursive: true });
-    await cp(`${this.#app.dist.cwdPath}/backend`, `${buildPath}/backend`, { recursive: true });
-
-    await cp(this.#app.dist.cwdPath, buildRoot, { recursive: true });
-    await rm(`${buildRoot}/frontend/.next`, { recursive: true, force: true });
-
-    const releaseRoot = this.#app.workspace.workspaceRoot;
-    await this.#tar(releaseRoot, `${releaseRoot}/releases/builds/${this.#app.name}-release.tar.gz`, buildRoot);
-    await this.#writeCsrZipIfPresent();
-    return { platformVersion };
-  }
-
-  async #writeCsrZipIfPresent(): Promise<void> {
-    if (!(await FileSys.dirExists(`${this.#app.dist.cwdPath}/csr`))) return;
-    await cp(`${this.#app.dist.cwdPath}/csr`, "./csr", { recursive: true });
-    await this.#app.workspace.spawn("zip", [
-      "-r",
-      `${this.#app.workspace.workspaceRoot}/releases/builds/${this.#app.name}-appBuild.zip`,
-      "./csr",
-    ]);
-    await rm("./csr", { recursive: true, force: true });
-  }
-
-  async #writeSourceArchive({ readme }: { readme: string }): Promise<void> {
-    const sourceRoot = `${this.#app.workspace.workspaceRoot}/releases/sources/${this.#app.name}`;
-    await this.#resetSourceRoot(sourceRoot);
-    await cp(this.#app.dist.cwdPath, `${sourceRoot}/apps/${this.#app.name}`, { recursive: true });
-
-    const libDeps = ["social", "shared", "platform", "util"];
-    await Promise.all(
-      libDeps.map((lib) =>
-        cp(`${this.#app.workspace.cwdPath}/libs/${lib}`, `${sourceRoot}/libs/${lib}`, { recursive: true }),
-      ),
-    );
-    await Promise.all(
-      [".next", "ios", "android", "public/libs"].map(async (path) => {
-        const targetPath = `${sourceRoot}/apps/${this.#app.name}/${path}`;
-        if (await FileSys.dirExists(targetPath)) await rm(targetPath, { recursive: true, force: true });
-      }),
-    );
-
-    const syncPaths = [".husky", ".gitignore", "package.json"];
-    await Promise.all(
-      syncPaths.map((path) =>
-        cp(`${this.#app.workspace.cwdPath}/${path}`, `${sourceRoot}/${path}`, { recursive: true }),
-      ),
-    );
-    await this.#writeSourceTsconfig(sourceRoot, libDeps);
-    await Bun.write(`${sourceRoot}/README.md`, readme);
-    const sourceCwd = this.#app.workspace.cwdPath;
-    await this.#tar(sourceCwd, `${sourceCwd}/releases/sources/${this.#app.name}-source.tar.gz`, sourceRoot);
-  }
-
-  async #tar(cwd: string, archivePath: string, sourceDir: string) {
-    // Relative to cwd so tar never sees a Windows drive letter ("C:\..."), which GNU tar reads as a remote "host:file".
-    const relativeArchivePath = path.relative(cwd, archivePath).split(path.sep).join("/");
-    await this.#app.workspace.spawn("tar", ["-zcf", relativeArchivePath, "-C", sourceDir, "./"], { cwd });
-  }
-
-  async #resetSourceRoot(sourceRoot: string): Promise<void> {
-    if (await FileSys.dirExists(sourceRoot))
-      for (let attempt = 0; attempt < 3; attempt++)
-        await rm(sourceRoot, { recursive: true, force: true }).catch(() => undefined);
-    await mkdir(sourceRoot, { recursive: true });
-  }
-
-  async #writeSourceTsconfig(sourceRoot: string, libDeps: string[]): Promise<void> {
-    const tsconfig = (await this.#app.workspace.readJson("tsconfig.json")) as {
-      compilerOptions: { paths: Record<string, string[]> };
-    };
-    const pathEntries: [string, string[]][] = [[`@${this.#app.name}/*`, [`apps/${this.#app.name}/*`]]];
-    for (const lib of libDeps) {
-      pathEntries.push([`@${lib}`, [`libs/${lib}/index.ts`]], [`@${lib}/*`, [`libs/${lib}/*`]]);
-    }
-    tsconfig.compilerOptions.paths = Object.fromEntries(pathEntries) as Record<string, string[]>;
-    await Bun.write(`${sourceRoot}/tsconfig.json`, JSON.stringify(tsconfig, null, 2));
-  }
-
-  static #envSetup = `  cat <<EOF >> .env
-  # ENV For Server => debug | debug.local | develop | develop.local | main | main.local
-  SERVER_ENV=debug.local
-  # Run Mode For Server => federation | batch | all
-  SERVER_MODE=federation
-  # ENV For Client => debug | debug.local | develop | develop.local | main | main.local
-  AKAN_PUBLIC_CLIENT_ENV=debug.local
-  ANALYZE=false
-  EOF
-`;
-
-  #confidentialReadme(): string {
-    return `# ${this.#app.name}
-  본 프로젝트의 소스코드 및 관련자료는 모두 비밀정보로 관리됩니다.
-
-  ## Get Started
-  Run the code below.
-  \`\`\`
-  bun install -g bun
-  bun i
-
-${ApplicationReleasePackager.#envSetup}
-  akn start-backend ${this.#app.name}
-  # or akn start-frontend ${this.#app.name}, etc
-  \`\`\`
-
-  ## Build
-  Run the code below.
-  \`\`\`
-  akn build-backend ${this.#app.name}
-  # or akn build-frontend ${this.#app.name}, etc
-  \`\`\`
-  `;
-  }
-
-  #publicReadme(): string {
-    return `# ${this.#app.name}
-  ## Get Started
-  Run the code below.
-  \`\`\`
-${ApplicationReleasePackager.#envSetup}
-  akan start ${this.#app.name}
-  \`\`\`
-
-  ## Build
-  Run the code below.
-  \`\`\`
-  akan build ${this.#app.name}
-  # or akn build-frontend ${this.#app.name}, etc
-  \`\`\`
-  `;
-  }
-}