@akanjs/devkit 3.0.0-alpha.71 → 3.0.0-alpha.73
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/akanApp/BackendImportGraph.test.ts +120 -0
- package/akanApp/BackendImportGraph.ts +167 -0
- package/akanApp/akanApp.host.test.ts +16 -678
- package/akanApp/akanApp.host.ts +65 -562
- package/akanApp/devHostPolicy.test.ts +542 -0
- package/akanApp/devHostPolicy.ts +412 -0
- package/akanApp/index.ts +2 -0
- package/akanContext.ts +17 -3
- package/akanMcpContract.ts +25 -4
- package/artifact/routeSeedIndex.test.ts +1 -0
- package/capacitorApp.ts +10 -0
- package/cloud/globalConfig.ts +9 -2
- package/commandDecorators/command.ts +30 -6
- package/commandDecorators/commandBuilder.ts +20 -5
- package/commandDecorators/commandDecorators.test.ts +115 -3
- package/dependencyScanner.test.ts +99 -0
- package/dependencyScanner.ts +27 -24
- package/devkitUtils.test.ts +0 -104
- package/executors.test.ts +45 -0
- package/executors.ts +29 -5
- package/fileEditor.ts +19 -19
- package/frontendBuild/autoImportSync.test.ts +58 -0
- package/frontendBuild/autoImportSync.ts +4 -0
- package/frontendBuild/buildRouteClient.test.ts +19 -22
- package/frontendBuild/clientEntryDiscovery.ts +2 -2
- package/frontendBuild/fontOptimizer.ts +37 -18
- package/frontendBuild/index.ts +0 -1
- package/frontendBuild/styleContract.ts +14 -20
- package/frontendBuild/themeValidator.ts +22 -17
- package/incrementalBuilder/devWatchBatch.ts +6 -2
- package/incrementalBuilder/incrementalBuilder.proc.ts +6 -2
- package/index.ts +0 -5
- package/lint/__fixtures__/README.md +40 -0
- package/lint/__fixtures__/no-arbitrary-color/bad.tsx +3 -0
- package/lint/__fixtures__/no-arbitrary-color/good.tsx +4 -0
- package/lint/__fixtures__/no-async-component-in-ui/bad.tsx +4 -0
- package/lint/__fixtures__/no-async-component-in-ui/good.tsx +4 -0
- package/lint/__fixtures__/no-bang-comment-in-client/bad.tsx +4 -0
- package/lint/__fixtures__/no-bang-comment-in-client/fixture.json +1 -0
- package/lint/__fixtures__/no-bang-comment-in-client/good.tsx +3 -0
- package/lint/__fixtures__/no-daisyui-legacy-class/bad.tsx +7 -0
- package/lint/__fixtures__/no-daisyui-legacy-class/good.tsx +5 -0
- package/lint/__fixtures__/no-deep-internal-import/bad.tsx +3 -0
- package/lint/__fixtures__/no-deep-internal-import/fixture.json +1 -0
- package/lint/__fixtures__/no-deep-internal-import/good.tsx +3 -0
- package/lint/__fixtures__/no-deprecated-log-level/bad.tsx +4 -0
- package/lint/__fixtures__/no-deprecated-log-level/good.tsx +4 -0
- package/lint/__fixtures__/no-import-client-functions/bad.tsx +2 -0
- package/lint/__fixtures__/no-import-client-functions/good.tsx +4 -0
- package/lint/__fixtures__/no-import-client-in-server/bad.tsx +6 -0
- package/lint/__fixtures__/no-import-client-in-server/good.tsx +5 -0
- package/lint/__fixtures__/no-import-external-library/bad.tsx +4 -0
- package/lint/__fixtures__/no-import-external-library/good.tsx +5 -0
- package/lint/__fixtures__/no-import-server-in-client/bad.tsx +6 -0
- package/lint/__fixtures__/no-import-server-in-client/good.tsx +4 -0
- package/lint/__fixtures__/no-init-fetch-in-client/store-file/bad.ts +1 -0
- package/lint/__fixtures__/no-init-fetch-in-client/store-file/fixture.json +1 -0
- package/lint/__fixtures__/no-init-fetch-in-client/store-file/good.ts +1 -0
- package/lint/__fixtures__/no-init-fetch-in-client/use-client/bad.tsx +4 -0
- package/lint/__fixtures__/no-init-fetch-in-client/use-client/good.tsx +5 -0
- package/lint/__fixtures__/no-inline-color/bad.tsx +3 -0
- package/lint/__fixtures__/no-inline-color/good.tsx +3 -0
- package/lint/__fixtures__/no-interpolated-arbitrary-class/bad.tsx +3 -0
- package/lint/__fixtures__/no-interpolated-arbitrary-class/good.tsx +3 -0
- package/lint/__fixtures__/no-js-private-class-method/bad.tsx +3 -0
- package/lint/__fixtures__/no-js-private-class-method/good.tsx +3 -0
- package/lint/__fixtures__/no-model-type-in-util-zone/bad.tsx +3 -0
- package/lint/__fixtures__/no-model-type-in-util-zone/good.tsx +6 -0
- package/lint/__fixtures__/no-raw-palette-class/bad.tsx +6 -0
- package/lint/__fixtures__/no-raw-palette-class/good.tsx +8 -0
- package/lint/__fixtures__/no-redeclare-predefined-endpoint/bad.ts +10 -0
- package/lint/__fixtures__/no-redeclare-predefined-endpoint/fixture.json +1 -0
- package/lint/__fixtures__/no-redeclare-predefined-endpoint/good.ts +6 -0
- package/lint/__fixtures__/no-return-in-store-action/bad.tsx +2 -0
- package/lint/__fixtures__/no-return-in-store-action/good.tsx +6 -0
- package/lint/__fixtures__/no-throw-raw-error/bad.tsx +4 -0
- package/lint/__fixtures__/no-throw-raw-error/good.tsx +4 -0
- package/lint/__fixtures__/no-unpublished-form-setter/bad.tsx +3 -0
- package/lint/__fixtures__/no-unpublished-form-setter/good.tsx +5 -0
- package/lint/__fixtures__/no-use-client-in-server/bad.tsx +3 -0
- package/lint/__fixtures__/no-use-client-in-server/good.tsx +2 -0
- package/lint/__fixtures__/non-scalar-props-restricted/bad.tsx +5 -0
- package/lint/__fixtures__/non-scalar-props-restricted/good.tsx +4 -0
- package/lint/gritRules.test.ts +178 -0
- package/lint/no-arbitrary-color.grit +1 -1
- package/lint/no-bang-comment-in-client.grit +23 -10
- package/lint/no-daisyui-legacy-class.grit +2 -2
- package/lint/no-inline-color.grit +10 -8
- package/lint/no-interpolated-arbitrary-class.grit +3 -3
- package/lint/no-raw-palette-class.grit +3 -3
- package/lint/non-scalar-props-restricted.grit +16 -7
- package/linter.test.ts +80 -0
- package/linter.ts +82 -13
- package/package.json +3 -3
- package/prompter.ts +9 -4
- package/qualityScanner.test.ts +64 -0
- package/qualityScanner.ts +43 -3
- package/recipeScanner.ts +4 -1
- package/scanInfo.ts +3 -3
- package/ssrScanner.test.ts +301 -0
- package/transforms/barrelImportsPlugin.ts +1 -1
- package/transforms/transforms.test.ts +5 -5
- package/transforms/tsconfigPackageResolver.test.ts +230 -0
- package/tsconfig.json +5 -1
- package/typeChecker.ts +1 -1
- package/types.ts +1 -0
- package/ui/ScrollList.tsx +6 -8
- package/uploadRelease.ts +2 -2
- package/workflow/executor.test.ts +146 -0
- package/builder.ts +0 -164
- package/extractDeps.ts +0 -86
- package/frontendBuild/styleGuard.test.ts +0 -180
- package/frontendBuild/styleGuard.ts +0 -339
- package/getCredentials.ts +0 -17
- package/getModelFileData.ts +0 -62
- package/src/capacitorApp.ts +0 -282
- package/streamAi.ts +0 -45
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { afterEach, describe, expect, test } from "bun:test";
|
|
2
2
|
import { AppExecutor, WorkspaceExecutor } from "../executors";
|
|
3
|
-
import { App, getArgMetas, Lib, Module, Pkg, Sys, Workspace } from "./argMeta";
|
|
4
|
-
import { getInternalArgumentValue } from "./command";
|
|
3
|
+
import { App, type ArgMeta, type ArgsOption, getArgMetas, Lib, Module, Pkg, Sys, Workspace } from "./argMeta";
|
|
4
|
+
import { getArgumentValue, getInternalArgumentValue, getOptionValue } from "./command";
|
|
5
5
|
import { command } from "./commandBuilder";
|
|
6
6
|
import {
|
|
7
7
|
assertUniqueDependencies,
|
|
@@ -136,7 +136,7 @@ describe("command helper metadata", () => {
|
|
|
136
136
|
|
|
137
137
|
const app = await getInternalArgumentValue({ key: "", idx: 0, type: "App" }, undefined, workspace);
|
|
138
138
|
|
|
139
|
-
|
|
139
|
+
if (!(app instanceof AppExecutor)) throw new Error(`expected an AppExecutor, got ${app.constructor.name}`);
|
|
140
140
|
expect(app.name).toBe("single-command-test-app");
|
|
141
141
|
expect(app.workspace).toBe(workspace);
|
|
142
142
|
});
|
|
@@ -223,3 +223,115 @@ describe("command helper dependency injection", () => {
|
|
|
223
223
|
expect(descriptor?.writable).toBe(false);
|
|
224
224
|
});
|
|
225
225
|
});
|
|
226
|
+
|
|
227
|
+
describe("enum arg choices", () => {
|
|
228
|
+
const optionMeta = (enumChoices: ArgsOption["enum"]): ArgMeta => ({
|
|
229
|
+
name: "format",
|
|
230
|
+
argsOption: { type: "string", enum: enumChoices },
|
|
231
|
+
key: "run",
|
|
232
|
+
idx: 0,
|
|
233
|
+
type: "Option",
|
|
234
|
+
});
|
|
235
|
+
const argumentMeta = (enumChoices: ArgsOption["enum"]): ArgMeta => ({
|
|
236
|
+
...optionMeta(enumChoices),
|
|
237
|
+
name: "action",
|
|
238
|
+
type: "Argument",
|
|
239
|
+
});
|
|
240
|
+
const context = { values: {} };
|
|
241
|
+
|
|
242
|
+
test("passes a declared choice through", async () => {
|
|
243
|
+
expect(await getOptionValue(optionMeta(["text", "json"]), { format: "json" }, context)).toBe("json");
|
|
244
|
+
});
|
|
245
|
+
|
|
246
|
+
// Before this check `akan quality --format yaml` reached the script as "yaml" while the declaration
|
|
247
|
+
// claimed the parameter was "text" | "json".
|
|
248
|
+
test("rejects an undeclared value in commander's wording", async () => {
|
|
249
|
+
await expect(getOptionValue(optionMeta(["text", "json"]), { format: "yaml" }, context)).rejects.toThrow(
|
|
250
|
+
"option '--format' argument 'yaml' is invalid. Allowed choices are text, json.",
|
|
251
|
+
);
|
|
252
|
+
});
|
|
253
|
+
|
|
254
|
+
test("names a positional argument as an argument", async () => {
|
|
255
|
+
await expect(getArgumentValue(argumentMeta(["scan", "ssr"]), "sssr")).rejects.toThrow(
|
|
256
|
+
"argument 'action' argument 'sssr' is invalid. Allowed choices are scan, ssr.",
|
|
257
|
+
);
|
|
258
|
+
});
|
|
259
|
+
|
|
260
|
+
test("kebab-cases a camelCase option name the way the flag is spelled", async () => {
|
|
261
|
+
await expect(
|
|
262
|
+
getOptionValue({ ...optionMeta(["apk", "aab"]), name: "assembleType" }, { assembleType: "ipa" }, context),
|
|
263
|
+
).rejects.toThrow("option '--assemble-type'");
|
|
264
|
+
});
|
|
265
|
+
|
|
266
|
+
test("compares a labelled choice by its value, not its label", async () => {
|
|
267
|
+
const labelled = optionMeta([{ label: "JSON output", value: "json" }]);
|
|
268
|
+
expect(await getOptionValue(labelled, { format: "json" }, context)).toBe("json");
|
|
269
|
+
await expect(getOptionValue(labelled, { format: "JSON output" }, context)).rejects.toThrow("is invalid");
|
|
270
|
+
});
|
|
271
|
+
|
|
272
|
+
// A DynamicEnum resolves against a context that is not populated yet, and the interactive select is its
|
|
273
|
+
// only consumer, so an explicit value passes through unchecked rather than being rejected wrongly.
|
|
274
|
+
test("leaves a dynamic choice list unchecked", async () => {
|
|
275
|
+
expect(
|
|
276
|
+
await getOptionValue(
|
|
277
|
+
optionMeta(() => ["text"]),
|
|
278
|
+
{ format: "anything" },
|
|
279
|
+
context,
|
|
280
|
+
),
|
|
281
|
+
).toBe("anything");
|
|
282
|
+
});
|
|
283
|
+
|
|
284
|
+
test("an option with no enum is unaffected", async () => {
|
|
285
|
+
expect(await getOptionValue(optionMeta(undefined), { format: "whatever" }, context)).toBe("whatever");
|
|
286
|
+
});
|
|
287
|
+
});
|
|
288
|
+
|
|
289
|
+
describe("enum arg type inference", () => {
|
|
290
|
+
afterEach(() => {
|
|
291
|
+
CommandContainer.clear();
|
|
292
|
+
});
|
|
293
|
+
|
|
294
|
+
/**
|
|
295
|
+
* Compile-time only. Nothing here can fail at runtime: if `enum` stops narrowing, the parameter widens
|
|
296
|
+
* to the primitive and these calls stop typechecking, so the regression surfaces in `akan typecheck`
|
|
297
|
+
* rather than in fifteen `as "a" | "b"` casts creeping back into the command files.
|
|
298
|
+
*/
|
|
299
|
+
const expectLiteral = <Expected>(_value: Expected) => undefined;
|
|
300
|
+
|
|
301
|
+
test("a static enum narrows the exec parameter to its declared choices", () => {
|
|
302
|
+
class InferenceRunner extends runner("inference") {}
|
|
303
|
+
class InferenceScript extends script("inference", [InferenceRunner]) {}
|
|
304
|
+
|
|
305
|
+
class InferenceCommand extends command("inference", [InferenceScript], ({ public: target }) => ({
|
|
306
|
+
run: target({ desc: "run" })
|
|
307
|
+
.arg("action", String, { enum: ["scan", "ssr"] })
|
|
308
|
+
.option("format", String, { enum: ["text", "json"], default: "text" })
|
|
309
|
+
.option("count", Number, { enum: [1, 2] })
|
|
310
|
+
.option("scope", String, { enum: ["all", "one"], nullable: true })
|
|
311
|
+
.option("label", String, { enum: [{ label: "JSON output", value: "json" }] })
|
|
312
|
+
.option("plain", String, { desc: "no choices declared" })
|
|
313
|
+
.option("dynamic", String, { enum: () => ["a", "b"] })
|
|
314
|
+
.exec(async (action, format, count, scope, label, plain, dynamic) => {
|
|
315
|
+
expectLiteral<"scan" | "ssr">(action);
|
|
316
|
+
expectLiteral<"text" | "json">(format);
|
|
317
|
+
expectLiteral<1 | 2>(count);
|
|
318
|
+
expectLiteral<"all" | "one" | null>(scope);
|
|
319
|
+
expectLiteral<"json">(label);
|
|
320
|
+
expectLiteral<string>(plain);
|
|
321
|
+
expectLiteral<string>(dynamic);
|
|
322
|
+
}),
|
|
323
|
+
})) {}
|
|
324
|
+
|
|
325
|
+
const [targetMeta] = getTargetMetas(InferenceCommand);
|
|
326
|
+
expect(targetMeta?.key).toBe("run");
|
|
327
|
+
expect(targetMeta?.args.map((arg) => ("name" in arg ? arg.name : arg.type))).toEqual([
|
|
328
|
+
"action",
|
|
329
|
+
"format",
|
|
330
|
+
"count",
|
|
331
|
+
"scope",
|
|
332
|
+
"label",
|
|
333
|
+
"plain",
|
|
334
|
+
"dynamic",
|
|
335
|
+
]);
|
|
336
|
+
});
|
|
337
|
+
});
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { afterEach, describe, expect, test } from "bun:test";
|
|
2
|
+
import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
|
|
3
|
+
import os from "node:os";
|
|
4
|
+
import path from "node:path";
|
|
5
|
+
import { TypeScriptDependencyScanner } from "./dependencyScanner";
|
|
6
|
+
import type { PackageJson } from "./types";
|
|
7
|
+
|
|
8
|
+
const tempRoots: string[] = [];
|
|
9
|
+
|
|
10
|
+
const makeTempRoot = async () => {
|
|
11
|
+
const root = await mkdtemp(path.join(os.tmpdir(), "akan-devkit-depscan-"));
|
|
12
|
+
tempRoots.push(root);
|
|
13
|
+
return root;
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
const write = async (root: string, relPath: string, content: string) => {
|
|
17
|
+
const filePath = path.join(root, relPath);
|
|
18
|
+
await mkdir(path.dirname(filePath), { recursive: true });
|
|
19
|
+
await writeFile(filePath, content);
|
|
20
|
+
return filePath;
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
const scannerFor = async (root: string, dependencies: Record<string, string> = {}) =>
|
|
24
|
+
new TypeScriptDependencyScanner(path.join(root, "pkgs/@akanjs/devkit"), {
|
|
25
|
+
workspaceRoot: root,
|
|
26
|
+
tsconfig: { compilerOptions: { target: "esnext" } },
|
|
27
|
+
rootPackageJson: { dependencies } as unknown as PackageJson,
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
afterEach(async () => {
|
|
31
|
+
await Promise.all(tempRoots.splice(0).map((root) => rm(root, { recursive: true, force: true })));
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
describe("TypeScriptDependencyScanner — getPackageBuildDependencies", () => {
|
|
35
|
+
test("collects imports from ordinary source files", async () => {
|
|
36
|
+
const root = await makeTempRoot();
|
|
37
|
+
await write(root, "pkgs/@akanjs/devkit/linter.ts", `import chalk from "chalk";\nexport const x = chalk;\n`);
|
|
38
|
+
const scanner = await scannerFor(root, { chalk: "^5.0.0" });
|
|
39
|
+
|
|
40
|
+
const { npmDeps, missingDeps } = await scanner.getPackageBuildDependencies("@akanjs/devkit");
|
|
41
|
+
|
|
42
|
+
expect(npmDeps).toEqual(["chalk"]);
|
|
43
|
+
expect(missingDeps).toEqual([]);
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
test("reports an import that root package.json does not version", async () => {
|
|
47
|
+
const root = await makeTempRoot();
|
|
48
|
+
await write(root, "pkgs/@akanjs/devkit/linter.ts", `import clsx from "clsx";\nexport const x = clsx;\n`);
|
|
49
|
+
const scanner = await scannerFor(root);
|
|
50
|
+
|
|
51
|
+
expect((await scanner.getPackageBuildDependencies("@akanjs/devkit")).missingDeps).toEqual(["clsx"]);
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
test("skips __fixtures__, whose imports are lint violations rather than dependencies", async () => {
|
|
55
|
+
const root = await makeTempRoot();
|
|
56
|
+
await write(
|
|
57
|
+
root,
|
|
58
|
+
"pkgs/@akanjs/devkit/lint/__fixtures__/no-import-external-library/bad.tsx",
|
|
59
|
+
`import clsx from "clsx";\nimport { cnst } from "@libs/shared/client";\nexport const x = [clsx, cnst];\n`,
|
|
60
|
+
);
|
|
61
|
+
const scanner = await scannerFor(root);
|
|
62
|
+
|
|
63
|
+
const { npmDeps, npmDevDeps, missingDeps } = await scanner.getPackageBuildDependencies("@akanjs/devkit");
|
|
64
|
+
|
|
65
|
+
expect(missingDeps).toEqual([]);
|
|
66
|
+
expect(npmDeps).toEqual([]);
|
|
67
|
+
expect(npmDevDeps).toEqual([]);
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
test("skips a nested __fixtures__ directory at any depth", async () => {
|
|
71
|
+
const root = await makeTempRoot();
|
|
72
|
+
await write(root, "pkgs/@akanjs/devkit/__fixtures__/bad.ts", `import a from "pkg-a";\nexport const x = a;\n`);
|
|
73
|
+
await write(root, "pkgs/@akanjs/devkit/a/b/__fixtures__/c/bad.ts", `import b from "pkg-b";\nexport const x = b;\n`);
|
|
74
|
+
const scanner = await scannerFor(root);
|
|
75
|
+
|
|
76
|
+
expect((await scanner.getPackageBuildDependencies("@akanjs/devkit")).missingDeps).toEqual([]);
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
test("keeps a directory whose name merely contains the fixtures marker", async () => {
|
|
80
|
+
const root = await makeTempRoot();
|
|
81
|
+
await write(
|
|
82
|
+
root,
|
|
83
|
+
"pkgs/@akanjs/devkit/__fixtures__helper/keep.ts",
|
|
84
|
+
`import a from "pkg-a";\nexport const x = a;\n`,
|
|
85
|
+
);
|
|
86
|
+
const scanner = await scannerFor(root);
|
|
87
|
+
|
|
88
|
+
expect((await scanner.getPackageBuildDependencies("@akanjs/devkit")).missingDeps).toEqual(["pkg-a"]);
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
test("skips test files but still reports their non-test siblings", async () => {
|
|
92
|
+
const root = await makeTempRoot();
|
|
93
|
+
await write(root, "pkgs/@akanjs/devkit/linter.test.ts", `import a from "pkg-a";\nexport const x = a;\n`);
|
|
94
|
+
await write(root, "pkgs/@akanjs/devkit/linter.ts", `import b from "pkg-b";\nexport const x = b;\n`);
|
|
95
|
+
const scanner = await scannerFor(root);
|
|
96
|
+
|
|
97
|
+
expect((await scanner.getPackageBuildDependencies("@akanjs/devkit")).missingDeps).toEqual(["pkg-b"]);
|
|
98
|
+
});
|
|
99
|
+
});
|
package/dependencyScanner.ts
CHANGED
|
@@ -7,6 +7,11 @@ import { FileSys } from "./fileSys";
|
|
|
7
7
|
import type { PackageJson, TsConfigJson } from "./types";
|
|
8
8
|
|
|
9
9
|
const testFileRegex = /\.(?:test|spec)\.[cm]?[tj]sx?$/;
|
|
10
|
+
// `__fixtures__` holds deliberately invalid sample sources for the lint-rule suites; tsconfig `exclude` and
|
|
11
|
+
// biome's `!` override already skip them, and their imports are violations rather than real dependencies.
|
|
12
|
+
const skipDirs = ["node_modules", "dist", "build", ".git", ".next", "public", "ios", "android", "__fixtures__"];
|
|
13
|
+
const isSkippedPath = (filePath: string) =>
|
|
14
|
+
skipDirs.some((dir) => filePath.includes(`/${dir}/`) || filePath.startsWith(`${dir}/`));
|
|
10
15
|
const builtinModuleSet = new Set([...builtinModules, ...builtinModules.map((mod) => `node:${mod}`)]);
|
|
11
16
|
const stripShebang = (source: string) => source.replace(/^#!.*(?:\r?\n|$)/, "");
|
|
12
17
|
|
|
@@ -17,10 +22,10 @@ export class TypeScriptDependencyScanner {
|
|
|
17
22
|
#visitedFiles = new Set<string>();
|
|
18
23
|
readonly #tsTranspiler = new Bun.Transpiler({ loader: "ts" });
|
|
19
24
|
readonly #tsxTranspiler = new Bun.Transpiler({ loader: "tsx" });
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
25
|
+
readonly #directory: string;
|
|
26
|
+
readonly #rootPackageJson: PackageJson;
|
|
27
|
+
readonly #ig: ReturnType<typeof ignore>;
|
|
28
|
+
readonly #workspaceRoot: string;
|
|
24
29
|
|
|
25
30
|
constructor(
|
|
26
31
|
directory: string,
|
|
@@ -30,10 +35,10 @@ export class TypeScriptDependencyScanner {
|
|
|
30
35
|
gitignorePatterns = [],
|
|
31
36
|
}: { workspaceRoot: string; tsconfig: TsConfigJson; rootPackageJson: PackageJson; gitignorePatterns?: string[] },
|
|
32
37
|
) {
|
|
33
|
-
this
|
|
34
|
-
this
|
|
35
|
-
this
|
|
36
|
-
this
|
|
38
|
+
this.#directory = directory;
|
|
39
|
+
this.#rootPackageJson = rootPackageJson;
|
|
40
|
+
this.#ig = ignore().add(gitignorePatterns);
|
|
41
|
+
this.#workspaceRoot = workspaceRoot;
|
|
37
42
|
}
|
|
38
43
|
|
|
39
44
|
async getMonorepoDependencies(
|
|
@@ -41,7 +46,7 @@ export class TypeScriptDependencyScanner {
|
|
|
41
46
|
{ pkgs = [], libs = [] }: { pkgs?: string[]; libs?: string[] } = {},
|
|
42
47
|
): Promise<{ pkgDeps: string[]; libDeps: string[]; npmDeps: string[]; npmDevDeps: string[] }> {
|
|
43
48
|
const npmSet = new Set(
|
|
44
|
-
Object.keys({ ...this
|
|
49
|
+
Object.keys({ ...this.#rootPackageJson.dependencies, ...this.#rootPackageJson.devDependencies }),
|
|
45
50
|
);
|
|
46
51
|
const pkgPathSet = new Set(pkgs);
|
|
47
52
|
const libPathSet = new Set(libs.map((lib) => `@libs/${lib}`));
|
|
@@ -68,11 +73,11 @@ export class TypeScriptDependencyScanner {
|
|
|
68
73
|
): Promise<{ npmDeps: string[]; npmDevDeps: string[]; missingDeps: string[] }> {
|
|
69
74
|
const runtimeDeps = new Set<string>();
|
|
70
75
|
const devDeps = new Set<string>();
|
|
71
|
-
const sourceFiles = await this.#findTypeScriptFiles(this
|
|
76
|
+
const sourceFiles = await this.#findTypeScriptFiles(this.#directory, {
|
|
72
77
|
excludeBuildFiles: true,
|
|
73
78
|
excludeTestFiles: true,
|
|
74
79
|
});
|
|
75
|
-
const cssFiles = await this.#findCssFiles(this
|
|
80
|
+
const cssFiles = await this.#findCssFiles(this.#directory);
|
|
76
81
|
|
|
77
82
|
for (const filePath of sourceFiles) {
|
|
78
83
|
const fileContent = await FileSys.readText(filePath);
|
|
@@ -86,7 +91,7 @@ export class TypeScriptDependencyScanner {
|
|
|
86
91
|
this.#addNormalizedImports(runtimeDeps, this.#extractCssPluginImports(fileContent), projectName);
|
|
87
92
|
}
|
|
88
93
|
|
|
89
|
-
const buildFilePath = path.join(this
|
|
94
|
+
const buildFilePath = path.join(this.#directory, "build.ts");
|
|
90
95
|
if (await FileSys.fileExists(buildFilePath)) {
|
|
91
96
|
const fileContent = await FileSys.readText(buildFilePath);
|
|
92
97
|
const { imports, typeImports } = this.#extractImports(fileContent, buildFilePath);
|
|
@@ -95,7 +100,7 @@ export class TypeScriptDependencyScanner {
|
|
|
95
100
|
|
|
96
101
|
for (const dep of runtimeDeps) devDeps.delete(dep);
|
|
97
102
|
|
|
98
|
-
const rootDeps = { ...this
|
|
103
|
+
const rootDeps = { ...this.#rootPackageJson.dependencies, ...this.#rootPackageJson.devDependencies };
|
|
99
104
|
const missingDeps: string[] = [];
|
|
100
105
|
for (const dep of [...runtimeDeps, ...devDeps]) {
|
|
101
106
|
if (rootDeps[dep] || (await this.#hasWorkspacePackage(dep))) continue;
|
|
@@ -109,7 +114,7 @@ export class TypeScriptDependencyScanner {
|
|
|
109
114
|
}
|
|
110
115
|
|
|
111
116
|
async #hasWorkspacePackage(dep: string) {
|
|
112
|
-
const packageJsonPath = path.join(this
|
|
117
|
+
const packageJsonPath = path.join(this.#workspaceRoot, "pkgs", dep, "package.json");
|
|
113
118
|
if (!(await Bun.file(packageJsonPath).exists())) return false;
|
|
114
119
|
try {
|
|
115
120
|
const packageJson = await FileSys.readJson<PackageJson>(packageJsonPath);
|
|
@@ -156,9 +161,9 @@ export class TypeScriptDependencyScanner {
|
|
|
156
161
|
this.#fileTypeDependencies.clear();
|
|
157
162
|
this.#visitedFiles.clear();
|
|
158
163
|
|
|
159
|
-
const files = await this.#findTypeScriptFiles(this
|
|
164
|
+
const files = await this.#findTypeScriptFiles(this.#directory);
|
|
160
165
|
|
|
161
|
-
for (const file of files) await this.#analyzeFile(file, this
|
|
166
|
+
for (const file of files) await this.#analyzeFile(file, this.#directory);
|
|
162
167
|
|
|
163
168
|
return this.#fileDependencies;
|
|
164
169
|
}
|
|
@@ -171,17 +176,16 @@ export class TypeScriptDependencyScanner {
|
|
|
171
176
|
}: { excludeBuildFiles?: boolean; excludeTestFiles?: boolean } = {},
|
|
172
177
|
): Promise<string[]> {
|
|
173
178
|
const files: string[] = [];
|
|
174
|
-
const skipDirs = ["node_modules", "dist", "build", ".git", ".next", "public", "ios", "android"];
|
|
175
179
|
|
|
176
180
|
const glob = new Bun.Glob("**/*.{ts,tsx}");
|
|
177
181
|
for await (const filePath of glob.scan({ cwd: directory, onlyFiles: true })) {
|
|
178
|
-
if (
|
|
182
|
+
if (isSkippedPath(filePath)) continue;
|
|
179
183
|
if (excludeBuildFiles && filePath === "build.ts") continue;
|
|
180
184
|
if (excludeTestFiles && testFileRegex.test(filePath)) continue;
|
|
181
185
|
|
|
182
186
|
const fullPath = path.join(directory, filePath);
|
|
183
|
-
const relativePath = path.relative(this
|
|
184
|
-
if (this
|
|
187
|
+
const relativePath = path.relative(this.#workspaceRoot, fullPath);
|
|
188
|
+
if (this.#ig.ignores(relativePath)) continue;
|
|
185
189
|
|
|
186
190
|
files.push(fullPath);
|
|
187
191
|
}
|
|
@@ -190,14 +194,13 @@ export class TypeScriptDependencyScanner {
|
|
|
190
194
|
|
|
191
195
|
async #findCssFiles(directory: string): Promise<string[]> {
|
|
192
196
|
const files: string[] = [];
|
|
193
|
-
const skipDirs = ["node_modules", "dist", "build", ".git", ".next", "public", "ios", "android"];
|
|
194
197
|
const glob = new Bun.Glob("**/*.css");
|
|
195
198
|
for await (const filePath of glob.scan({ cwd: directory, onlyFiles: true })) {
|
|
196
|
-
if (
|
|
199
|
+
if (isSkippedPath(filePath)) continue;
|
|
197
200
|
|
|
198
201
|
const fullPath = path.join(directory, filePath);
|
|
199
|
-
const relativePath = path.relative(this
|
|
200
|
-
if (this
|
|
202
|
+
const relativePath = path.relative(this.#workspaceRoot, fullPath);
|
|
203
|
+
if (this.#ig.ignores(relativePath)) continue;
|
|
201
204
|
|
|
202
205
|
files.push(fullPath);
|
|
203
206
|
}
|
package/devkitUtils.test.ts
CHANGED
|
@@ -6,8 +6,6 @@ import { ApplicationBuildReporter } from "./applicationBuildReporter";
|
|
|
6
6
|
import { resolveSignalTestPreloadPath } from "./applicationTestPreload";
|
|
7
7
|
import { TypeScriptDependencyScanner } from "./dependencyScanner";
|
|
8
8
|
import { AppExecutor, WorkspaceExecutor } from "./executors";
|
|
9
|
-
import { extractDependencies } from "./extractDeps";
|
|
10
|
-
import { getModelFileData } from "./getModelFileData";
|
|
11
9
|
import type { PackageJson, TsConfigJson } from "./types";
|
|
12
10
|
|
|
13
11
|
const tempRoots: string[] = [];
|
|
@@ -27,65 +25,6 @@ afterEach(async () => {
|
|
|
27
25
|
await Promise.all(tempRoots.splice(0).map((root) => rm(root, { recursive: true, force: true })));
|
|
28
26
|
});
|
|
29
27
|
|
|
30
|
-
describe("extractDependencies", () => {
|
|
31
|
-
const packageJson: PackageJson = {
|
|
32
|
-
name: "fixture",
|
|
33
|
-
version: "1.0.0",
|
|
34
|
-
description: "fixture",
|
|
35
|
-
dependencies: {
|
|
36
|
-
react: "19.0.0",
|
|
37
|
-
"@scope/pkg": "1.0.0",
|
|
38
|
-
lodash: "4.0.0",
|
|
39
|
-
},
|
|
40
|
-
devDependencies: {
|
|
41
|
-
typescript: "6.0.0",
|
|
42
|
-
vite: "5.0.0",
|
|
43
|
-
},
|
|
44
|
-
};
|
|
45
|
-
|
|
46
|
-
test("extracts runtime package versions from imports and requires", () => {
|
|
47
|
-
const deps = extractDependencies(
|
|
48
|
-
[
|
|
49
|
-
{
|
|
50
|
-
path: "index.ts",
|
|
51
|
-
text: [
|
|
52
|
-
'import React from "react";',
|
|
53
|
-
'import { value } from "@scope/pkg/subpath";',
|
|
54
|
-
'import type { Type } from "typescript";',
|
|
55
|
-
'const lodash = require("lodash/fp");',
|
|
56
|
-
'const fs = require("node:fs");',
|
|
57
|
-
'const path = require("path");',
|
|
58
|
-
"",
|
|
59
|
-
].join("\n"),
|
|
60
|
-
},
|
|
61
|
-
{ path: "style.css", text: '@import "vite";' },
|
|
62
|
-
],
|
|
63
|
-
packageJson,
|
|
64
|
-
["vite"],
|
|
65
|
-
);
|
|
66
|
-
|
|
67
|
-
expect(deps).toEqual({
|
|
68
|
-
"@scope/pkg": "1.0.0",
|
|
69
|
-
lodash: "4.0.0",
|
|
70
|
-
react: "19.0.0",
|
|
71
|
-
typescript: "6.0.0",
|
|
72
|
-
vite: "5.0.0",
|
|
73
|
-
});
|
|
74
|
-
});
|
|
75
|
-
|
|
76
|
-
test("reports missing dependency sections and missing versions", () => {
|
|
77
|
-
expect(() =>
|
|
78
|
-
extractDependencies([{ path: "index.ts", text: 'import React from "react";' }], {
|
|
79
|
-
name: "broken",
|
|
80
|
-
version: "1.0.0",
|
|
81
|
-
description: "broken",
|
|
82
|
-
}),
|
|
83
|
-
).toThrow("No dependencies found");
|
|
84
|
-
|
|
85
|
-
expect(() => extractDependencies([], packageJson, ["missing"])).toThrow("No version found for missing");
|
|
86
|
-
});
|
|
87
|
-
});
|
|
88
|
-
|
|
89
28
|
describe("resolveSignalTestPreloadPath", () => {
|
|
90
29
|
test("resolves the preload file from an installed akanjs package", async () => {
|
|
91
30
|
const root = await makeTempRoot();
|
|
@@ -252,49 +191,6 @@ describe("scan convention", () => {
|
|
|
252
191
|
});
|
|
253
192
|
});
|
|
254
193
|
|
|
255
|
-
describe("getModelFileData", () => {
|
|
256
|
-
test("reads model files and derives imported local, scalar, and lib models", async () => {
|
|
257
|
-
const root = await makeTempRoot();
|
|
258
|
-
const cwd = process.cwd();
|
|
259
|
-
process.chdir(root);
|
|
260
|
-
try {
|
|
261
|
-
await write(
|
|
262
|
-
path.join(root, "apps/demo/lib/post/post.constant.ts"),
|
|
263
|
-
[
|
|
264
|
-
'import { cnst as shared } from "@libs/shared";',
|
|
265
|
-
'import { User } from "../user/user.constant";',
|
|
266
|
-
'import { Money } from "../_money/money.constant";',
|
|
267
|
-
"export const Post = {};",
|
|
268
|
-
"",
|
|
269
|
-
].join("\n"),
|
|
270
|
-
);
|
|
271
|
-
await write(
|
|
272
|
-
path.join(root, "apps/demo/lib/post/Post.Unit.tsx"),
|
|
273
|
-
"export default function Unit() { return null; }\n",
|
|
274
|
-
);
|
|
275
|
-
await write(
|
|
276
|
-
path.join(root, "apps/demo/lib/post/Post.View.tsx"),
|
|
277
|
-
"export default function View() { return null; }\n",
|
|
278
|
-
);
|
|
279
|
-
|
|
280
|
-
const data = await getModelFileData("apps/demo", "post");
|
|
281
|
-
expect(data).toMatchObject({
|
|
282
|
-
moduleType: "app",
|
|
283
|
-
moduleName: "demo",
|
|
284
|
-
modelName: "post",
|
|
285
|
-
importModelNames: ["user"],
|
|
286
|
-
hasImportScalar: true,
|
|
287
|
-
importLibNames: ["shared"],
|
|
288
|
-
});
|
|
289
|
-
expect(data.constantFileStr).toContain("export const Post");
|
|
290
|
-
expect(data.unitFileStr).toContain("Unit");
|
|
291
|
-
expect(data.viewFileStr).toContain("View");
|
|
292
|
-
} finally {
|
|
293
|
-
process.chdir(cwd);
|
|
294
|
-
}
|
|
295
|
-
});
|
|
296
|
-
});
|
|
297
|
-
|
|
298
194
|
describe("ApplicationBuildReporter", () => {
|
|
299
195
|
test("formats duration, phase lines, and nested errors", () => {
|
|
300
196
|
expect(ApplicationBuildReporter.formatDuration(999)).toBe("999ms");
|
package/executors.test.ts
CHANGED
|
@@ -127,6 +127,49 @@ describe("Executor filesystem helpers", () => {
|
|
|
127
127
|
expect(await readFile(path.join(root, "local/docker-compose.yaml"), "utf8")).toBe("custom");
|
|
128
128
|
});
|
|
129
129
|
|
|
130
|
+
test("hands every scaffolded TypeScript file to the formatter, and nothing else", async () => {
|
|
131
|
+
// A template emits identifiers it cannot sort — `import { fetch, Task, usePage }` is right for a model
|
|
132
|
+
// named Task and wrong for Zoo — and unsorted imports fail `biome check`. So the scaffold is formatted
|
|
133
|
+
// on the way out, or it is red for most model names whatever the template says.
|
|
134
|
+
const root = await makeTempRoot();
|
|
135
|
+
const exec = new Executor("fixture", root);
|
|
136
|
+
const formatted: string[] = [];
|
|
137
|
+
exec.getLinter = () =>
|
|
138
|
+
({
|
|
139
|
+
fixFiles: async (filePaths: string[]) => {
|
|
140
|
+
formatted.push(...filePaths);
|
|
141
|
+
return { fixed: [] };
|
|
142
|
+
},
|
|
143
|
+
}) as unknown as ReturnType<Executor["getLinter"]>;
|
|
144
|
+
|
|
145
|
+
await exec.applyTemplate({
|
|
146
|
+
basePath: "apps/demo/page/task",
|
|
147
|
+
template: "crudSinglePage",
|
|
148
|
+
dict: { model: "task", appName: "demo" },
|
|
149
|
+
});
|
|
150
|
+
|
|
151
|
+
expect(formatted).toEqual([path.join(root, "apps/demo/page/task/_index.tsx")]);
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
test("a formatter that cannot run does not fail the scaffold", async () => {
|
|
155
|
+
// `create-akan-workspace` scaffolds before `bun install`, so there is no local Biome binary and often
|
|
156
|
+
// no config above the target. An unformatted file is a lint fix; a failed scaffold is not.
|
|
157
|
+
const root = await makeTempRoot();
|
|
158
|
+
const exec = new Executor("fixture", root);
|
|
159
|
+
exec.getLinter = () => {
|
|
160
|
+
throw new Error("biome.json not found");
|
|
161
|
+
};
|
|
162
|
+
|
|
163
|
+
const created = await exec.applyTemplate({
|
|
164
|
+
basePath: "apps/demo/page/task",
|
|
165
|
+
template: "crudSinglePage",
|
|
166
|
+
dict: { model: "task", appName: "demo" },
|
|
167
|
+
});
|
|
168
|
+
|
|
169
|
+
expect(created).toHaveLength(1);
|
|
170
|
+
expect(await readFile(path.join(root, "apps/demo/page/task/_index.tsx"), "utf8")).toContain("Task.Zone.Card");
|
|
171
|
+
});
|
|
172
|
+
|
|
130
173
|
test("applies hidden files and directories from CLI templates", async () => {
|
|
131
174
|
const root = await makeTempRoot();
|
|
132
175
|
const exec = new Executor("fixture", root);
|
|
@@ -203,6 +246,7 @@ describe("Workspace and app executor environment contracts", () => {
|
|
|
203
246
|
serveDomain: "example.com",
|
|
204
247
|
env: "local",
|
|
205
248
|
portOffset: 10,
|
|
249
|
+
workspaceId: undefined,
|
|
206
250
|
});
|
|
207
251
|
|
|
208
252
|
delete process.env.AKAN_PUBLIC_REPO_NAME;
|
|
@@ -233,6 +277,7 @@ describe("Workspace and app executor environment contracts", () => {
|
|
|
233
277
|
serveDomain: "file.example.com",
|
|
234
278
|
env: "develop",
|
|
235
279
|
portOffset: 7,
|
|
280
|
+
workspaceId: undefined,
|
|
236
281
|
});
|
|
237
282
|
});
|
|
238
283
|
|
package/executors.ts
CHANGED
|
@@ -690,7 +690,30 @@ export class Executor {
|
|
|
690
690
|
Object.entries(options.dict ?? {}).map(([key, value]) => [capitalize(key), capitalize(value)]),
|
|
691
691
|
),
|
|
692
692
|
};
|
|
693
|
-
|
|
693
|
+
const fileContents = await this._applyTemplate({ ...options, dict });
|
|
694
|
+
await this.#formatAppliedTemplate(fileContents);
|
|
695
|
+
return fileContents;
|
|
696
|
+
}
|
|
697
|
+
|
|
698
|
+
/**
|
|
699
|
+
* A template emits identifiers it cannot sort. `import { fetch, Task, usePage }` is correctly ordered for
|
|
700
|
+
* a model named Task and wrong for one named Zoo, and `organizeImports` fails `biome check` — so a
|
|
701
|
+
* scaffold that is not formatted on the way out is red for most model names, whatever the template says.
|
|
702
|
+
*
|
|
703
|
+
* Best-effort: `create-akan-workspace` scaffolds before `bun install`, so there is no local Biome binary
|
|
704
|
+
* and often no config above the target yet. An unformatted file is a lint fix; a failed scaffold is not.
|
|
705
|
+
*/
|
|
706
|
+
async #formatAppliedTemplate(fileContents: FileContent[]) {
|
|
707
|
+
const filePaths = fileContents
|
|
708
|
+
.map((fileContent) => fileContent.filePath)
|
|
709
|
+
.filter((filePath) => filePath.endsWith(".ts") || filePath.endsWith(".tsx"));
|
|
710
|
+
if (filePaths.length === 0) return;
|
|
711
|
+
try {
|
|
712
|
+
const { fixed } = await this.getLinter().fixFiles(filePaths);
|
|
713
|
+
if (fixed.length > 0) this.logger.verbose(`Formatted ${fixed.length} scaffolded file(s)`);
|
|
714
|
+
} catch (err) {
|
|
715
|
+
this.logger.verbose(`Skipped formatting scaffolded files: ${err instanceof Error ? err.message : String(err)}`);
|
|
716
|
+
}
|
|
694
717
|
}
|
|
695
718
|
// Async so `typescript` (~65MB resident) is loaded only by the commands that actually typecheck,
|
|
696
719
|
// not by every process that imports an executor. `typeCheckAsync` below runs in a subprocess and
|
|
@@ -913,9 +936,10 @@ export class WorkspaceExecutor extends Executor {
|
|
|
913
936
|
return await getDirs(basePath);
|
|
914
937
|
}
|
|
915
938
|
async commit(message: string, { init = false, add = true }: { init?: boolean; add?: boolean } = {}) {
|
|
916
|
-
if (init) await this.
|
|
917
|
-
if (add) await this.
|
|
918
|
-
|
|
939
|
+
if (init) await this.spawn("git", ["init", "--quiet"]);
|
|
940
|
+
if (add) await this.spawn("git", ["add", "."]);
|
|
941
|
+
// Argument vector, not a shell string: a message carrying a double quote breaks the interpolated form.
|
|
942
|
+
await this.spawn("git", ["commit", "--quiet", "-m", message]);
|
|
919
943
|
}
|
|
920
944
|
async #getDirHasFile(basePath: string, targetFilename: string) {
|
|
921
945
|
const AVOID_DIRS = ["node_modules", "dist", "public", "webkit"];
|
|
@@ -1369,7 +1393,7 @@ export class AppExecutor extends SysExecutor {
|
|
|
1369
1393
|
//* generated against and typechecked. Drop the cache so the build phases re-read it without them.
|
|
1370
1394
|
this.#excludeDevOnlyPages = true;
|
|
1371
1395
|
this.#pageKeys = null;
|
|
1372
|
-
|
|
1396
|
+
await this.dist.removeDir(this.dist.cwdPath);
|
|
1373
1397
|
await Promise.all([this.dist.mkdir("private"), this.dist.mkdir("public")]);
|
|
1374
1398
|
//* Lib assets are symlinks in the app dir (see syncAssets). dist is the docker build context and the
|
|
1375
1399
|
//* release tarball root, neither of which follows a link out of itself, so materialize them here.
|