@aventara/cli 0.1.0-pilot.1 → 0.1.0-pilot.3

package/dist/catalog/range.reader.js

@@ -1,11 +1,4 @@
-/**
- * Reading a declared version range for the two facts the CLI needs from one:
- * its lowest version (D1, D9: what `init` pins when it installs the ORM — the
- * adapter's measured floor) and its lowest major (a project's declared Nest and
- * TypeScript ranges, checked before anything is written).
- */
 const VERSION = /(\d+)(?:\.(\d+))?(?:\.(\d+))?/;
-/** `^7.10.0` → `7.10.0`; `>=7.10.0 <8` → `7.10.0`. */
 export function lowestVersionOf(range) {
     const found = VERSION.exec(range);
     if (found === null) {
@@ -13,19 +6,12 @@ export function lowestVersionOf(range) {
     }
     return `${found[1]}.${found[2] ?? 0}.${found[3] ?? 0}`;
 }
-/** `^12.0.1` → 12; `~6.0.2` → 6; a range with no number (`latest`, `*`) → `undefined`. */
 export function lowestMajorOf(range) {
     const found = VERSION.exec(range);
     return found === null ? undefined : Number(found[1]);
 }
 const RELEASE = /^(\d+)\.(\d+)\.(\d+)$/;
 const COMPARATOR = /^(\^|>=|>|<=|<|=)?(\d+)(?:\.(\d+))?(?:\.(\d+))?$/;
-/**
- * Whether an installed `version` is in a declared `range` (R7: the adapter's
- * declaration decides support). Reads the comparator forms an adapter's peer
- * range uses; a pre-release never satisfies (semver's rule for a range whose
- * comparators carry none). Any other form is refused rather than guessed.
- */
 export function satisfiesRange(version, range) {
     const release = RELEASE.exec(version);
     if (release === null) {

package/dist/cli.d.ts

@@ -2,9 +2,8 @@ import type { AdapterCatalog } from "./catalog/catalog-entry.interface.js";
 import { type CommandRunner } from "./run/command.runner.js";
 import { type Prompter } from "./wizard/answer.resolver.js";
 /**
- * `aventara` — the bin (R1): `new` and `init`. A refusal is one sentence on
- * stderr and exit 1, never a stack; anything else is a defect and keeps its
- * stack.
+ * `aventara` — the bin: `new` and `init`. A refusal is one sentence on stderr and
+ * exit 1, never a stack; anything else is a defect and keeps its stack.
  *
  * `init` initializes the project in the working directory
  * (`run/init.orchestrator.ts`); `new` creates one with the pinned `nest new` and

package/dist/cli.js

@@ -1,7 +1,7 @@
 import { readFileSync } from "node:fs";
 import { ConflictsNotConfirmedError } from "./apply/conflict.confirmer.js";
 import { ADAPTER_CATALOG } from "./catalog/adapter.catalog.generated.js";
-import { CliCommandError, commandUsage, parseCliCommand, USAGE, } from "./command/command.parser.js";
+import { CliCommandError, commandUsage, parseCliCommand, usage, } from "./command/command.parser.js";
 import { ProjectRefusedError } from "./project/project.inspector.js";
 import { runCommand } from "./run/command.runner.js";
 import { InstallFailedError, runInit } from "./run/init.orchestrator.js";
@@ -27,7 +27,10 @@ export async function runCli(argv, io) {
     try {
         const command = parseCliCommand(argv);
         if (command.command === "help") {
-            io.stdout(command.topic === undefined ? USAGE : commandUsage(command.topic));
+            const catalog = io.catalog ?? ADAPTER_CATALOG;
+            io.stdout(command.topic === undefined
+                ? usage(catalog)
+                : commandUsage(command.topic, catalog));
             return 0;
         }
         if (command.command === "version") {
@@ -66,12 +69,6 @@ export async function runCli(argv, io) {
         return 1;
     }
 }
-/**
- * Runs `aventara` over this process — its arguments, its terminal, its exit
- * code. Called by the bin's entry (`aventara.bin.ts`) once the Node guard has
- * admitted this Node; importing this module runs nothing, which lets `runCli`
- * be tested in process.
- */
 export async function runFromProcess() {
     const prompter = createReadlinePrompter({
         input: process.stdin,

package/dist/command/command.parser.d.ts

@@ -1,10 +1,11 @@
+import type { AdapterCatalog } from "../catalog/catalog-entry.interface.js";
 import { type QuestionId } from "../wizard/wizard.questions.js";
 /**
- * The `aventara` command line (R1, R2, Q16): `new <name>` and `init`, each
- * question's flag from the wizard's table, and the options that are not
- * questions. Unknown, misplaced or repeated arguments are refused in one
- * sentence; a flag's VALUE is the question's to judge, because what is valid
- * (`--db`'s providers) depends on the catalog and on earlier answers.
+ * The `aventara` command line: `new <name>` and `init`, each question's flag from
+ * the wizard's table, and the options that are not questions. Unknown, misplaced
+ * or repeated arguments are refused in one sentence; a flag's VALUE is the
+ * question's to judge, because what is valid (`--db`'s providers) depends on the
+ * catalog and on earlier answers.
  */
 export type ScaffoldCommandName = "new" | "init";
 export type ScaffoldCommand = {
@@ -12,9 +13,9 @@ export type ScaffoldCommand = {
     /** Raw answers by question, from flags and `new`'s positional `<name>`. */
     readonly given: Readonly<Partial<Record<QuestionId, string>>>;
     readonly skipInstall: boolean;
-    /** `new` only: passed through to `nest new` (Q16-7). */
+    /** `new` only: passed through to `nest new`. */
     readonly skipGit: boolean;
-    /** Accepts each unanswered question's default and confirms overwrites (R5). */
+    /** Accepts each unanswered question's default and confirms overwrites. */
     readonly yes: boolean;
 };
 export type CliCommand = 
@@ -30,7 +31,8 @@ export declare class CliCommandError extends Error {
     readonly name = "CliCommandError";
 }
 /** `aventara <command> --help` (pilot.1): that command's usage alone. */
-export declare function commandUsage(command: ScaffoldCommandName): string;
-export declare const USAGE: string;
+export declare function commandUsage(command: ScaffoldCommandName, catalog: AdapterCatalog): string;
+/** `aventara --help`: both commands, each flag with the values `catalog` offers. */
+export declare function usage(catalog: AdapterCatalog): string;
 /** @throws CliCommandError when `argv` is not a command this CLI has. */
 export declare function parseCliCommand(argv: readonly string[]): CliCommand;

package/dist/command/command.parser.js

@@ -1,9 +1,7 @@
-import { INIT_FLAG_QUESTIONS, NEW_QUESTIONS, } from "../wizard/wizard.questions.js";
-/** The command line cannot be understood. A refusal: one sentence, exit 1. */
+import { INIT_FLAG_QUESTIONS, NEW_QUESTIONS, ormAliasesSentence, } from "../wizard/wizard.questions.js";
 export class CliCommandError extends Error {
     name = "CliCommandError";
 }
-/** The options that are not wizard questions. */
 const OPTIONS = [
     {
         flag: "--skip-install",
@@ -30,12 +28,18 @@ const QUESTIONS = {
     init: INIT_FLAG_QUESTIONS,
 };
 const HELP = "run `aventara --help` for usage";
-function usageLines(command) {
+function flagUsage(question, catalog) {
+    const accepted = question.accepts?.(catalog);
+    return `${question.flag} ${accepted === undefined
+        ? (question.placeholder ?? "<value>")
+        : `<${accepted.join("|")}>`}`;
+}
+function usageLines(command, catalog) {
     const rows = [
         ...QUESTIONS[command]
             .filter((question) => question.flag.startsWith("--"))
             .map((question) => [
-            `${question.flag} ${question.placeholder ?? "<value>"}`,
+            flagUsage(question, catalog),
             `${question.label}; asked when omitted`,
         ]),
         ...OPTIONS.filter((option) => option.commands.includes(command)).map((option) => [
@@ -48,7 +52,6 @@ function usageLines(command) {
         .map(([left, right]) => `    ${left.padEnd(width)}  ${right}`)
         .join("\n");
 }
-/** What each command does, in one line: the top-level usage and its own. */
 const SUMMARY = {
     new: "Create a NestJS project with Aventara (nest new, then init).",
     init: "Add Aventara to the NestJS 12 project in this directory.",
@@ -57,35 +60,38 @@ const SYNOPSIS = {
     new: "aventara new <name> [options]",
     init: "aventara init [options]",
 };
-const ASKED = `On a terminal every unanswered question is asked; anywhere else, pass its flag
+function asked(catalog) {
+    return `${ormAliasesSentence(catalog)}.
+On a terminal every unanswered question is asked; anywhere else, pass its flag
 or --yes, or the run stops before writing anything.
 `;
-/** `aventara <command> --help` (pilot.1): that command's usage alone. */
-export function commandUsage(command) {
+}
+export function commandUsage(command, catalog) {
     return `Usage: ${SYNOPSIS[command]}
 
 ${SUMMARY[command]}
 
 Options:
-${usageLines(command)}
+${usageLines(command, catalog)}
 
-${ASKED}`;
+${asked(catalog)}`;
 }
-export const USAGE = `aventara — scaffold an Aventara server on NestJS.
+export function usage(catalog) {
+    return `aventara — scaffold an Aventara server on NestJS.
 
 Usage:
   ${SYNOPSIS.new}   ${SUMMARY.new}
-${usageLines("new")}
+${usageLines("new", catalog)}
 
   ${SYNOPSIS.init}         ${SUMMARY.init}
-${usageLines("init")}
+${usageLines("init", catalog)}
 
   aventara --help                 Print this and exit 0.
   aventara <command> --help       Print that command's usage and exit 0.
-  aventara --version              Print this CLI's version and exit 0.
+  aventara --version, -v          Print this CLI's version and exit 0.
 
-${ASKED}`;
-/** @throws CliCommandError when `argv` is not a command this CLI has. */
+${asked(catalog)}`;
+}
 export function parseCliCommand(argv) {
     const [command, ...rest] = argv;
     if (command === undefined) {
@@ -94,7 +100,7 @@ export function parseCliCommand(argv) {
     if (command === "--help" || command === "-h") {
         return { command: "help" };
     }
-    if (command === "--version") {
+    if (command === "--version" || command === "-v") {
         return { command: "version" };
     }
     if (command !== "new" && command !== "init") {

package/dist/node-version.guard.js

@@ -1,4 +1,3 @@
-// biome-ignore lint/style/useNodejsImportProtocol: Node 14.0–14.13.0 resolves no "node:" specifier in an ES module, and this module runs on the Nodes the packages do not support.
 import { readFileSync } from "fs";
 function versionOf(text) {
     const match = /^v?(\d+)\.(\d+)\.(\d+)/.exec(text);
@@ -16,11 +15,6 @@ function compareVersions(left, right) {
     }
     return 0;
 }
-/**
- * Whether `range` admits `version`. Reads `^x.y.z` (the same major, from the
- * floor; majors ≥ 1) and `>=x.y.z`, joined by `||`; anything else throws rather
- * than admit or refuse by guess.
- */
 function admits(range, version) {
     return range.split("||").some((part) => {
         const comparator = /^\s*(\^|>=)(\d+\.\d+\.\d+)\s*$/.exec(part);
@@ -32,17 +26,11 @@ function admits(range, version) {
             (comparator[1] === ">=" || version[0] === floor[0]));
     });
 }
-/** The sentence a bin answers on `version`, or `undefined` when `range` admits it. */
 export function nodeVersionRefusal(bin, packageName, range, version) {
     return admits(range, versionOf(version))
         ? undefined
         : `${bin}: Node ${version} is not supported; ${packageName} needs Node ${range}.`;
 }
-/**
- * Reads the manifest at `manifestUrl`; on a Node its `engines.node` does not
- * admit, writes the sentence to stderr, sets exit code 1 and answers `true` —
- * the bin then loads nothing else.
- */
 export function refuseUnsupportedNode(bin, manifestUrl) {
     const manifest = JSON.parse(readFileSync(manifestUrl, "utf8"));
     const range = manifest.engines === undefined ? undefined : manifest.engines.node;

package/dist/plan/project.planner.d.ts

@@ -3,18 +3,12 @@ import { type ProjectInspection } from "../project/project.inspector.js";
 import { type OrmScaffold } from "../templates/template.registry.js";
 import type { PackageManager } from "../wizard/wizard.questions.js";
 /**
- * §4.1's `plan`: everything `aventara init` will write, decided before anything
- * is written — the files, the anchored `app.module.ts` edit (or the printed
- * instructions), the merged manifests — and every **conflict**, computed both
- * ways so the confirmation can choose. Pure apart from reading the files it
- * would replace.
- *
- * What is Nest's (its default start scripts, `AventaraModule`'s import) and what
- * is Aventara's (its packages at this CLI's version, D1; the `aventara:prepare`
- * and `postinstall` scripts, Q16-22, D2) is decided here; what is the ORM's
- * comes from its templates (D7).
+ * Pure apart from reading the files it would replace.
+ */
+/**
+ * The name of the script that regenerates the ORM client and the discovery
+ * artifact.
  */
-/** The name of the script that regenerates the ORM client and the discovery artifact (Q16-22). */
 export declare const PREPARE_SCRIPT = "aventara:prepare";
 export type PlannedWrite = {
     readonly path: string;
@@ -39,12 +33,12 @@ export type PlanInput = {
     readonly entry: CatalogEntry;
     readonly scaffold: OrmScaffold;
     readonly packageManager: PackageManager;
-    /** This CLI's version: every Aventara package is pinned to it (D1). */
+    /** This CLI's version: every Aventara package is pinned to it. */
     readonly aventaraVersion: string;
     readonly skipInstall: boolean;
     /** The current text of a project file, or `undefined` when absent. */
     readonly read: (file: string) => string | undefined;
-    /** The anchored edit is not attempted; the wiring is printed (a service holding its client, §4.4.4). */
+    /** The anchored edit is not attempted; the wiring is printed. */
     readonly wiringByHand?: string;
     /** Said before the write, beside the planner's own. */
     readonly warnings?: readonly string[];

package/dist/plan/project.planner.js

@@ -1,23 +1,10 @@
 import { spliceAppModule, wiringInstructions, } from "../apply/app-module.anchor.js";
 import { E2E_SPEC, spliceContractTest } from "../apply/e2e-spec.anchor.js";
-import { mergeEnvFile, mergeGitignore, mergePackageManifest, mergePnpmWorkspace, } from "../apply/manifest.merger.js";
+import { CORS_ORIGINS_VARIABLE, MAIN_FILE, mainCorsInstructions, SCAFFOLD_CORS_ORIGINS, spliceMainCors, } from "../apply/main-cors.anchor.js";
+import { appendEnvEntryIfAbsent, mergeEnvFile, mergeGitignore, mergePackageManifest, mergePnpmWorkspace, } from "../apply/manifest.merger.js";
 import { APP_MODULE, } from "../project/project.inspector.js";
 import { SCAFFOLD_ENTRYPOINT, } from "../templates/template.registry.js";
-/**
- * §4.1's `plan`: everything `aventara init` will write, decided before anything
- * is written — the files, the anchored `app.module.ts` edit (or the printed
- * instructions), the merged manifests — and every **conflict**, computed both
- * ways so the confirmation can choose. Pure apart from reading the files it
- * would replace.
- *
- * What is Nest's (its default start scripts, `AventaraModule`'s import) and what
- * is Aventara's (its packages at this CLI's version, D1; the `aventara:prepare`
- * and `postinstall` scripts, Q16-22, D2) is decided here; what is the ORM's
- * comes from its templates (D7).
- */
-/** The name of the script that regenerates the ORM client and the discovery artifact (Q16-22). */
 export const PREPARE_SCRIPT = "aventara:prepare";
-/** D3: `nest new`'s start scripts (B1), and what each becomes so `.env` reaches the server. */
 const START_SCRIPTS = {
     start: { from: "nest start", to: "nest start --env-file .env" },
     "start:dev": {
@@ -33,11 +20,6 @@ const START_SCRIPTS = {
         to: "node --env-file-if-exists=.env dist/main",
     },
 };
-/**
- * F-853: `nest new`'s e2e script per module kind (B1, B28), and the same run with
- * the `.env` the start scripts load — the e2e spec boots `AppModule`, whose
- * service needs `DATABASE_URL`, and neither vitest nor jest loads `.env`.
- */
 const E2E_SCRIPTS = {
     esm: {
         from: "vitest run --config ./vitest.config.e2e.ts",
@@ -61,12 +43,6 @@ function writeOf(path, before, after) {
             },
         ];
 }
-/**
- * pilot.1 — the frontend's first command, as the developer can run it: the
- * package manager's own one-off runner (`npx` or `pnpm dlx`), and — while this
- * CLI is a prerelease — its dist-tag, so the client comes from the same release
- * (`0.1.0-pilot.1` → `@aventara/client@pilot`). A release has no tag to name.
- */
 export function frontendInitCommand(packageManager, cliVersion) {
     const tag = /^\d+\.\d+\.\d+-([0-9A-Za-z-]+)/.exec(cliVersion)?.[1];
     const runner = packageManager === "pnpm" ? "pnpm dlx" : "npx";
@@ -87,7 +63,6 @@ export function planInit(input) {
         keeping.push(...writeOf(path, before, kept.text));
         replacing.push(...writeOf(path, before, replaced.text));
     };
-    // The ORM's new files: identical content is no change (P3), other content a conflict.
     for (const file of scaffold.files) {
         const before = input.read(file.path);
         if (before === undefined) {
@@ -111,7 +86,6 @@ export function planInit(input) {
             });
         }
     }
-    // The one edit to developer code (R2).
     const wiring = {
         imports: [
             `import { AventaraModule } from '${NEST_HOST}';`,
@@ -132,8 +106,6 @@ export function planInit(input) {
     if (edit.kind === "edited") {
         keeping.push(...writeOf(APP_MODULE, appModule, edit.text));
         replacing.push(...writeOf(APP_MODULE, appModule, edit.text));
-        // pilot.1: Nest's own e2e spec also asks for the contract — only when
-        // AventaraModule was wired in, so the test proves what it claims.
         const spec = input.read(E2E_SPEC);
         const tested = spec === undefined
             ? undefined
@@ -147,6 +119,31 @@ export function planInit(input) {
         instructions = wiringInstructions(wiring);
         warnings.push(`${APP_MODULE} was not edited: ${edit.reason}; add AventaraModule by hand, as printed below`);
     }
+    const main = input.read(MAIN_FILE);
+    const cors = main === undefined
+        ? { kind: "not-anchored", reason: `there is no ${MAIN_FILE}` }
+        : spliceMainCors(main);
+    if (cors.kind === "edited") {
+        keeping.push(...writeOf(MAIN_FILE, main, cors.text));
+        replacing.push(...writeOf(MAIN_FILE, main, cors.text));
+    }
+    else if (cors.kind === "configured") {
+        warnings.push(`${MAIN_FILE} already configures CORS, so it was left as it is; a browser frontend on another origin is answered only if that configuration allows it`);
+    }
+    else if (cors.kind === "not-anchored") {
+        instructions = [instructions, mainCorsInstructions()]
+            .filter((text) => text !== undefined)
+            .join("\n");
+        warnings.push(`${MAIN_FILE} was not edited: ${cors.reason}; add CORS by hand, as printed below`);
+    }
+    const corsWanted = cors.kind !== "configured";
+    const scaffoldWritesEnv = Object.keys(scaffold.env).length > 0;
+    const env = input.read(".env");
+    const corsStep = corsWanted && !scaffoldWritesEnv && env === undefined
+        ? [
+            `Let a browser frontend call the server: add ${CORS_ORIGINS_VARIABLE}="${SCAFFOLD_CORS_ORIGINS}" to .env (unset, CORS stays off)`,
+        ]
+        : [];
     const versions = {
         [CORE]: input.aventaraVersion,
         [NEST_HOST]: input.aventaraVersion,
@@ -157,7 +154,6 @@ export function planInit(input) {
         devDependencies: scaffold.devDependencies,
         scripts: {
             [PREPARE_SCRIPT]: scaffold.prepare,
-            // D2: the generated trees are ignored and rebuilt on every install.
             postinstall: `${packageManager} run ${PREPARE_SCRIPT}`,
         },
         rewrites: inspection.usesNestConfig
@@ -167,12 +163,24 @@ export function planInit(input) {
                 "test:e2e": E2E_SCRIPTS[inspection.moduleKind],
             },
     }, replace));
-    const env = input.read(".env");
-    if (Object.keys(scaffold.env).length > 0) {
-        both(".env", env, (replace) => mergeEnvFile(env, scaffold.env, replace));
+    if (scaffoldWritesEnv || (corsWanted && env !== undefined)) {
+        both(".env", env, (replace) => {
+            const merged = scaffoldWritesEnv
+                ? mergeEnvFile(env, scaffold.env, replace)
+                : { text: env ?? "", conflicts: [] };
+            return corsWanted
+                ? {
+                    text: appendEnvEntryIfAbsent(merged.text, CORS_ORIGINS_VARIABLE, SCAFFOLD_CORS_ORIGINS),
+                    conflicts: merged.conflicts,
+                }
+                : merged;
+        });
     }
     const gitignore = input.read(".gitignore");
-    both(".gitignore", gitignore, () => mergeGitignore(gitignore, scaffold.gitignore));
+    both(".gitignore", gitignore, () => mergeGitignore(gitignore, [
+        ...scaffold.gitignore,
+        ...(scaffoldWritesEnv ? [".env"] : []),
+    ]));
     if (packageManager === "pnpm" && scaffold.nativeBuilds.length > 0) {
         const workspace = input.read("pnpm-workspace.yaml");
         both("pnpm-workspace.yaml", workspace, () => mergePnpmWorkspace(workspace, scaffold.nativeBuilds));
@@ -194,6 +202,7 @@ export function planInit(input) {
                     "The start scripts were left as they are: @nestjs/config loads .env, so make sure it does before Prisma connects.",
                 ]
                 : []),
+            ...corsStep,
             `Start the server: ${run} run start:dev`,
             `In your frontend: ${frontendInitCommand(packageManager, input.aventaraVersion)}`,
         ],

package/dist/project/package-manager.detector.d.ts

@@ -1,11 +1,4 @@
 import type { PackageManager } from "../wizard/wizard.questions.js";
-/**
- * Q16-5's default package manager: a lockfile says what a project already uses
- * (`init`); otherwise the package manager that launched this CLI says what the
- * developer uses — `npm_config_user_agent` is `npm/…` under `npx` and
- * `npm exec`, `pnpm/…` under `pnpm dlx` and `pnpm exec`, and unset when the bin
- * runs directly (B11); otherwise npm.
- */
 export declare function detectPackageManager(signals: {
     readonly lockfile?: PackageManager | undefined;
     readonly userAgent?: string | undefined;

package/dist/project/package-manager.detector.js

@@ -1,10 +1,3 @@
-/**
- * Q16-5's default package manager: a lockfile says what a project already uses
- * (`init`); otherwise the package manager that launched this CLI says what the
- * developer uses — `npm_config_user_agent` is `npm/…` under `npx` and
- * `npm exec`, `pnpm/…` under `pnpm dlx` and `pnpm exec`, and unset when the bin
- * runs directly (B11); otherwise npm.
- */
 export function detectPackageManager(signals) {
     if (signals.lockfile !== undefined) {
         return signals.lockfile;

package/dist/project/project.inspector.d.ts

@@ -2,17 +2,11 @@ import type { PackageManifest } from "../apply/manifest.merger.js";
 import type { AdapterCatalog, CatalogEntry } from "../catalog/catalog-entry.interface.js";
 import type { ModuleKind } from "../templates/template.registry.js";
 import type { PackageManager } from "../wizard/wizard.questions.js";
-/**
- * §4.1's `inspect`: what `aventara init` needs to know about the project in the
- * working directory, read before anything is asked or written — so every
- * refusal here leaves the directory exactly as it was (it is a property of the
- * order, not of a rollback).
- */
 /** The project is not one `aventara init` serves. A refusal: one sentence, nothing written. */
 export declare class ProjectRefusedError extends Error {
     readonly name = "ProjectRefusedError";
 }
-/** The ORM a project already has, by the catalog's family packages (R14, D10). */
+/** The ORM a project already has, by the catalog's family packages. */
 export type OrmPresence = {
     readonly kind: "absent";
 } | {
@@ -30,9 +24,9 @@ export type ProjectInspection = {
     /** The package manager the lockfile names, if exactly one does. */
     readonly lockfile: PackageManager | undefined;
     readonly orm: OrmPresence;
-    /** `@nestjs/config` loads `.env` itself, so the start scripts are left alone (P5). */
+    /** `@nestjs/config` loads `.env` itself, so the start scripts are left alone. */
     readonly usesNestConfig: boolean;
 };
-/** The file the anchored edit opens (R2). */
+/** The file the anchored edit opens. */
 export declare const APP_MODULE = "src/app.module.ts";
 export declare function inspectProject(directory: string, catalog: AdapterCatalog): ProjectInspection;

package/dist/project/project.inspector.js

@@ -1,21 +1,11 @@
 import { existsSync, readFileSync } from "node:fs";
 import path from "node:path";
 import { lowestMajorOf } from "../catalog/range.reader.js";
-/**
- * §4.1's `inspect`: what `aventara init` needs to know about the project in the
- * working directory, read before anything is asked or written — so every
- * refusal here leaves the directory exactly as it was (it is a property of the
- * order, not of a rollback).
- */
-/** The project is not one `aventara init` serves. A refusal: one sentence, nothing written. */
 export class ProjectRefusedError extends Error {
     name = "ProjectRefusedError";
 }
-/** Nest 12 only (Phase 11 Q16). */
 const NEST_MAJOR = 12;
-/** D4: TypeScript 7 has no classic compiler API. */
 const FIRST_UNSUPPORTED_TYPESCRIPT = 7;
-/** The file the anchored edit opens (R2). */
 export const APP_MODULE = "src/app.module.ts";
 const LOCKFILES = [
     ["package-lock.json", "npm"],

package/dist/project/service.detector.d.ts

@@ -1,15 +1,10 @@
 /**
- * R6 — finding the developer's own ORM service, lexically, over `src/**\/*.ts`:
- * no compiler (`aventara init` may run before anything is installed).
- *
- * 1. **Candidates**: exported classes that `extends` the ORM's client class,
- *    where the file imports that class from a specifier the ORM's templates
- *    recognise (the generated client, or the ORM package).
- * 2. **Compositions**: exported classes that hold a client instead of extending
- *    one (`client = new PrismaClient(…)`, Phase 11 S7's shape) — reported with
- *    the member, never wired.
+ * 1. **Candidates**: exported classes that `extends` the ORM's client class, where
+ *    the file imports that class from a specifier the ORM's templates recognise
+ *    (the generated client, or the ORM package).
  * 3. **Modules**: each `@Module({…})`-decorated exported class with the
- *    identifiers its `providers` and `exports` list, and whether it is `@Global()`.
+ *    identifiers its `providers` and `exports` list, and whether it is
+ *    `@Global()`.
  *
  * Which of them is *the* service is the caller's question (the wizard's).
  */

package/dist/project/service.detector.js

@@ -18,7 +18,6 @@ function sourceFiles(directory, root, skip) {
             : [];
     });
 }
-/** The identifiers the array under `key`, at `object`'s own level, names (`providers: [A, B]`). */
 function arrayNames(text, code, object, key) {
     const end = closing(text, code, object);
     let depth = 0;
@@ -99,7 +98,6 @@ export function scanServices(directory, shape) {
     }
     return { candidates, compositions, modules };
 }
-/** The modules that make `service` injectable elsewhere: providing and exporting it, or global. */
 export function modulesProviding(scan, service) {
     return scan.modules.filter((module) => module.providers.includes(service.exportName) &&
         (module.exports.includes(service.exportName) || module.global));

package/dist/project/source.scanner.js

@@ -1,15 +1,5 @@
-/**
- * A lexical view of TypeScript source — enough to find decorators, classes,
- * imports and brackets **in code**, never inside a comment, a string or a
- * template literal's text — with no compiler: `aventara new` runs before
- * anything (TypeScript included) is installed in the project, and the CLI
- * carries no TypeScript of its own. Shared by the anchored `app.module.ts` edit
- * and the detection of a developer's ORM service.
- */
-/** For each character: is it code (not inside a comment, string or template text)? */
 export function codeMask(text) {
     const code = new Array(text.length).fill(true);
-    /** Open template literals' brace depths: `${` re-enters code until its `}`. */
     const templates = [];
     let braces = 0;
     let index = 0;
@@ -19,7 +9,6 @@ export function codeMask(text) {
         }
     };
     const templateText = (from) => {
-        // Scans template text from `from` until "`" (closes) or "${" (re-enters code).
         let at = from;
         while (at < text.length) {
             if (text[at] === "\\") {
@@ -88,7 +77,6 @@ export function codeMask(text) {
     }
     return code;
 }
-/** Every index where `token` starts in code. */
 export function codeIndexes(text, code, token) {
     const found = [];
     for (const match of text.matchAll(token)) {
@@ -103,7 +91,6 @@ export const OPENERS = {
     "[": "]",
     "{": "}",
 };
-/** The index of the bracket closing the one at `open`, counting code brackets only. */
 export function closing(text, code, open) {
     const stack = [];
     for (let at = open; at < text.length; at += 1) {

package/dist/run/command.runner.d.ts

@@ -1,8 +1,8 @@
 /**
- * The one external process seam (§4.2): a command, its arguments, a working
- * directory. Its stdout is always **piped**, never inherited — `nest new` asks a
- * question it has no flag for when its stdout is a terminal (B25) — and both
- * streams are collected, so a failure can be reported with what it said.
+ * The one external process seam: a command, its arguments, a working directory.
+ * Its stdout is always **piped**, never inherited — `nest new` asks a question it
+ * has no flag for when its stdout is a terminal — and both streams are collected,
+ * so a failure can be reported with what it said.
  */
 export type CommandResult = {
     readonly code: number;

package/dist/run/init.orchestrator.d.ts

@@ -3,11 +3,9 @@ import type { ScaffoldCommand } from "../command/command.parser.js";
 import { type Prompter } from "../wizard/answer.resolver.js";
 import type { CommandRunner } from "./command.runner.js";
 /**
- * `aventara init` in §4.1's order — inspect, ask, plan, confirm, and only then
- * write and install. Every step before the write reads; so a refusal anywhere
- * before it leaves the project exactly as it was. A failure after it (the
- * install) names the command, its exit code and what to re-run; nothing is
- * rolled back.
+ * Every step before the write reads; so a refusal anywhere before it leaves the
+ * project exactly as it was. A failure after it (the install) names the command,
+ * its exit code and what to re-run; nothing is rolled back.
  */
 export type InitIo = {
     readonly directory: string;
@@ -17,7 +15,7 @@ export type InitIo = {
     readonly prompter: Prompter;
     readonly runner: CommandRunner;
     readonly catalog: AdapterCatalog;
-    /** This CLI's own version (D1). */
+    /** This CLI's own version. */
     readonly aventaraVersion: string;
     /** Next steps that come before init's own (`new`'s `cd <name>`). */
     readonly firstSteps?: readonly string[];