@mnci/cli 4.51.0 → 4.52.0

package/README.md

@@ -507,6 +507,28 @@ from File`), and the curated root scripts.
 4. Installs the chosen **stack** (see below), `husky` + `@commitlint/*` for
    real, so versions resolve at generation time.
 
+## A whole shape in one step (`mnci new --preset`)
+
+Everything else in mnci is per project. `mnci new my-shop --preset web-api` also scaffolds a wired-together shape, so the
+result is a starting point that already runs rather than three projects to connect:
+
+| Preset | Adds | Wiring |
+|---|---|---|
+| `web-api` | `libs/shared` (an internal library), `apps/api` (Express) and `apps/web` (React) | the API answers `GET /api/greeting` with the shared library's `greet`; the frontend asks that route and types the answer with the shared `Greeting`; both declare `@<scope>/shared`; Vite forwards `/api` to the API in development |
+
+Each project is added through `mnci add`, so it is exactly what `add` makes, and the preset then edits them into one shape:
+the API and the frontend drop their own copy of the sample use case and contract (the library owns them now), each gets a
+spec that matches (written without a mock library, so it runs under Jest or Vitest), and one install, one `nx sync` and one
+format finish it. `mnci dev web api` starts both servers, and asking the frontend's origin for `/api/greeting` returns the
+API's answer through the proxy.
+
+A misspelt preset is refused before the workspace is generated, and the wiring edits fail with the file named, not
+silently, if a generator's output ever stops having the text they change. A preset is a starting point to edit: delete what
+you do not need. New presets are an entry in `workspace-presets/preset-catalog.config.ts` plus their wiring.
+
+The `web-api preset` e2e section generates one and checks lint, typecheck, test and build for all three projects, the
+specs under Vitest, and the proxied request while both servers run.
+
 ## Starting projects together (`mnci dev`)
 
 `<name>:start` starts one project. `mnci dev web api` starts several at once, the usual case being a frontend and the

package/dist/cli.js

@@ -10317,9 +10317,281 @@ async function runInteractive(program, prompter = createInquirerPrompter(), work
   }
 }
 
-// src/workspace-creation/adopt-directory.use-case.ts
+// src/workspace-presets/preset-catalog.config.ts
+var PRESETS = [
+  {
+    id: "web-api",
+    summary: "a React frontend and an Express API that share one internal library: the web asks the API, the API answers with the shared greeting, and `mnci dev web api` starts both",
+    projects: [
+      { kind: "internal-lib", name: "shared", options: {} },
+      { kind: "node-app", name: "api", options: { framework: "express" } },
+      { kind: "react-app", name: "web", options: {} }
+    ]
+  }
+];
+var PRESET_IDS = PRESETS.map((preset) => preset.id);
+
+// src/workspace-presets/wire-web-api.use-case.ts
 var import_node_fs40 = require("fs");
 var import_node_path50 = require("path");
+
+// src/workspace-presets/web-api-wiring.algorithm.ts
+function apiHandler(shared) {
+  return `import { greet } from '${shared}'
+import type { Request, Response } from 'express'
+
+export function helloHandler (request: Request, response: Response): void {
+  const name = typeof request.query.name === 'string' ? request.query.name : 'world'
+  response.send(greet(name))
+}
+`;
+}
+function apiHandlerSpec(shared) {
+  return String.raw`import { greet } from '${shared}'
+import type { Request, Response } from 'express'
+import { helloHandler } from './hello.handler'
+
+/** A response that keeps what it was sent, so the spec needs no mock library and runs under Jest or Vitest. */
+function recordingResponse (): { response: Response, sent: unknown[] } {
+  const sent: unknown[] = []
+
+  return { sent, response: { send: (value: unknown) => { sent.push(value) } } as unknown as Response }
+}
+
+describe('helloHandler', () => {
+  it('answers with the shared library\'s greeting for the name asked', () => {
+    const { response, sent } = recordingResponse()
+
+    helloHandler({ query: { name: 'web' } } as unknown as Request, response)
+
+    expect(sent).toEqual([greet('web')])
+  })
+
+  it('greets the world when no name is asked', () => {
+    const { response, sent } = recordingResponse()
+
+    helloHandler({ query: {} } as unknown as Request, response)
+
+    expect(sent).toEqual([greet('world')])
+  })
+})
+`;
+}
+function apiBarrel() {
+  return "export * from './hello.handler'\n";
+}
+function webGreetingClient(shared) {
+  return `import type { Greeting } from '${shared}'
+
+export async function fetchGreeting (name: string, request: typeof fetch = fetch): Promise<Greeting> {
+  const response = await request('/api/greeting?name=' + encodeURIComponent(name))
+
+  return await response.json() as Greeting
+}
+`;
+}
+function webGreetingClientSpec() {
+  return String.raw`import { fetchGreeting } from './greeting.client'
+
+describe('fetchGreeting', () => {
+  it('asks the API\'s greeting route for the name and returns the answer', async () => {
+    const requested: string[] = []
+    const answering = (async (input: string) => {
+      requested.push(input)
+
+      return { json: async () => ({ message: 'Hello, web!' }) } as Response
+    }) as unknown as typeof fetch
+
+    expect(await fetchGreeting('web', answering)).toEqual({ message: 'Hello, web!' })
+    expect(requested).toEqual(['/api/greeting?name=web'])
+  })
+})
+`;
+}
+function webGreetingComponent(shared) {
+  return `import { useEffect, useState } from 'react'
+import type { Greeting } from '${shared}'
+import { fetchGreeting } from './greeting.client'
+
+export interface GreetingViewProps {
+  readonly name: string
+  readonly load?: (name: string) => Promise<Greeting>
+}
+
+export function GreetingView ({ name, load = fetchGreeting }: GreetingViewProps) {
+  const [greeting, setGreeting] = useState<Greeting | undefined>()
+  const [failed, setFailed] = useState(false)
+
+  useEffect(() => {
+    void (async () => {
+      try {
+        setGreeting(await load(name))
+      } catch {
+        setFailed(true)
+      }
+    })()
+  }, [name, load])
+
+  if (failed) {
+    return <p>Could not reach the API.</p>
+  }
+
+  return <p>{greeting?.message ?? 'Loading...'}</p>
+}
+`;
+}
+function webGreetingSpec() {
+  return `import { render } from '@testing-library/react'
+
+import { GreetingView } from './greeting.component'
+
+async function answering (name: string): Promise<{ message: string }> {
+  return { message: 'Hello, ' + name + '!' }
+}
+
+async function offline (): Promise<never> {
+  throw new Error('offline')
+}
+
+describe('GreetingView', () => {
+  it('shows the greeting its loader returns for its name', async () => {
+    const { findByText } = render(<GreetingView name='world' load={answering} />)
+
+    expect(await findByText('Hello, world!')).toBeTruthy()
+  })
+
+  it('says so when the API cannot be reached', async () => {
+    const { findByText } = render(<GreetingView name='world' load={offline} />)
+
+    expect(await findByText('Could not reach the API.')).toBeTruthy()
+  })
+})
+`;
+}
+function webGreetingBarrel() {
+  return "export * from './greeting.client'\nexport * from './greeting.component'\n";
+}
+function webAppSpec() {
+  return `import { render } from '@testing-library/react'
+
+import App from './app.component'
+
+describe('App', () => {
+  it('renders, and shows that it is loading the greeting', () => {
+    const { getByText } = render(<App />)
+
+    expect(getByText('Loading...')).toBeTruthy()
+  })
+})
+`;
+}
+function withApiProxy(config, target) {
+  const start = config.indexOf("server:");
+  const end = start === -1 ? -1 : config.indexOf("},", start);
+  if (end === -1 || config.includes("proxy:")) {
+    return config;
+  }
+  const block = config.slice(start, end).trimEnd();
+  return `${config.slice(0, start)}${block}
+    proxy: { '/api': '${target}' },
+  ${config.slice(end)}`;
+}
+
+// src/workspace-presets/wire-web-api.use-case.ts
+var API_ORIGIN = "http://localhost:3000";
+function declareDependency(manifestPath, name) {
+  const manifest = readJson(manifestPath);
+  writeFileEnsured(manifestPath, toJson({ ...manifest, dependencies: { ...manifest.dependencies, [name]: "*" } }));
+}
+function removeFiles(slice, files) {
+  for (const file of files) {
+    (0, import_node_fs40.rmSync)((0, import_node_path50.join)(slice, file), { force: true });
+  }
+}
+function replaceOnce(path, anchor, replacement) {
+  const text = (0, import_node_fs40.readFileSync)(path, "utf8");
+  if (!text.includes(anchor)) {
+    throw new Error(`${path} has no ${anchor}; the generator's output changed, so the preset cannot wire it.`);
+  }
+  writeFileEnsured(path, text.replace(anchor, () => replacement));
+}
+function proxyApi(viteConfigPath) {
+  const text = (0, import_node_fs40.readFileSync)(viteConfigPath, "utf8");
+  const proxied = withApiProxy(text, API_ORIGIN);
+  if (proxied === text && !text.includes("proxy:")) {
+    throw new Error(`${viteConfigPath} has no server block to add the /api proxy to; the generator's output changed, so the preset cannot wire it.`);
+  }
+  writeFileEnsured(viteConfigPath, proxied);
+}
+function wireWebApi(workspaceRoot, projects) {
+  const sharedManifest = (0, import_node_path50.join)(workspaceRoot, "libs", projects.shared, "package.json");
+  if (!fileExists(sharedManifest)) {
+    throw new Error(`The shared library was not added at libs/${projects.shared}, so there is nothing to wire the API and the frontend to.`);
+  }
+  const shared = readJson(sharedManifest).name;
+  const api = (0, import_node_path50.join)(workspaceRoot, "apps", projects.api);
+  declareDependency((0, import_node_path50.join)(api, "package.json"), shared);
+  const hello = (0, import_node_path50.join)(api, "src", "hello");
+  writeFileEnsured((0, import_node_path50.join)(hello, "hello.handler.ts"), apiHandler(shared));
+  writeFileEnsured((0, import_node_path50.join)(hello, "hello.handler.spec.ts"), apiHandlerSpec(shared));
+  writeFileEnsured((0, import_node_path50.join)(hello, "index.ts"), apiBarrel());
+  removeFiles(hello, ["greet.use-case.ts", "greet.use-case.spec.ts", "greeting.contract.ts"]);
+  replaceOnce((0, import_node_path50.join)(api, "src", "main.ts"), "app.get('/', helloHandler)", "app.get('/api/greeting', helloHandler)");
+  const web = (0, import_node_path50.join)(workspaceRoot, "apps", projects.web);
+  declareDependency((0, import_node_path50.join)(web, "package.json"), shared);
+  const greeting = (0, import_node_path50.join)(web, "src", "greeting");
+  writeFileEnsured((0, import_node_path50.join)(greeting, "greeting.client.ts"), webGreetingClient(shared));
+  writeFileEnsured((0, import_node_path50.join)(greeting, "greeting.client.spec.ts"), webGreetingClientSpec());
+  writeFileEnsured((0, import_node_path50.join)(greeting, "greeting.component.tsx"), webGreetingComponent(shared));
+  writeFileEnsured((0, import_node_path50.join)(greeting, "greeting.component.spec.tsx"), webGreetingSpec());
+  writeFileEnsured((0, import_node_path50.join)(greeting, "index.ts"), webGreetingBarrel());
+  removeFiles(greeting, ["greet.use-case.ts", "greet.use-case.spec.ts", "greeting.contract.ts"]);
+  writeFileEnsured((0, import_node_path50.join)(web, "src", "app", "app.component.spec.tsx"), webAppSpec());
+  proxyApi((0, import_node_path50.join)(web, "vite.config.mts"));
+}
+
+// src/workspace-presets/apply-preset.use-case.ts
+function findPreset(id) {
+  const preset = PRESETS.find((candidate) => candidate.id === id);
+  if (preset === void 0) {
+    throw new Error(`Unknown preset '${id}'. Presets: ${PRESET_IDS.join(", ")}.`);
+  }
+  return preset;
+}
+function nameOf(preset, kind) {
+  const project = preset.projects.find((candidate) => candidate.kind === kind);
+  if (project === void 0) {
+    throw new Error(`The ${preset.id} preset has no ${kind}.`);
+  }
+  return project.name;
+}
+async function applyPreset(workspaceRoot, presetId, dependencies = {}) {
+  const preset = findPreset(presetId);
+  const add = dependencies.add ?? runAdd;
+  const install = dependencies.install ?? ((root) => runShell("npm", ["install", "--ignore-scripts", "--no-audit", "--no-fund"], root));
+  const sync = dependencies.sync ?? syncProjectReferences;
+  const format = dependencies.format ?? runFormatter;
+  logger.step(`Adding the ${preset.id} preset: ${preset.projects.map((project) => project.name).join(", ")}`);
+  const previous = process.cwd();
+  process.chdir(workspaceRoot);
+  try {
+    for (const project of preset.projects) {
+      await add(project.kind, project.name, project.options);
+    }
+  } finally {
+    process.chdir(previous);
+  }
+  wireWebApi(workspaceRoot, { shared: nameOf(preset, "internal-lib"), api: nameOf(preset, "node-app"), web: nameOf(preset, "react-app") });
+  if (install(workspaceRoot) !== 0) {
+    throw new Error("npm install failed after wiring the preset. Run `npm install` and read its error; the projects themselves were added.");
+  }
+  sync(workspaceRoot);
+  format(workspaceRoot);
+}
+
+// src/workspace-creation/adopt-directory.use-case.ts
+var import_node_fs41 = require("fs");
+var import_node_path51 = require("path");
 var NEVER_COPIED = /* @__PURE__ */ new Set([".git", "node_modules"]);
 var AGENT_AND_CI_ENTRIES = [
   "AGENTS.md",
@@ -10350,13 +10622,13 @@ var PREFLIGHT_BLOCKERS = [
   "packages"
 ];
 function assertAdoptableDirectory(target) {
-  if (!(0, import_node_fs40.existsSync)(target)) {
+  if (!(0, import_node_fs41.existsSync)(target)) {
     throw new Error(`--into '${target}' does not exist. Create or clone it first.`);
   }
-  if (!(0, import_node_fs40.statSync)(target).isDirectory()) {
+  if (!(0, import_node_fs41.statSync)(target).isDirectory()) {
     throw new Error(`--into '${target}' is not a directory.`);
   }
-  const blockers = PREFLIGHT_BLOCKERS.filter((entry) => (0, import_node_fs40.existsSync)((0, import_node_path50.join)(target, entry)));
+  const blockers = PREFLIGHT_BLOCKERS.filter((entry) => (0, import_node_fs41.existsSync)((0, import_node_path51.join)(target, entry)));
   if (blockers.length > 0) {
     throw new Error(
       `--into '${target}' already holds ${blockers.join(", ")}, so it is a project already. Use \`mnci upgrade\` to re-apply the overlay to an existing workspace, or point --into at an empty checkout.`
@@ -10364,15 +10636,15 @@ function assertAdoptableDirectory(target) {
   }
 }
 function mergeGitignore(generatedFile, targetFile) {
-  const existing = (0, import_node_fs40.readFileSync)(targetFile, "utf8");
+  const existing = (0, import_node_fs41.readFileSync)(targetFile, "utf8");
   const present = new Set(existing.split("\n").map((line) => line.trim()));
-  const additions = (0, import_node_fs40.readFileSync)(generatedFile, "utf8").split("\n").map((line) => line.trimEnd()).filter((line) => {
+  const additions = (0, import_node_fs41.readFileSync)(generatedFile, "utf8").split("\n").map((line) => line.trimEnd()).filter((line) => {
     const trimmed = line.trim();
     return trimmed !== "" && !trimmed.startsWith("#") && !present.has(trimmed);
   });
   if (additions.length === 0) return false;
   const separator = existing.endsWith("\n") ? "" : "\n";
-  (0, import_node_fs40.writeFileSync)(
+  (0, import_node_fs41.writeFileSync)(
     targetFile,
     `${existing}${separator}
 # Added by mnci (Nx workspace)
@@ -10382,9 +10654,9 @@ ${additions.join("\n")}
   return true;
 }
 function adoptGeneratedWorkspace(generatedRoot, target) {
-  const entries = (0, import_node_fs40.readdirSync)(generatedRoot).filter((entry) => !NEVER_COPIED.has(entry));
+  const entries = (0, import_node_fs41.readdirSync)(generatedRoot).filter((entry) => !NEVER_COPIED.has(entry));
   const collisions = entries.filter(
-    (entry) => (0, import_node_fs40.existsSync)((0, import_node_path50.join)(target, entry)) && !EXISTING_WINS.has(entry) && entry !== ".gitignore"
+    (entry) => (0, import_node_fs41.existsSync)((0, import_node_path51.join)(target, entry)) && !EXISTING_WINS.has(entry) && entry !== ".gitignore"
   );
   if (collisions.length > 0) {
     throw new Error(
@@ -10393,28 +10665,28 @@ function adoptGeneratedWorkspace(generatedRoot, target) {
   }
   const result = { copied: [], kept: [], mergedGitignore: false };
   for (const entry of entries) {
-    const from = (0, import_node_path50.join)(generatedRoot, entry);
-    const to = (0, import_node_path50.join)(target, entry);
-    if (entry === ".gitignore" && (0, import_node_fs40.existsSync)(to)) {
+    const from = (0, import_node_path51.join)(generatedRoot, entry);
+    const to = (0, import_node_path51.join)(target, entry);
+    if (entry === ".gitignore" && (0, import_node_fs41.existsSync)(to)) {
       result.mergedGitignore = mergeGitignore(from, to);
       result.kept.push(entry);
       continue;
     }
-    if ((0, import_node_fs40.existsSync)(to)) {
+    if ((0, import_node_fs41.existsSync)(to)) {
       result.kept.push(entry);
       continue;
     }
-    (0, import_node_fs40.cpSync)(from, to, { recursive: true });
+    (0, import_node_fs41.cpSync)(from, to, { recursive: true });
     result.copied.push(entry);
   }
-  (0, import_node_fs40.rmSync)(generatedRoot, { recursive: true, force: true });
+  (0, import_node_fs41.rmSync)(generatedRoot, { recursive: true, force: true });
   return result;
 }
 
 // src/workspace-creation/create-workspace.use-case.ts
-var import_node_fs41 = require("fs");
+var import_node_fs42 = require("fs");
 var import_node_os2 = require("os");
-var import_node_path51 = require("path");
+var import_node_path52 = require("path");
 function nxCloudProviderValue(ci) {
   return ci === "azure" ? "azure" : "github";
 }
@@ -10457,9 +10729,10 @@ async function resolveRegistry2(options) {
   return await promptRegistry();
 }
 async function runNew(name, options) {
-  const adoptTarget = options.into === void 0 ? void 0 : (0, import_node_path51.resolve)(process.cwd(), options.into);
+  const adoptTarget = options.into === void 0 ? void 0 : (0, import_node_path52.resolve)(process.cwd(), options.into);
   if (adoptTarget !== void 0) assertAdoptableDirectory(adoptTarget);
-  const workspaceName = name ?? (adoptTarget === void 0 ? await promptText("Workspace name") : (0, import_node_path51.basename)(adoptTarget));
+  if (options.preset !== void 0) findPreset(options.preset);
+  const workspaceName = name ?? (adoptTarget === void 0 ? await promptText("Workspace name") : (0, import_node_path52.basename)(adoptTarget));
   assertValidProjectName(workspaceName, "Workspace name");
   const scope = options.scope ?? (options.yes ? `@${workspaceName}` : await promptText("npm scope for publishable packages", `@${workspaceName}`));
   const registry = await resolveRegistry2(options);
@@ -10472,8 +10745,8 @@ async function runNew(name, options) {
   const npmAuth = resolveNpmAuth(options.npmAuth, registry, ci);
   const stack = await resolveStack(options);
   const nxCloud = options.nxCloud ?? (options.yes ? false : await promptNxCloud());
-  const stagingParent = adoptTarget === void 0 ? process.cwd() : (0, import_node_fs41.mkdtempSync)((0, import_node_path51.join)((0, import_node_os2.tmpdir)(), "mnci-new-"));
-  let workspaceRoot = (0, import_node_path51.join)(stagingParent, workspaceName);
+  const stagingParent = adoptTarget === void 0 ? process.cwd() : (0, import_node_fs42.mkdtempSync)((0, import_node_path52.join)((0, import_node_os2.tmpdir)(), "mnci-new-"));
+  let workspaceRoot = (0, import_node_path52.join)(stagingParent, workspaceName);
   try {
     logger.step(`Creating Nx workspace '${workspaceName}' (preset: ts)`);
     runNpx(
@@ -10496,7 +10769,7 @@ async function runNew(name, options) {
       workspaceRoot = adoptTarget;
     }
   } finally {
-    if (adoptTarget !== void 0) (0, import_node_fs41.rmSync)(stagingParent, { recursive: true, force: true });
+    if (adoptTarget !== void 0) (0, import_node_fs42.rmSync)(stagingParent, { recursive: true, force: true });
   }
   logger.step(
     "Applying MoNecromanCI overlay (VS Code workspace, release config, .npmrc, commitlint, pipeline, stack)"
@@ -10506,8 +10779,8 @@ async function runNew(name, options) {
     { workspaceName, scope, registry, agent, variableGroup, ci, stack, ...npmAuth && { npmAuth } },
     logger.detail
   );
-  (0, import_node_fs41.rmSync)((0, import_node_path51.join)(workspaceRoot, "node_modules"), { recursive: true, force: true });
-  (0, import_node_fs41.rmSync)((0, import_node_path51.join)(workspaceRoot, "package-lock.json"), { force: true });
+  (0, import_node_fs42.rmSync)((0, import_node_path52.join)(workspaceRoot, "node_modules"), { recursive: true, force: true });
+  (0, import_node_fs42.rmSync)((0, import_node_path52.join)(workspaceRoot, "package-lock.json"), { force: true });
   logger.step("Installing the toolchain (commitlint + husky + linting/formatting)");
   const installStatus = runShell(
     "npm",
@@ -10520,6 +10793,9 @@ async function runNew(name, options) {
   runShell("npx", ["husky"], workspaceRoot);
   logger.step("Formatting the workspace (eslint --fix, JavaScript Standard Style)");
   runFormatter(workspaceRoot);
+  if (options.preset !== void 0) {
+    await applyPreset(workspaceRoot, options.preset);
+  }
   logger.success("Done. Next steps:");
   if (adoptTarget === void 0) logger.info(`  cd ${workspaceName}`);
   for (const line of projectKindHintLines()) {
@@ -10557,6 +10833,8 @@ function buildProgram(cliVersion) {
   ).addOption(new import_commander.Option("--ci <provider>", "CI provider").choices(["azure", "github", "both"])).option("--test-runner <runner>", "unit-test runner: jest | vitest").option("--nx-cloud", "connect the workspace to Nx Cloud (remote caching + CI insights)").option(
     "--into <dir>",
     "bootstrap into an existing directory (a fresh clone holding only .git); the directory name is the workspace name unless one is given"
+  ).addOption(
+    new import_commander.Option("--preset <preset>", "also scaffold a whole shape of workspace, its projects wired together (web-api: a React frontend and an Express API sharing one library)").choices(PRESET_IDS)
   ).action(async (name, options) => {
     await runNew(name, options);
   });