@mnci/cli 4.24.0 → 4.26.0

package/README.md

@@ -1336,7 +1336,7 @@ already use:
 - **`node-function-app` overlay**: `@azure/functions` is installed for real
   (a plain `@nx/node:application` app has no Azure dependency by default,
   unlike a plugin-generated one), an HTTP-triggered `app.http(...)` sample
-  (v4 programming model) is written as a `src/hello/` slice (`hello.handler.ts` plus a pure `greeting.algorithm.ts` and its spec, behind an `index.ts`), `host.json` is
+  (v4 programming model) is written as a `src/hello/` slice (`hello.handler.ts` adapting the transport, `greet.use-case.ts` and its spec, `greeting.contract.ts`, behind an `index.ts`; `--empty` skips the slice), `host.json` is
   added, and the manifest is repaired — `main: 'main.js'` (the dist shim) and
   `@azure/functions` added to `dependencies` for Azure's deploy-time install
   to find.

package/dist/cli.js

@@ -2744,8 +2744,57 @@ function reshapeScaffoldSlice(projectRoot, name, extension, role, empty) {
   (0, import_node_fs5.rmSync)(libDir, { recursive: true, force: true });
   if (empty) {
     emptySlice(projectRoot, sliceDir);
+  } else if (role === "use-case") {
+    writeWorkedExample(sliceDir, name, esm);
   }
 }
