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

package/dist/wizard/wizard.questions.d.ts

@@ -1,29 +1,27 @@
 import type { AdapterCatalog, CatalogEntry } from "../catalog/catalog-entry.interface.js";
 import { type ExportReference, type ServiceScan } from "../project/service.detector.js";
 /**
- * R5 — every question the two commands ask, in **one table**: its flag, its
- * label, its choices and its default. The command-line grammar, the TTY prompt,
- * the `--yes` defaults and the non-interactive refusal sentence are all derived
- * from it, so a question cannot have a flag the parser does not know or a
- * default the refusal does not mention.
+ * The command-line grammar, the TTY prompt, the `--yes` defaults and the
+ * non-interactive refusal sentence are all derived from it, so a question cannot
+ * have a flag the parser does not know or a default the refusal does not mention.
  *
  * Choices that are an adapter's facts — which ORMs and majors exist, which
- * databases one supports — come from the generated catalog (R14), never from a
- * literal here.
+ * databases one supports — come from the generated catalog, never from a literal
+ * here.
  */
-/** Q16-5 (a). Yarn is not supported (U1). */
+/** Yarn is not supported. */
 export declare const PACKAGE_MANAGERS: readonly ["npm", "pnpm"];
 export type PackageManager = (typeof PACKAGE_MANAGERS)[number];
 /** What the wizard settles. */
 export type WizardAnswers = {
-    /** `new`'s project directory (Q16-3). */
+    /** `new`'s project directory. */
     readonly name: string;
-    /** The ORM and major, as the catalog entry that serves it (R14). */
+    /** The ORM and major, as the catalog entry that serves it. */
     readonly orm: CatalogEntry;
-    /** One of `orm`'s providers (R10). */
+    /** One of `orm`'s providers. */
     readonly db: string;
     readonly packageManager: PackageManager;
-    /** `init` over an existing ORM setup: the developer's service (R6). */
+    /** `init` over an existing ORM setup: the developer's service. */
     readonly service: ServiceChoice;
     /** The Nest module that provides and exports it. */
     readonly module: ExportReference;
@@ -36,7 +34,7 @@ export type ServiceChoice = ExportReference & {
     readonly isNew: boolean;
 };
 export type QuestionId = keyof WizardAnswers;
-/** What the scan of the developer's source found, for the service questions (R6). */
+/** What the scan of the developer's source found, for the service questions. */
 export type ServiceContext = {
     readonly scan: ServiceScan;
     /** The ORM's client class, as the scan looked for it. */
@@ -52,14 +50,13 @@ export type ServiceContext = {
 /** What a question may consult: the catalog, what was detected, what is already answered. */
 export type WizardContext = {
     readonly catalog: AdapterCatalog;
-    /** Q16-5's default: the lockfile, else the launching package manager (B11), else npm. */
     readonly detectedPackageManager: PackageManager;
     readonly answered: Partial<WizardAnswers>;
     /** Present for `init` over an existing ORM setup. */
     readonly services?: ServiceContext;
 };
 export type Choice = {
-    /** What the flag takes and the prompt accepts, e.g. `prisma@7`. */
+    /** What the flag takes and the prompt accepts, e.g. `prisma7`. */
     readonly value: string;
     /** How it is shown, e.g. `Prisma 7`. */
     readonly label: string;
@@ -80,6 +77,11 @@ export type WizardQuestion<K extends QuestionId> = {
     readonly after?: QuestionId;
     /** The answers on offer, or `undefined` for free text. */
     readonly choices: (context: WizardContext) => readonly Choice[] | undefined;
+    /**
+     * Every value its flag takes before anything is answered — what `--help`
+     * lists (pilot.3); absent for free text. From the catalog, never a literal.
+     */
+    readonly accepts?: (catalog: AdapterCatalog) => readonly string[];
     /** The answer `--yes` (or Enter at the prompt) takes; `undefined` when there is none. */
     readonly defaultFor: (context: WizardContext) => string | undefined;
     /** @throws WizardAnswerError when `raw` is not an answer to this question. */
@@ -90,25 +92,29 @@ export type WizardQuestion<K extends QuestionId> = {
 export type AnyWizardQuestion = {
     readonly [K in QuestionId]: WizardQuestion<K>;
 }[QuestionId];
+/**
+ * What `--orm` takes: each adapter's alias, with what it is — the refusal's words,
+ * and the usage's.
+ */
+export declare function ormAliasesSentence(catalog: AdapterCatalog): string;
 export declare const NAME_QUESTION: WizardQuestion<"name">;
 /**
- * R14 — the ORM, from the catalog: `--orm <family>@<major>`, or `--orm <family>`
- * for the family's highest major (Q16-31).
+ * The prompt keeps the family-then-major order; every answer is an alias.
  */
 export declare const ORM_QUESTION: WizardQuestion<"orm">;
-/** R10 — the database, from the chosen entry's providers; the first is the default. */
 export declare const DB_QUESTION: WizardQuestion<"db">;
-/** Q16-5 — npm or pnpm; the default is detected. */
 export declare const PACKAGE_MANAGER_QUESTION: WizardQuestion<"packageManager">;
-/** R6, Q16-11 — the developer's service; a new one is written only when there is none. */
 export declare const SERVICE_QUESTION: WizardQuestion<"service">;
 /** The module that provides and exports the chosen service (or is @Global). */
 export declare const MODULE_QUESTION: WizardQuestion<"module">;
 /** `aventara new`'s questions, in the order they are asked. */
 export declare const NEW_QUESTIONS: readonly [WizardQuestion<"name">, WizardQuestion<"orm">, WizardQuestion<"db">, WizardQuestion<"packageManager">];
-/** `aventara init`'s questions when the project has no ORM (S6), in order. */
+/** `aventara init`'s questions when the project has no ORM, in order. */
 export declare const INIT_QUESTIONS: readonly [WizardQuestion<"orm">, WizardQuestion<"db">, WizardQuestion<"packageManager">];
-/** `aventara init`'s questions over an existing ORM setup (S7): the ORM and database are read, not asked. */
+/**
+ * `aventara init`'s questions over an existing ORM setup: the ORM and database are
+ * read, not asked.
+ */
 export declare const REUSE_QUESTIONS: readonly [WizardQuestion<"service">, WizardQuestion<"module">, WizardQuestion<"packageManager">];
 /** Every flag `aventara init` takes for a question, either way. */
 export declare const INIT_FLAG_QUESTIONS: readonly [WizardQuestion<"orm">, WizardQuestion<"db">, WizardQuestion<"service">, WizardQuestion<"module">, WizardQuestion<"packageManager">];

package/dist/wizard/wizard.questions.js

@@ -1,33 +1,24 @@
 import { modulesProviding, } from "../project/service.detector.js";
-/**
- * R5 — every question the two commands ask, in **one table**: its flag, its
- * label, its choices and its default. The command-line grammar, the TTY prompt,
- * the `--yes` defaults and the non-interactive refusal sentence are all derived
- * from it, so a question cannot have a flag the parser does not know or a
- * default the refusal does not mention.
- *
- * Choices that are an adapter's facts — which ORMs and majors exist, which
- * databases one supports — come from the generated catalog (R14), never from a
- * literal here.
- */
-/** Q16-5 (a). Yarn is not supported (U1). */
 export const PACKAGE_MANAGERS = ["npm", "pnpm"];
-/** An answer the question cannot accept. A refusal: one sentence. */
 export class WizardAnswerError extends Error {
     name = "WizardAnswerError";
 }
 function ormLabel(entry) {
     return `${entry.orm.label} ${entry.orm.major}`;
 }
-function available(catalog) {
-    return catalog
-        .map((entry) => `${ormLabel(entry)} (${entry.adapterPackage})`)
-        .join(", ");
+function listed(items) {
+    return items.length <= 1
+        ? items.join("")
+        : `${items.slice(0, -1).join(", ")} or ${items[items.length - 1]}`;
+}
+function families(catalog) {
+    return [...new Set(catalog.map((entry) => entry.orm.family))];
+}
+export function ormAliasesSentence(catalog) {
+    return `--orm takes ${listed(ormChoices(catalog).map((entry) => `${entry.alias} (${ormLabel(entry)}, ${entry.adapterPackage})`))}`;
 }
-/** Ordered for the wizard: by family as the catalog lists them, majors newest first. */
 function ormChoices(catalog) {
-    const families = [...new Set(catalog.map((entry) => entry.orm.family))];
-    return families.flatMap((family) => catalog
+    return families(catalog).flatMap((family) => catalog
         .filter((entry) => entry.orm.family === family)
         .sort((left, right) => right.orm.major - left.orm.major));
 }
@@ -47,33 +38,21 @@ export const NAME_QUESTION = {
     },
     describe: (name) => name,
 };
-/**
- * R14 — the ORM, from the catalog: `--orm <family>@<major>`, or `--orm <family>`
- * for the family's highest major (Q16-31).
- */
 export const ORM_QUESTION = {
     id: "orm",
     flag: "--orm",
     label: "ORM",
     choices: (context) => ormChoices(context.catalog).map((entry) => ({
-        value: `${entry.orm.family}@${entry.orm.major}`,
+        value: entry.alias,
         label: ormLabel(entry),
     })),
-    defaultFor: (context) => context.catalog.length === 1
-        ? `${context.catalog[0]?.orm.family}@${context.catalog[0]?.orm.major}`
-        : undefined,
+    accepts: (catalog) => ormChoices(catalog).map((entry) => entry.alias),
+    defaultFor: (context) => context.catalog.length === 1 ? context.catalog[0]?.alias : undefined,
     parse: (raw, context) => {
-        const [family, major, ...rest] = raw.trim().toLowerCase().split("@");
-        const offered = ormChoices(context.catalog).filter((entry) => entry.orm.family === family);
-        if (rest.length > 0 || offered.length === 0) {
-            throw new WizardAnswerError(`there is no Aventara adapter for the ORM ${JSON.stringify(raw)}; available: ${available(context.catalog)}`);
-        }
-        if (major === undefined) {
-            return offered[0];
-        }
-        const entry = offered.find((candidate) => String(candidate.orm.major) === major);
+        const alias = raw.trim().toLowerCase();
+        const entry = context.catalog.find((candidate) => candidate.alias === alias);
         if (entry === undefined) {
-            throw new WizardAnswerError(`there is no Aventara adapter for ${offered[0]?.orm.label} ${major}; available: ${available(context.catalog)}`);
+            throw new WizardAnswerError(`there is no Aventara adapter for the ORM ${JSON.stringify(raw)}; ${ormAliasesSentence(context.catalog)}`);
         }
         return entry;
     },
@@ -86,7 +65,6 @@ function requireOrm(context) {
     }
     return orm;
 }
-/** R10 — the database, from the chosen entry's providers; the first is the default. */
 export const DB_QUESTION = {
     id: "db",
     flag: "--db",
@@ -96,6 +74,9 @@ export const DB_QUESTION = {
         value: provider,
         label: provider,
     })),
+    accepts: (catalog) => [
+        ...new Set(catalog.flatMap((entry) => entry.providers)),
+    ],
     defaultFor: (context) => requireOrm(context).providers[0],
     parse: (raw, context) => {
         const orm = requireOrm(context);
@@ -107,12 +88,12 @@ export const DB_QUESTION = {
     },
     describe: (db) => db,
 };
-/** Q16-5 — npm or pnpm; the default is detected. */
 export const PACKAGE_MANAGER_QUESTION = {
     id: "packageManager",
     flag: "--package-manager",
     label: "Package manager",
     choices: () => PACKAGE_MANAGERS.map((manager) => ({ value: manager, label: manager })),
+    accepts: () => PACKAGE_MANAGERS,
     defaultFor: (context) => context.detectedPackageManager,
     parse: (raw) => {
         const manager = PACKAGE_MANAGERS.find((candidate) => candidate === raw.trim().toLowerCase());
@@ -139,7 +120,6 @@ function requireServices(context) {
     }
     return context.services;
 }
-/** The services on offer: what the scan found, or — when it found none — the template's new file. */
 function serviceOptions(services) {
     const found = [
         ...services.scan.candidates.map((candidate) => ({
@@ -156,14 +136,11 @@ function serviceOptions(services) {
         ? found
         : [{ ...services.newService, isNew: true }];
 }
-/** R6, Q16-11 — the developer's service; a new one is written only when there is none. */
 export const SERVICE_QUESTION = {
     id: "service",
     flag: "--prisma-service",
     placeholder: "<path#Export>",
     label: "Service to give Aventara (file#Export)",
-    // With no service found, the offer to write one is a question with a default
-    // (asked on a terminal, taken by --yes), not a single choice taken silently.
     choices: (context) => {
         const options = serviceOptions(requireServices(context));
         return options.every((option) => option.isNew)
@@ -198,7 +175,6 @@ export const SERVICE_QUESTION = {
     },
     describe: spelled,
 };
-/** The module that provides and exports the chosen service (or is @Global). */
 export const MODULE_QUESTION = {
     id: "module",
     flag: "--prisma-module",
@@ -232,26 +208,22 @@ export const MODULE_QUESTION = {
     },
     describe: spelled,
 };
-/** `aventara new`'s questions, in the order they are asked. */
 export const NEW_QUESTIONS = [
     NAME_QUESTION,
     ORM_QUESTION,
     DB_QUESTION,
     PACKAGE_MANAGER_QUESTION,
 ];
-/** `aventara init`'s questions when the project has no ORM (S6), in order. */
 export const INIT_QUESTIONS = [
     ORM_QUESTION,
     DB_QUESTION,
     PACKAGE_MANAGER_QUESTION,
 ];
-/** `aventara init`'s questions over an existing ORM setup (S7): the ORM and database are read, not asked. */
 export const REUSE_QUESTIONS = [
     SERVICE_QUESTION,
     MODULE_QUESTION,
     PACKAGE_MANAGER_QUESTION,
 ];
-/** Every flag `aventara init` takes for a question, either way. */
 export const INIT_FLAG_QUESTIONS = [
     ORM_QUESTION,
     DB_QUESTION,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aventara/cli",
-  "version": "0.1.0-pilot.1",
+  "version": "0.1.0-pilot.3",
   "license": "SEE LICENSE IN LICENSE",
   "description": "Scaffolds an Aventara server: `aventara new` for a new NestJS project, `aventara init` for an existing one.",
   "type": "module",
@@ -23,7 +23,7 @@
   },
   "scripts": {
     "prebuild": "node scripts/adapter-catalog.generator.ts",
-    "build": "tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.json --removeComments --declaration false && tsc -p tsconfig.json --emitDeclarationOnly && node ../../scripts/build/declaration-comments.sanitizer.ts dist",
     "typecheck": "tsc -p tsconfig.typecheck.json --noEmit",
     "test": "vitest run --typecheck --config ../../vitest.config.mts --root .",
     "lint": "biome lint src scripts"