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

package/commandDecorators/commandDecorators.test.ts

@@ -1,7 +1,7 @@
 import { afterEach, describe, expect, test } from "bun:test";
 import { AppExecutor, WorkspaceExecutor } from "../executors";
-import { App, getArgMetas, Lib, Module, Pkg, Sys, Workspace } from "./argMeta";
-import { getInternalArgumentValue } from "./command";
+import { App, type ArgMeta, type ArgsOption, getArgMetas, Lib, Module, Pkg, Sys, Workspace } from "./argMeta";
+import { getArgumentValue, getInternalArgumentValue, getOptionValue } from "./command";
 import { command } from "./commandBuilder";
 import {
   assertUniqueDependencies,
@@ -136,7 +136,7 @@ describe("command helper metadata", () => {
 
     const app = await getInternalArgumentValue({ key: "", idx: 0, type: "App" }, undefined, workspace);
 
-    expect(app).toBeInstanceOf(AppExecutor);
+    if (!(app instanceof AppExecutor)) throw new Error(`expected an AppExecutor, got ${app.constructor.name}`);
     expect(app.name).toBe("single-command-test-app");
     expect(app.workspace).toBe(workspace);
   });
@@ -223,3 +223,115 @@ describe("command helper dependency injection", () => {
     expect(descriptor?.writable).toBe(false);
   });
 });
+
+describe("enum arg choices", () => {
+  const optionMeta = (enumChoices: ArgsOption["enum"]): ArgMeta => ({
+    name: "format",
+    argsOption: { type: "string", enum: enumChoices },
+    key: "run",
+    idx: 0,
+    type: "Option",
+  });
+  const argumentMeta = (enumChoices: ArgsOption["enum"]): ArgMeta => ({
+    ...optionMeta(enumChoices),
+    name: "action",
+    type: "Argument",
+  });
+  const context = { values: {} };
+
+  test("passes a declared choice through", async () => {
+    expect(await getOptionValue(optionMeta(["text", "json"]), { format: "json" }, context)).toBe("json");
+  });
+
+  // Before this check `akan quality --format yaml` reached the script as "yaml" while the declaration
+  // claimed the parameter was "text" | "json".
+  test("rejects an undeclared value in commander's wording", async () => {
+    await expect(getOptionValue(optionMeta(["text", "json"]), { format: "yaml" }, context)).rejects.toThrow(
+      "option '--format' argument 'yaml' is invalid. Allowed choices are text, json.",
+    );
+  });
+
+  test("names a positional argument as an argument", async () => {
+    await expect(getArgumentValue(argumentMeta(["scan", "ssr"]), "sssr")).rejects.toThrow(
+      "argument 'action' argument 'sssr' is invalid. Allowed choices are scan, ssr.",
+    );
+  });
+
+  test("kebab-cases a camelCase option name the way the flag is spelled", async () => {
+    await expect(
+      getOptionValue({ ...optionMeta(["apk", "aab"]), name: "assembleType" }, { assembleType: "ipa" }, context),
+    ).rejects.toThrow("option '--assemble-type'");
+  });
+
+  test("compares a labelled choice by its value, not its label", async () => {
+    const labelled = optionMeta([{ label: "JSON output", value: "json" }]);
+    expect(await getOptionValue(labelled, { format: "json" }, context)).toBe("json");
+    await expect(getOptionValue(labelled, { format: "JSON output" }, context)).rejects.toThrow("is invalid");
+  });
+
+  // A DynamicEnum resolves against a context that is not populated yet, and the interactive select is its
+  // only consumer, so an explicit value passes through unchecked rather than being rejected wrongly.
+  test("leaves a dynamic choice list unchecked", async () => {
+    expect(
+      await getOptionValue(
+        optionMeta(() => ["text"]),
+        { format: "anything" },
+        context,
+      ),
+    ).toBe("anything");
+  });
+
+  test("an option with no enum is unaffected", async () => {
+    expect(await getOptionValue(optionMeta(undefined), { format: "whatever" }, context)).toBe("whatever");
+  });
+});
+
+describe("enum arg type inference", () => {
+  afterEach(() => {
+    CommandContainer.clear();
+  });
+
+  /**
+   * Compile-time only. Nothing here can fail at runtime: if `enum` stops narrowing, the parameter widens
+   * to the primitive and these calls stop typechecking, so the regression surfaces in `akan typecheck`
+   * rather than in fifteen `as "a" | "b"` casts creeping back into the command files.
+   */
+  const expectLiteral = <Expected>(_value: Expected) => undefined;
+
+  test("a static enum narrows the exec parameter to its declared choices", () => {
+    class InferenceRunner extends runner("inference") {}
+    class InferenceScript extends script("inference", [InferenceRunner]) {}
+
+    class InferenceCommand extends command("inference", [InferenceScript], ({ public: target }) => ({
+      run: target({ desc: "run" })
+        .arg("action", String, { enum: ["scan", "ssr"] })
+        .option("format", String, { enum: ["text", "json"], default: "text" })
+        .option("count", Number, { enum: [1, 2] })
+        .option("scope", String, { enum: ["all", "one"], nullable: true })
+        .option("label", String, { enum: [{ label: "JSON output", value: "json" }] })
+        .option("plain", String, { desc: "no choices declared" })
+        .option("dynamic", String, { enum: () => ["a", "b"] })
+        .exec(async (action, format, count, scope, label, plain, dynamic) => {
+          expectLiteral<"scan" | "ssr">(action);
+          expectLiteral<"text" | "json">(format);
+          expectLiteral<1 | 2>(count);
+          expectLiteral<"all" | "one" | null>(scope);
+          expectLiteral<"json">(label);
+          expectLiteral<string>(plain);
+          expectLiteral<string>(dynamic);
+        }),
+    })) {}
+
+    const [targetMeta] = getTargetMetas(InferenceCommand);
+    expect(targetMeta?.key).toBe("run");
+    expect(targetMeta?.args.map((arg) => ("name" in arg ? arg.name : arg.type))).toEqual([
+      "action",
+      "format",
+      "count",
+      "scope",
+      "label",
+      "plain",
+      "dynamic",
+    ]);
+  });
+});

