@mnci/cli 1.12.0 → 1.12.2

package/README.md

@@ -15,14 +15,14 @@ config package, a custom CI engine, a dependency-injection step for published
 packages, a doctor/drift-sync system to keep it all consistent — already has a
 first-party (or established community) Nx equivalent:
 
-| Hand-rolled elsewhere                      | This CLI uses instead                                                       |
-| ------------------------------------------ | --------------------------------------------------------------------------- |
-| Template engine + per-project config files | `create-nx-workspace --preset=ts` + `nx g` plugin generators                |
-| A shared toolchain package for configs     | The configs the Nx generators emit (one root ESLint/tsconfig)               |
-| A custom multi-step CI engine              | `nx affected -t lint,test,build` + `nx release` (~60-line pipeline)         |
-| A dist-package dependency injector         | `nx release` updates dependent versions natively                            |
-| Hand-written Azure Function templates      | `@nx/node:application` (plain Node app) + a thin Azure Functions v4 overlay |
-| doctor/drift sync of tool-owned files      | Nothing to drift: this CLI owns 5 small files, Nx owns the rest             |
+| Hand-rolled elsewhere                      | This CLI uses instead                                                         |
+| ------------------------------------------ | ----------------------------------------------------------------------------- |
+| Template engine + per-project config files | `create-nx-workspace --preset=ts` + `nx g` plugin generators                  |
+| A shared toolchain package for configs     | The configs the Nx generators emit (one root ESLint/tsconfig)                 |
+| A custom multi-step CI engine              | `nx affected -t lint,typecheck,test,build` + `nx release` (~60-line pipeline) |
+| A dist-package dependency injector         | `nx release` updates dependent versions natively                              |
+| Hand-written Azure Function templates      | `@nx/node:application` (plain Node app) + a thin Azure Functions v4 overlay   |
+| doctor/drift sync of tool-owned files      | Nothing to drift: this CLI owns 5 small files, Nx owns the rest               |
 
 ## Commands (deliberately just three)
 
@@ -69,7 +69,8 @@ each a single cross-platform command:
 | `npm run build`           | `nx run-many -t build`                                                                                                                |
 | `npm run lint`            | `nx run-many -t lint`                                                                                                                 |
 | `npm run test`            | `nx run-many -t test`                                                                                                                 |
-| `npm run affected`        | `nx affected -t lint,test,build` (vs `main`)                                                                                          |
+| `npm run typecheck`       | `nx run-many -t typecheck` — its own script because a bundler-built project's `build` strips types without reading them               |
+| `npm run affected`        | `nx affected -t lint,typecheck,test,build` (vs `main`)                                                                                |
 | `npm run graph`           | `nx graph`                                                                                                                            |
 | `npm run release:preview` | `nx release --dry-run`                                                                                                                |
 | `npm run python:install`  | fixed Python toolchain (ruff/pytest/build/twine) + editable-install every Python project — the same two guards CI runs, for local dev |
@@ -146,9 +147,17 @@ same options `new` would have and calls the exact same `applyOverlay` `new`
 itself calls — the one function that does every bit of `mnci`-owned file
 writing (`nx.json`'s `release`/`sync`/`generators`/`mnci` blocks, `.npmrc`,
 `eslint.config.mjs`, `.prettierrc.json`, `commitlint.config.mjs`,
-`.husky/commit-msg`, the CI pipeline file(s), and the curated root
-`package.json` scripts). Nothing else in the workspace — app/lib source,
-`project.json` targets from `mnci add` — is ever touched.
+`.husky/commit-msg`, the CI pipeline file(s), the
+`<workspace-name>.code-workspace` file, and the curated root `package.json`
+scripts). Nothing else in the workspace — app/lib source, `project.json` targets
+from `mnci add` — is ever touched, and it finishes by running Prettier over the
+result, the same way `new` and every `add` do.
+
+The `.code-workspace` file is the one partial case, and deliberately so: its
+folders, settings and extensions are regenerated, but the **`tasks` array is read
+back and carried through unchanged**. Those tasks are per-project state written by
+`mnci add`, not overlay-owned, so regenerating them wholesale would wipe every
+project's build/qa/start entry on upgrade.
 
 `upgrade` also **deletes** things, which is stronger than the overwriting it
 has always done — one more reason to run `git diff` first, as the command's own

package/dist/cli.js

@@ -150,6 +150,13 @@ var import_node_path = require("path");
 function readJson(path) {
   return JSON.parse((0, import_node_fs.readFileSync)(path, "utf8"));
 }
+function readCodeWorkspace(path) {
+  try {
+    return JSON.parse((0, import_node_fs.readFileSync)(path, "utf8").replaceAll(/,(\s*[}\]])/g, "$1"));
+  } catch {
+    return void 0;
+  }
+}
 function toJson(value) {
   return `${JSON.stringify(value, void 0, 2)}
 `;
@@ -234,10 +241,6 @@ function findCodeWorkspaceFile(workspaceRoot) {
     return void 0;
   }
 }