+function writeWorkedExample(sliceDir, name, esm) {
+  const suffix = esm ? ".js" : "";
+  writeFileEnsured(
+    (0, import_node_path5.join)(sliceDir, `${name}.contract.ts`),
+    `/** What greeting someone returns. */
+export interface Greeting {
+  readonly message: string
+}
+`
+  );
+  writeFileEnsured(
+    (0, import_node_path5.join)(sliceDir, `${name}.use-case.ts`),
+    `import type { Greeting } from './${name}.contract${suffix}'
+
+/**
+ * Greets someone by name.
+ *
+ * @remarks
+ * A worked example of a use case: one outcome, returning a contract. Replace it
+ * with your own.
+ *
+ * @param name - Who to greet.
+ * @returns The greeting.
+ */
+export function greet (name: string): Greeting {
+  return { message: 'Hello, ' + name + '!' }
+}
+`
+  );
+  writeFileEnsured(
+    (0, import_node_path5.join)(sliceDir, `${name}.use-case.spec.ts`),
+    `import { greet } from './${name}.use-case${suffix}'
+
+describe('greet', () => {
+  it('greets by name', () => {
+    expect(greet('world')).toEqual({ message: 'Hello, world!' })
+  })
+})
+`
+  );
+  writeFileEnsured(
+    (0, import_node_path5.join)(sliceDir, "index.ts"),
+    `export * from './${name}.contract${suffix}'
+export * from './${name}.use-case${suffix}'
+`
+  );
+}
 function repointSpecifier(source, from, to) {
   let result = source;
   for (const quote of ["'", '"']) {
@@ -4017,6 +4066,10 @@ var NODE_FUNCTION_APP_MAIN = `// esbuild only includes what is reachable from he
 // function slice you create under src/ (through its index).
 import './hello'
 `;
+var NODE_FUNCTION_APP_MAIN_EMPTY = `// esbuild only includes what is reachable from here, so import each function slice
+// you create under src/ (through its index).
+export {}
+`;
 var NODE_FUNCTION_APP_HOST_JSON = `{
   "version": "2.0",
   "extensionBundle": {
@@ -4027,11 +4080,11 @@ var NODE_FUNCTION_APP_HOST_JSON = `{
 `;
 var NODE_FUNCTION_APP_HELLO = `import { app } from '@azure/functions'
 import type { HttpRequest, HttpResponseInit } from '@azure/functions'
-import { buildGreeting } from './greeting.algorithm'
+import { greet } from './greet.use-case'
 
 async function hello(request: HttpRequest): Promise<HttpResponseInit> {
   const name = request.query.get('name') ?? 'world'
-  return { body: buildGreeting(name) }
+  return { body: greet(name).message }
 }
 
 app.http('hello', {
@@ -4043,15 +4096,22 @@ app.http('hello', {
 `;
 var NODE_FUNCTION_APP_HELLO_BARREL = `export * from './hello.handler'
 `;
-var NODE_FUNCTION_APP_GREETING = `export function buildGreeting (name: string): string {
-  return 'Hello, ' + name + '!'
+var NODE_FUNCTION_APP_GREETING_CONTRACT = `/** What greeting someone returns. */
+export interface Greeting {
+  readonly message: string
+}
+`;
+var NODE_FUNCTION_APP_GREET_USE_CASE = `import type { Greeting } from './greeting.contract'
+
+export function greet (name: string): Greeting {
+  return { message: 'Hello, ' + name + '!' }
 }
 `;
-var NODE_FUNCTION_APP_GREETING_SPEC = `import { buildGreeting } from './greeting.algorithm'
+var NODE_FUNCTION_APP_GREET_SPEC = `import { greet } from './greet.use-case'
 
-describe('buildGreeting', () => {
+describe('greet', () => {
   it('greets a name', () => {
-    expect(buildGreeting('world')).toBe('Hello, world!')
+    expect(greet('world')).toEqual({ message: 'Hello, world!' })
   })
 })
 `;
@@ -4099,22 +4159,28 @@ function nodeFunctionAppStartTarget(name) {
     options: { command: "func start", cwd: `apps/${name}` }
   };
 }
-function addNodeFunctionApp(workspaceRoot, name, stack) {
+function addNodeFunctionApp(workspaceRoot, name, stack, empty = false) {
   runNodeApp(workspaceRoot, name, stack, "none");
   ensureAzureFunctionsPackage(workspaceRoot);
   const nodeFunctionAppRoot = (0, import_node_path12.join)(workspaceRoot, "apps", name);
-  writeFileEnsured((0, import_node_path12.join)(nodeFunctionAppRoot, "src/main.ts"), NODE_FUNCTION_APP_MAIN);
-  writeFileEnsured((0, import_node_path12.join)(nodeFunctionAppRoot, "src/hello/hello.handler.ts"), NODE_FUNCTION_APP_HELLO);
-  writeFileEnsured((0, import_node_path12.join)(nodeFunctionAppRoot, "src/hello/greeting.algorithm.ts"), NODE_FUNCTION_APP_GREETING);
-  writeFileEnsured((0, import_node_path12.join)(nodeFunctionAppRoot, "src/hello/greeting.algorithm.spec.ts"), NODE_FUNCTION_APP_GREETING_SPEC);
-  writeFileEnsured((0, import_node_path12.join)(nodeFunctionAppRoot, "src/hello/index.ts"), NODE_FUNCTION_APP_HELLO_BARREL);
+  writeFileEnsured((0, import_node_path12.join)(nodeFunctionAppRoot, "src/main.ts"), empty ? NODE_FUNCTION_APP_MAIN_EMPTY : NODE_FUNCTION_APP_MAIN);
+  if (!empty) {
+    const slice = (0, import_node_path12.join)(nodeFunctionAppRoot, "src/hello");
+    writeFileEnsured((0, import_node_path12.join)(slice, "hello.handler.ts"), NODE_FUNCTION_APP_HELLO);
+    writeFileEnsured((0, import_node_path12.join)(slice, "greet.use-case.ts"), NODE_FUNCTION_APP_GREET_USE_CASE);
+    writeFileEnsured((0, import_node_path12.join)(slice, "greet.use-case.spec.ts"), NODE_FUNCTION_APP_GREET_SPEC);
+    writeFileEnsured((0, import_node_path12.join)(slice, "greeting.contract.ts"), NODE_FUNCTION_APP_GREETING_CONTRACT);
+    writeFileEnsured((0, import_node_path12.join)(slice, "index.ts"), NODE_FUNCTION_APP_HELLO_BARREL);
+  }
   writeFileEnsured((0, import_node_path12.join)(nodeFunctionAppRoot, "host.json"), NODE_FUNCTION_APP_HOST_JSON);
   repairNodeFunctionAppManifest(nodeFunctionAppRoot, workspaceRoot);
   ensureAdmZip(workspaceRoot);
   addNxTargets((0, import_node_path12.join)(nodeFunctionAppRoot, "package.json"), {
     package: nodeFunctionAppPackageTarget(name),
     prune: nodeFunctionAppPruneTarget(name),
-    start: nodeFunctionAppStartTarget(name)
+    start: nodeFunctionAppStartTarget(name),
+    // With no spec the runner exits non-zero; an empty scaffold must still pass `nx test`.
+    ...empty && { test: { options: { passWithNoTests: true } } }
   });
   removeGeneratedEslintConfig(workspaceRoot, `apps/${name}`);
   registerProjectCommands(workspaceRoot, name, { build: true, start: `nx run ${name}:start` });
@@ -6493,7 +6559,7 @@ var PROJECT_KINDS = [
   "csharp-internal-lib",
   "vscode-extension"
 ];
-var EMPTY_KINDS = /* @__PURE__ */ new Set(["npm-lib", "internal-lib", "react-lib", "react-internal-lib"]);
+var EMPTY_KINDS = /* @__PURE__ */ new Set(["npm-lib", "internal-lib", "react-lib", "react-internal-lib", "node-function-app"]);
 async function runAdd(kind, name, options) {
   const workspaceRoot = process.cwd();
   if (!fileExists((0, import_node_path25.join)(workspaceRoot, "nx.json"))) {
@@ -6539,7 +6605,7 @@ async function runAdd(kind, name, options) {
       break;
     }
     case "node-function-app": {
-      addNodeFunctionApp(workspaceRoot, resolvedName, stack);
+      addNodeFunctionApp(workspaceRoot, resolvedName, stack, options.empty === true);
       break;
     }
     case "npm-lib": {
@@ -7657,7 +7723,7 @@ function buildProgram(cliVersion) {
     "node-app only: express | fastify | koa | nest | none (default: none)"
   ).option(
     "--empty",
-    "npm-lib, internal-lib, react-lib, react-internal-lib: scaffold the slice skeleton only, with no sample code or spec"
+    "npm-lib, internal-lib, react-lib, react-internal-lib, node-function-app: scaffold the slice skeleton only, with no sample code or spec"
   ).option(
     "--lib <name>",
     "python-vendor only: the internal Python library (libs/<name>) to vendor into <name>"