package/commandDecorators/helpFormatter.ts

@@ -159,6 +159,7 @@ export const formatCommandHelp = (command: CommandCls, key: string) => {
     .map((arg) => {
       if (arg.type === "Workspace") return "";
       if (arg.type === "Module") return "[sys:module]";
+      if (arg.type === "Apps") return "[apps...]";
       if (arg.type === "Argument") {
         return `[${camelToKebabCase(arg.name)}]`;
       }
@@ -192,6 +193,9 @@ export const formatCommandHelp = (command: CommandCls, key: string) => {
       } else if (arg.type === "Module") {
         argName = "sys:module";
         argDesc = "Module in format: app-name:module-name or lib-name:module-name";
+      } else if (arg.type === "Apps") {
+        argName = "apps...";
+        argDesc = "App names, space- or comma-separated, or all. Omit to pick them interactively";
       } else {
         argName = arg.type.toLowerCase();
         argDesc = `${arg.type} name in this workspace`;

package/dependencyScanner.test.ts

@@ -0,0 +1,99 @@
+import { afterEach, describe, expect, test } from "bun:test";
+import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
+import os from "node:os";
+import path from "node:path";
+import { TypeScriptDependencyScanner } from "./dependencyScanner";
+import type { PackageJson } from "./types";
+
+const tempRoots: string[] = [];
+
+const makeTempRoot = async () => {
+  const root = await mkdtemp(path.join(os.tmpdir(), "akan-devkit-depscan-"));
+  tempRoots.push(root);
+  return root;
+};
+
+const write = async (root: string, relPath: string, content: string) => {
+  const filePath = path.join(root, relPath);
+  await mkdir(path.dirname(filePath), { recursive: true });
+  await writeFile(filePath, content);
+  return filePath;
+};
+
+const scannerFor = async (root: string, dependencies: Record<string, string> = {}) =>
+  new TypeScriptDependencyScanner(path.join(root, "pkgs/@akanjs/devkit"), {
+    workspaceRoot: root,
+    tsconfig: { compilerOptions: { target: "esnext" } },
+    rootPackageJson: { dependencies } as unknown as PackageJson,
+  });
+
+afterEach(async () => {
+  await Promise.all(tempRoots.splice(0).map((root) => rm(root, { recursive: true, force: true })));
+});
+
+describe("TypeScriptDependencyScanner — getPackageBuildDependencies", () => {
+  test("collects imports from ordinary source files", async () => {
+    const root = await makeTempRoot();
+    await write(root, "pkgs/@akanjs/devkit/linter.ts", `import chalk from "chalk";\nexport const x = chalk;\n`);
+    const scanner = await scannerFor(root, { chalk: "^5.0.0" });
+
+    const { npmDeps, missingDeps } = await scanner.getPackageBuildDependencies("@akanjs/devkit");
+
+    expect(npmDeps).toEqual(["chalk"]);
+    expect(missingDeps).toEqual([]);
+  });
+
+  test("reports an import that root package.json does not version", async () => {
+    const root = await makeTempRoot();
+    await write(root, "pkgs/@akanjs/devkit/linter.ts", `import clsx from "clsx";\nexport const x = clsx;\n`);
+    const scanner = await scannerFor(root);
+
+    expect((await scanner.getPackageBuildDependencies("@akanjs/devkit")).missingDeps).toEqual(["clsx"]);
+  });
+
+  test("skips __fixtures__, whose imports are lint violations rather than dependencies", async () => {
+    const root = await makeTempRoot();
+    await write(
+      root,
+      "pkgs/@akanjs/devkit/lint/__fixtures__/no-import-external-library/bad.tsx",
+      `import clsx from "clsx";\nimport { cnst } from "@libs/shared/client";\nexport const x = [clsx, cnst];\n`,
+    );
+    const scanner = await scannerFor(root);
+
+    const { npmDeps, npmDevDeps, missingDeps } = await scanner.getPackageBuildDependencies("@akanjs/devkit");
+
+    expect(missingDeps).toEqual([]);
+    expect(npmDeps).toEqual([]);
+    expect(npmDevDeps).toEqual([]);
+  });
+
+  test("skips a nested __fixtures__ directory at any depth", async () => {
+    const root = await makeTempRoot();
+    await write(root, "pkgs/@akanjs/devkit/__fixtures__/bad.ts", `import a from "pkg-a";\nexport const x = a;\n`);
+    await write(root, "pkgs/@akanjs/devkit/a/b/__fixtures__/c/bad.ts", `import b from "pkg-b";\nexport const x = b;\n`);
+    const scanner = await scannerFor(root);
+
+    expect((await scanner.getPackageBuildDependencies("@akanjs/devkit")).missingDeps).toEqual([]);
+  });
+
+  test("keeps a directory whose name merely contains the fixtures marker", async () => {
+    const root = await makeTempRoot();
+    await write(
+      root,
+      "pkgs/@akanjs/devkit/__fixtures__helper/keep.ts",
+      `import a from "pkg-a";\nexport const x = a;\n`,
+    );
+    const scanner = await scannerFor(root);
+
+    expect((await scanner.getPackageBuildDependencies("@akanjs/devkit")).missingDeps).toEqual(["pkg-a"]);
+  });
+
+  test("skips test files but still reports their non-test siblings", async () => {
+    const root = await makeTempRoot();
+    await write(root, "pkgs/@akanjs/devkit/linter.test.ts", `import a from "pkg-a";\nexport const x = a;\n`);
+    await write(root, "pkgs/@akanjs/devkit/linter.ts", `import b from "pkg-b";\nexport const x = b;\n`);
+    const scanner = await scannerFor(root);
+
+    expect((await scanner.getPackageBuildDependencies("@akanjs/devkit")).missingDeps).toEqual(["pkg-b"]);
+  });
+});

package/dependencyScanner.ts

@@ -7,6 +7,11 @@ import { FileSys } from "./fileSys";
 import type { PackageJson, TsConfigJson } from "./types";
 
 const testFileRegex = /\.(?:test|spec)\.[cm]?[tj]sx?$/;
+// `__fixtures__` holds deliberately invalid sample sources for the lint-rule suites; tsconfig `exclude` and
+// biome's `!` override already skip them, and their imports are violations rather than real dependencies.
+const skipDirs = ["node_modules", "dist", "build", ".git", ".next", "public", "ios", "android", "__fixtures__"];
+const isSkippedPath = (filePath: string) =>
+  skipDirs.some((dir) => filePath.includes(`/${dir}/`) || filePath.startsWith(`${dir}/`));
 const builtinModuleSet = new Set([...builtinModules, ...builtinModules.map((mod) => `node:${mod}`)]);
 const stripShebang = (source: string) => source.replace(/^#!.*(?:\r?\n|$)/, "");
 
@@ -17,10 +22,10 @@ export class TypeScriptDependencyScanner {
   #visitedFiles = new Set<string>();
   readonly #tsTranspiler = new Bun.Transpiler({ loader: "ts" });
   readonly #tsxTranspiler = new Bun.Transpiler({ loader: "tsx" });
-  private readonly directory: string;
-  private readonly rootPackageJson: PackageJson;
-  private readonly ig: ReturnType<typeof ignore>;
-  private readonly workspaceRoot: string;
+  readonly #directory: string;
+  readonly #rootPackageJson: PackageJson;
+  readonly #ig: ReturnType<typeof ignore>;
+  readonly #workspaceRoot: string;
 
   constructor(
     directory: string,
@@ -30,10 +35,10 @@ export class TypeScriptDependencyScanner {
       gitignorePatterns = [],
     }: { workspaceRoot: string; tsconfig: TsConfigJson; rootPackageJson: PackageJson; gitignorePatterns?: string[] },
   ) {
-    this.directory = directory;
-    this.rootPackageJson = rootPackageJson;
-    this.ig = ignore().add(gitignorePatterns);
-    this.workspaceRoot = workspaceRoot;
+    this.#directory = directory;
+    this.#rootPackageJson = rootPackageJson;
+    this.#ig = ignore().add(gitignorePatterns);
+    this.#workspaceRoot = workspaceRoot;
   }
 
   async getMonorepoDependencies(
@@ -41,7 +46,7 @@ export class TypeScriptDependencyScanner {
     { pkgs = [], libs = [] }: { pkgs?: string[]; libs?: string[] } = {},
   ): Promise<{ pkgDeps: string[]; libDeps: string[]; npmDeps: string[]; npmDevDeps: string[] }> {
     const npmSet = new Set(
-      Object.keys({ ...this.rootPackageJson.dependencies, ...this.rootPackageJson.devDependencies }),
+      Object.keys({ ...this.#rootPackageJson.dependencies, ...this.#rootPackageJson.devDependencies }),
     );
     const pkgPathSet = new Set(pkgs);
     const libPathSet = new Set(libs.map((lib) => `@libs/${lib}`));
@@ -68,11 +73,11 @@ export class TypeScriptDependencyScanner {
   ): Promise<{ npmDeps: string[]; npmDevDeps: string[]; missingDeps: string[] }> {
     const runtimeDeps = new Set<string>();
     const devDeps = new Set<string>();
-    const sourceFiles = await this.#findTypeScriptFiles(this.directory, {
+    const sourceFiles = await this.#findTypeScriptFiles(this.#directory, {
       excludeBuildFiles: true,
       excludeTestFiles: true,
     });
-    const cssFiles = await this.#findCssFiles(this.directory);
+    const cssFiles = await this.#findCssFiles(this.#directory);
 
     for (const filePath of sourceFiles) {
       const fileContent = await FileSys.readText(filePath);
@@ -86,7 +91,7 @@ export class TypeScriptDependencyScanner {
       this.#addNormalizedImports(runtimeDeps, this.#extractCssPluginImports(fileContent), projectName);
     }
 
-    const buildFilePath = path.join(this.directory, "build.ts");
+    const buildFilePath = path.join(this.#directory, "build.ts");
     if (await FileSys.fileExists(buildFilePath)) {
       const fileContent = await FileSys.readText(buildFilePath);
       const { imports, typeImports } = this.#extractImports(fileContent, buildFilePath);
@@ -95,7 +100,7 @@ export class TypeScriptDependencyScanner {
 
     for (const dep of runtimeDeps) devDeps.delete(dep);
 
-    const rootDeps = { ...this.rootPackageJson.dependencies, ...this.rootPackageJson.devDependencies };
+    const rootDeps = { ...this.#rootPackageJson.dependencies, ...this.#rootPackageJson.devDependencies };
     const missingDeps: string[] = [];
     for (const dep of [...runtimeDeps, ...devDeps]) {
       if (rootDeps[dep] || (await this.#hasWorkspacePackage(dep))) continue;
@@ -109,7 +114,7 @@ export class TypeScriptDependencyScanner {
   }
 
   async #hasWorkspacePackage(dep: string) {
-    const packageJsonPath = path.join(this.workspaceRoot, "pkgs", dep, "package.json");
+    const packageJsonPath = path.join(this.#workspaceRoot, "pkgs", dep, "package.json");
     if (!(await Bun.file(packageJsonPath).exists())) return false;
     try {
       const packageJson = await FileSys.readJson<PackageJson>(packageJsonPath);
@@ -156,9 +161,9 @@ export class TypeScriptDependencyScanner {
     this.#fileTypeDependencies.clear();
     this.#visitedFiles.clear();
 
-    const files = await this.#findTypeScriptFiles(this.directory);
+    const files = await this.#findTypeScriptFiles(this.#directory);
 
-    for (const file of files) await this.#analyzeFile(file, this.directory);
+    for (const file of files) await this.#analyzeFile(file, this.#directory);
 
     return this.#fileDependencies;
   }
@@ -171,17 +176,16 @@ export class TypeScriptDependencyScanner {
     }: { excludeBuildFiles?: boolean; excludeTestFiles?: boolean } = {},
   ): Promise<string[]> {
     const files: string[] = [];
-    const skipDirs = ["node_modules", "dist", "build", ".git", ".next", "public", "ios", "android"];
 
     const glob = new Bun.Glob("**/*.{ts,tsx}");
     for await (const filePath of glob.scan({ cwd: directory, onlyFiles: true })) {
-      if (skipDirs.some((dir) => filePath.includes(`/${dir}/`) || filePath.startsWith(`${dir}/`))) continue;
+      if (isSkippedPath(filePath)) continue;
       if (excludeBuildFiles && filePath === "build.ts") continue;
       if (excludeTestFiles && testFileRegex.test(filePath)) continue;
 
       const fullPath = path.join(directory, filePath);
-      const relativePath = path.relative(this.workspaceRoot, fullPath);
-      if (this.ig.ignores(relativePath)) continue;
+      const relativePath = path.relative(this.#workspaceRoot, fullPath);
+      if (this.#ig.ignores(relativePath)) continue;
 
       files.push(fullPath);
     }
@@ -190,14 +194,13 @@ export class TypeScriptDependencyScanner {
 
   async #findCssFiles(directory: string): Promise<string[]> {
     const files: string[] = [];
-    const skipDirs = ["node_modules", "dist", "build", ".git", ".next", "public", "ios", "android"];
     const glob = new Bun.Glob("**/*.css");
     for await (const filePath of glob.scan({ cwd: directory, onlyFiles: true })) {
-      if (skipDirs.some((dir) => filePath.includes(`/${dir}/`) || filePath.startsWith(`${dir}/`))) continue;
+      if (isSkippedPath(filePath)) continue;
 
       const fullPath = path.join(directory, filePath);
-      const relativePath = path.relative(this.workspaceRoot, fullPath);
-      if (this.ig.ignores(relativePath)) continue;
+      const relativePath = path.relative(this.#workspaceRoot, fullPath);
+      if (this.#ig.ignores(relativePath)) continue;
 
       files.push(fullPath);
     }

package/devkitUtils.test.ts

@@ -6,8 +6,6 @@ import { ApplicationBuildReporter } from "./applicationBuildReporter";
 import { resolveSignalTestPreloadPath } from "./applicationTestPreload";
 import { TypeScriptDependencyScanner } from "./dependencyScanner";
 import { AppExecutor, WorkspaceExecutor } from "./executors";
-import { extractDependencies } from "./extractDeps";
-import { getModelFileData } from "./getModelFileData";
 import type { PackageJson, TsConfigJson } from "./types";
 
 const tempRoots: string[] = [];
@@ -27,65 +25,6 @@ afterEach(async () => {
   await Promise.all(tempRoots.splice(0).map((root) => rm(root, { recursive: true, force: true })));
 });
 
-describe("extractDependencies", () => {
-  const packageJson: PackageJson = {
-    name: "fixture",
-    version: "1.0.0",
-    description: "fixture",
-    dependencies: {
-      react: "19.0.0",
-      "@scope/pkg": "1.0.0",
-      lodash: "4.0.0",
-    },
-    devDependencies: {
-      typescript: "6.0.0",
-      vite: "5.0.0",
-    },
-  };
-
-  test("extracts runtime package versions from imports and requires", () => {
-    const deps = extractDependencies(
-      [
-        {
-          path: "index.ts",
-          text: [
-            'import React from "react";',
-            'import { value } from "@scope/pkg/subpath";',
-            'import type { Type } from "typescript";',
-            'const lodash = require("lodash/fp");',
-            'const fs = require("node:fs");',
-            'const path = require("path");',
-            "",
-          ].join("\n"),
-        },
-        { path: "style.css", text: '@import "vite";' },
-      ],
-      packageJson,
-      ["vite"],
-    );
-
-    expect(deps).toEqual({
-      "@scope/pkg": "1.0.0",
-      lodash: "4.0.0",
-      react: "19.0.0",
-      typescript: "6.0.0",
-      vite: "5.0.0",
-    });
-  });
-
-  test("reports missing dependency sections and missing versions", () => {
-    expect(() =>
-      extractDependencies([{ path: "index.ts", text: 'import React from "react";' }], {
-        name: "broken",
-        version: "1.0.0",
-        description: "broken",
-      }),
-    ).toThrow("No dependencies found");
-
-    expect(() => extractDependencies([], packageJson, ["missing"])).toThrow("No version found for missing");
-  });
-});
-
 describe("resolveSignalTestPreloadPath", () => {
   test("resolves the preload file from an installed akanjs package", async () => {
     const root = await makeTempRoot();
@@ -252,49 +191,6 @@ describe("scan convention", () => {
   });
 });
 
-describe("getModelFileData", () => {
-  test("reads model files and derives imported local, scalar, and lib models", async () => {
-    const root = await makeTempRoot();
-    const cwd = process.cwd();
-    process.chdir(root);
-    try {
-      await write(
-        path.join(root, "apps/demo/lib/post/post.constant.ts"),
-        [
-          'import { cnst as shared } from "@libs/shared";',
-          'import { User } from "../user/user.constant";',
-          'import { Money } from "../_money/money.constant";',
-          "export const Post = {};",
-          "",
-        ].join("\n"),
-      );
-      await write(
-        path.join(root, "apps/demo/lib/post/Post.Unit.tsx"),
-        "export default function Unit() { return null; }\n",
-      );
-      await write(
-        path.join(root, "apps/demo/lib/post/Post.View.tsx"),
-        "export default function View() { return null; }\n",
-      );
-
-      const data = await getModelFileData("apps/demo", "post");
-      expect(data).toMatchObject({
-        moduleType: "app",
-        moduleName: "demo",
-        modelName: "post",
-        importModelNames: ["user"],
-        hasImportScalar: true,
-        importLibNames: ["shared"],
-      });
-      expect(data.constantFileStr).toContain("export const Post");
-      expect(data.unitFileStr).toContain("Unit");
-      expect(data.viewFileStr).toContain("View");
-    } finally {
-      process.chdir(cwd);
-    }
-  });
-});
-
 describe("ApplicationBuildReporter", () => {
   test("formats duration, phase lines, and nested errors", () => {
     expect(ApplicationBuildReporter.formatDuration(999)).toBe("999ms");