-function readCodeWorkspaceFile(path) {
-  const contents = (0, import_node_fs2.readFileSync)(path, "utf8").replaceAll(/,(\s*[}\]])/g, "$1");
-  return JSON.parse(contents);
-}
 function projectTask(name, kind) {
   const script = `${name}:${kind}`;
   const base = { label: `${name}: ${kind}`, type: "npm", script, problemMatcher: [] };
@@ -264,7 +267,7 @@ function registerProjectCommands(workspaceRoot, name, commands) {
   if (!codeWorkspacePath) {
     return;
   }
-  const workspaceFile = readCodeWorkspaceFile(codeWorkspacePath);
+  const workspaceFile = readCodeWorkspace(codeWorkspacePath) ?? {};
   const label = (task) => task.label ?? "";
   const existingTasks = (workspaceFile.tasks?.tasks ?? []).filter(
     (task) => !label(task).startsWith(`${name}: `)
@@ -1276,7 +1279,7 @@ __pycache__
 .ruff_cache
 .dart_tool
 `;
-function vscodeWorkspace(workspaceName) {
+function vscodeWorkspace(workspaceName, existingTasks) {
   return JSON.stringify(
     {
       folders: [{ path: ".", name: workspaceName }],
@@ -1314,7 +1317,10 @@ function vscodeWorkspace(workspaceName) {
           "firsttris.vscode-jest-runner"
         ]
       },
-      tasks: { version: "2.0.0", tasks: [] }
+      tasks: {
+        version: existingTasks?.version ?? "2.0.0",
+        tasks: existingTasks?.tasks ?? []
+      }
     },
     null,
     2
@@ -1324,7 +1330,8 @@ var ROOT_SCRIPTS = {
   build: "nx run-many -t build",
   lint: "nx run-many -t lint",
   test: "nx run-many -t test",
-  affected: "nx affected -t lint,test,build",
+  typecheck: "nx run-many -t typecheck",
+  affected: "nx affected -t lint,typecheck,test,build",
   graph: "nx graph",
   "release:preview": "nx release --dry-run",
   prepare: "husky"
@@ -1356,6 +1363,12 @@ function generatorDefaults(stack) {
 }
 function mnciConfig(options) {
   return {
+    // Persisted so `mnci upgrade` can name the `<name>.code-workspace` file it
+    // rewrites. Its absence is why upgrade used to write a file literally called
+    // `undefined.code-workspace` and therefore never refreshed the real one —
+    // see `resolveWorkspaceName` in `commands/upgrade.ts`, which still needs a
+    // fallback chain for workspaces generated before this field existed.
+    workspaceName: options.workspaceName,
     scope: options.scope,
     registry: options.registry,
     agent: options.agent,
@@ -1542,10 +1555,14 @@ steps:
     displayName: Check formatting (run 'npm run format' locally to fix)
   # \`lint\` here also runs any Nx lint targets \`npm run lint\` does not cover \u2014
   # notably Python's ruff (every Python project owns a hand-authored \`lint\`
-  # target). For the eslint stack the JS lint runs twice, but Nx caches the
-  # repeat instantly.
-  - script: npx nx run-many -t lint,test,build
-    displayName: Lint, test and build everything
+  # target). The JS lint runs twice, but Nx caches the repeat instantly.
+  #
+  # \`typecheck\` is load-bearing and not covered by \`build\`: a bundler-built
+  # project (esbuild, swc) strips types without reading them, so a workspace can
+  # build, test and lint green while carrying real type errors. --preset=ts
+  # infers a typecheck target for every project, so this costs one target name.
+  - script: npx nx run-many -t lint,typecheck,test,build
+    displayName: Lint, typecheck, test and build everything
 
   # Pack every app into dist/drop/<type>-<name>.zip via each app's 'package'
   # target. Portable guard: skip cleanly when the workspace has no apps yet.
@@ -1720,10 +1737,15 @@ jobs:
         name: Check formatting (run 'npm run format' locally to fix)
       # \`lint\` here also runs any Nx lint targets \`npm run lint\` does not cover \u2014
       # notably Python's ruff (every Python project owns a hand-authored \`lint\`
-      # target). For the eslint stack the JS lint runs twice, but Nx caches the
-      # repeat instantly.
-      - run: npx nx run-many -t lint,test,build
-        name: Lint, test and build everything
+      # target). The JS lint runs twice, but Nx caches the repeat instantly.
+      #
+      # \`typecheck\` is load-bearing and not covered by \`build\`: a bundler-built
+      # project (esbuild, swc) strips types without reading them, so a workspace
+      # can build, test and lint green while carrying real type errors.
+      # --preset=ts infers a typecheck target for every project, so this costs
+      # one target name.
+      - run: npx nx run-many -t lint,typecheck,test,build
+        name: Lint, typecheck, test and build everything
 
       # Pack every app into dist/drop/<type>-<name>.zip via each app's 'package'
       # target. Portable guard: skip cleanly when the workspace has no apps yet.
@@ -1856,10 +1878,12 @@ function applyOverlay(workspaceRoot, options) {
   writeFileEnsured((0, import_node_path10.join)(workspaceRoot, ".prettierrc.json"), PRETTIER_CONFIG);
   writeFileEnsured((0, import_node_path10.join)(workspaceRoot, ".prettierignore"), PRETTIER_IGNORE);
   removeNxScaffolding(workspaceRoot);
-  writeFileEnsured(
-    (0, import_node_path10.join)(workspaceRoot, `${options.workspaceName}.code-workspace`),
-    vscodeWorkspace(options.workspaceName)
-  );
+  const codeWorkspacePath = (0, import_node_path10.join)(workspaceRoot, `${options.workspaceName}.code-workspace`);
+  const existing = readCodeWorkspace(codeWorkspacePath);
+  writeFileEnsured(codeWorkspacePath, vscodeWorkspace(options.workspaceName, existing?.tasks));
+  if (options.workspaceName !== "undefined") {
+    (0, import_node_fs6.rmSync)((0, import_node_path10.join)(workspaceRoot, "undefined.code-workspace"), { force: true });
+  }
   const publishUrl = pythonPublishUrl(options.registry);
   if (options.ci === "azure" || options.ci === "both") {
     writeFileEnsured(
@@ -1976,6 +2000,7 @@ async function runNew(name, options) {
 }
 
 // src/commands/upgrade.ts
+var import_node_fs7 = require("fs");
 var import_node_path12 = require("path");
 function resolveRegistry2(options, persisted) {
   if (options.registry === "azure-artifacts" || options.organization && options.artifactsFeed) {
@@ -2000,7 +2025,22 @@ function resolveRegistry2(options, persisted) {
     "No registry found in nx.json's persisted config. Pass --registry npm or --registry azure-artifacts (with --organization/--project/--artifacts-feed)."
   );
 }
-function resolveOverlayOptions(options, persisted) {
+function resolveWorkspaceName(workspaceRoot, persisted) {
+  if (persisted.workspaceName) {
+    return persisted.workspaceName;
+  }
+  try {
+    const existing = (0, import_node_fs7.readdirSync)(workspaceRoot).find(
+      (file) => file.endsWith(".code-workspace") && file !== "undefined.code-workspace"
+    );
+    if (existing) {
+      return existing.replace(/\.code-workspace$/, "");
+    }
+  } catch {
+  }
+  return (0, import_node_path12.basename)(workspaceRoot);
+}
+function resolveOverlayOptions(workspaceRoot, options, persisted) {
   const scope = options.scope ?? persisted.scope;
   if (!scope) {
     throw new Error("No npm scope found in nx.json's persisted config. Pass --scope explicitly.");
@@ -2025,7 +2065,15 @@ function resolveOverlayOptions(options, persisted) {
       "No testRunner found in nx.json's persisted config. Pass --test-runner explicitly."
     );
   }
-  return { scope, registry, agent, variableGroup, ci, stack: { testRunner } };
+  return {
+    workspaceName: resolveWorkspaceName(workspaceRoot, persisted),
+    scope,
+    registry,
+    agent,
+    variableGroup,
+    ci,
+    stack: { testRunner }
+  };
 }
 function runUpgrade(workspaceRoot, options) {
   if (!fileExists((0, import_node_path12.join)(workspaceRoot, "nx.json"))) {
@@ -2034,11 +2082,12 @@ function runUpgrade(workspaceRoot, options) {
     );
   }
   const persisted = readMnciConfig(workspaceRoot);
-  const resolved = resolveOverlayOptions(options, persisted);
+  const resolved = resolveOverlayOptions(workspaceRoot, options, persisted);
   logger.step(
     "Re-applying the MoNecromanCI overlay (release config, .npmrc, commitlint, pipeline, stack)"
   );
   applyOverlay(workspaceRoot, resolved);
+  runPrettier(workspaceRoot);
   logger.success("Done. Review the changes with `git diff` before committing.");
 }
 
@@ -2065,7 +2114,7 @@ async function runInteractive() {
 }
 
 // src/util/versionChecker.ts
-var import_node_fs7 = require("fs");
+var import_node_fs8 = require("fs");
 var import_node_path14 = require("path");
 var import_cross_spawn2 = __toESM(require("cross-spawn"));
 var PACKAGE_NAME = "@mnci/cli";
@@ -2123,7 +2172,7 @@ function releaseTriple(version) {
 function readCliVersion(packageDirectory) {
   try {
     const manifestPath = (0, import_node_path14.join)(packageDirectory, "..", "package.json");
-    const manifest = JSON.parse((0, import_node_fs7.readFileSync)(manifestPath, "utf8"));
+    const manifest = JSON.parse((0, import_node_fs8.readFileSync)(manifestPath, "utf8"));
     return manifest.version ?? "0.0.0";
   } catch {
     return "0.0.0";