@mnci/cli 4.23.1 → 4.25.0

package/README.md

@@ -87,6 +87,7 @@ cd my-repo
 mnci add react-app web         # @nx/react (Vite + Jest)
 mnci add node-app svc          # @nx/node (plain Node app, esbuild)
 mnci add node-app api --framework express  # ...or fastify | koa | nest
+mnci add npm-lib core --empty             # slice skeleton only, no sample (also internal-lib, react-lib, react-internal-lib)
 mnci add node-function-app api # @nx/node + an Azure Functions v4 overlay
 mnci add npm-lib sdk           # @nx/js publishable lib -> packages/
 mnci add internal-lib utils    # @nx/js private lib -> libs/

package/dist/cli.js

@@ -2672,11 +2672,11 @@ function projectTask(name, kind) {
   const base = { label: `${name}: ${kind}`, type: "npm", script, problemMatcher: [] };
   return kind === "start" ? { ...base, isBackground: true } : { ...base, group: kind };
 }
-function renameScaffoldPlaceholder(projectRoot, name) {
-  reshapeScaffoldSlice(projectRoot, name, "ts", "use-case");
+function renameScaffoldPlaceholder(projectRoot, name, empty = false) {
+  reshapeScaffoldSlice(projectRoot, name, "ts", "use-case", empty);
 }
-function reshapeReactScaffold(projectRoot, name) {
-  reshapeScaffoldSlice(projectRoot, name, "tsx", "component");
+function reshapeReactScaffold(projectRoot, name, empty = false) {
+  reshapeScaffoldSlice(projectRoot, name, "tsx", "component", empty);
 }
 function reshapeReactAppScaffold(projectRoot) {
   const appDir = (0, import_node_path5.join)(projectRoot, "src", "app");
@@ -2705,7 +2705,14 @@ function reshapeReactAppScaffold(projectRoot) {
     "export * from './app.component'\nexport { default } from './app.component'\n"
   );
 }
-function reshapeScaffoldSlice(projectRoot, name, extension, role) {
+function emptySlice(projectRoot, sliceDir) {
+  for (const entry of (0, import_node_fs5.readdirSync)(sliceDir)) {
+    (0, import_node_fs5.rmSync)((0, import_node_path5.join)(sliceDir, entry), { recursive: true, force: true });
+  }
+  writeFileEnsured((0, import_node_path5.join)(sliceDir, "index.ts"), "export {}\n");
+  addNxTargets((0, import_node_path5.join)(projectRoot, "package.json"), { test: { options: { passWithNoTests: true } } });
+}
+function reshapeScaffoldSlice(projectRoot, name, extension, role, empty) {
   const sourceDir = (0, import_node_path5.join)(projectRoot, "src");
   const libDir = (0, import_node_path5.join)(sourceDir, "lib");
   if (!(0, import_node_fs5.existsSync)((0, import_node_path5.join)(libDir, `${name}.${extension}`))) {
@@ -2735,6 +2742,58 @@ function reshapeScaffoldSlice(projectRoot, name, extension, role) {
     );
   }
   (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;
@@ -4450,7 +4509,7 @@ async function addNpmLib(workspaceRoot, name, options, kindProvided, stack) {
       repairPublishableManifest(manifestPath);
       repairDeclarationSpecifiers(projectRoot);
       writeProjectReadme(projectRoot, `${scope}/${name}`, stack.testRunner);
-      renameScaffoldPlaceholder(projectRoot, name);
+      renameScaffoldPlaceholder(projectRoot, name, options.empty === true);
       removeGeneratedEslintConfig(workspaceRoot, `packages/${name}`);
       removeLocalRegistryScaffolding(workspaceRoot);
       registerProjectCommands(workspaceRoot, name, { build: true });
@@ -4799,14 +4858,14 @@ async function addReactLib(workspaceRoot, name, options, kindProvided, stack) {
       repairPublishableManifest(publishableManifest);
       repairDeclarationSpecifiers(projectRoot);
       writeProjectReadme(projectRoot, `${scope}/${name}`, stack.testRunner);
-      reshapeReactScaffold(projectRoot, name);
+      reshapeReactScaffold(projectRoot, name, options.empty === true);
       removeGeneratedEslintConfig(workspaceRoot, `packages/${name}`);
       removeLocalRegistryScaffolding(workspaceRoot);
       registerProjectCommands(workspaceRoot, name, { build: true });
     }
   );
 }
-function addReactInternalLib(workspaceRoot, name, stack) {
+function addReactInternalLib(workspaceRoot, name, stack, empty = false) {
   ensurePlugin(workspaceRoot, "@nx/react");
   const projectRoot = (0, import_node_path19.join)(workspaceRoot, "libs", name);
   const privateManifest = (0, import_node_path19.join)(projectRoot, "package.json");
@@ -4828,7 +4887,7 @@ function addReactInternalLib(workspaceRoot, name, stack) {
       repairPublishableManifest(privateManifest);
       repairDeclarationSpecifiers(projectRoot);
       writeProjectReadme(projectRoot, name, stack.testRunner);
-      reshapeReactScaffold(projectRoot, name);
+      reshapeReactScaffold(projectRoot, name, empty);
       removeGeneratedEslintConfig(workspaceRoot, `libs/${name}`);
       registerProjectCommands(workspaceRoot, name, { build: true });
     }
@@ -6483,6 +6542,7 @@ var PROJECT_KINDS = [
   "csharp-internal-lib",
   "vscode-extension"
 ];
+var EMPTY_KINDS = /* @__PURE__ */ new Set(["npm-lib", "internal-lib", "react-lib", "react-internal-lib"]);
 async function runAdd(kind, name, options) {
   const workspaceRoot = process.cwd();
   if (!fileExists((0, import_node_path25.join)(workspaceRoot, "nx.json"))) {
@@ -6503,6 +6563,9 @@ async function runAdd(kind, name, options) {
       throw new Error(`${flag} applies to go-app only, not ${resolvedKind}.`);
     }
   }
+  if (options.empty === true && !EMPTY_KINDS.has(resolvedKind)) {
+    throw new Error(`--empty applies to ${[...EMPTY_KINDS].join(", ")}, not ${resolvedKind}.`);
+  }
   const resolvedName = name ?? await promptText("Project name");
   assertValidProjectName(resolvedName, "Project name");
   const rootDependenciesBefore = rootRuntimeDependencies(workspaceRoot);
@@ -6517,7 +6580,7 @@ async function runAdd(kind, name, options) {
       break;
     }
     case "react-internal-lib": {
-      addReactInternalLib(workspaceRoot, resolvedName, stack);
+      addReactInternalLib(workspaceRoot, resolvedName, stack, options.empty === true);
       break;
     }
     case "node-app": {
@@ -6546,7 +6609,7 @@ async function runAdd(kind, name, options) {
         workspaceRoot
       );
       markPrivate((0, import_node_path25.join)(workspaceRoot, "libs", resolvedName, "package.json"));
-      renameScaffoldPlaceholder((0, import_node_path25.join)(workspaceRoot, "libs", resolvedName), resolvedName);
+      renameScaffoldPlaceholder((0, import_node_path25.join)(workspaceRoot, "libs", resolvedName), resolvedName, options.empty === true);
       removeGeneratedEslintConfig(workspaceRoot, `libs/${resolvedName}`);
       registerProjectCommands(workspaceRoot, resolvedName, { build: true });
       break;
@@ -7641,6 +7704,9 @@ function buildProgram(cliVersion) {
   program.command("add").addArgument(new import_commander.Argument("[kind]", "project kind").choices(PROJECT_KINDS)).argument("[name]", "project name").description("Add a project by delegating to the matching Nx plugin generator").option("--scope <scope>", "npm scope for a publishable lib (defaults to @<workspace name>)").option(
     "--framework <framework>",
     "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"
   ).option(
     "--lib <name>",
     "python-vendor only: the internal Python library (libs/<name>) to vendor into <name>"