@mnci/cli 4.0.3 → 4.0.5

package/dist/cli.js

@@ -52,6 +52,16 @@ var logger = {
   step(message) {
     console.log(`\u2192 ${message}`);
   },
+  /**
+   * A sub-step under the most recent {@link logger.step}, indented to read as detail.
+   *
+   * `this: void` because this one is handed to `applyOverlay` as a progress callback,
+   * detached from the object. It reads no instance state, and the annotation is what
+   * says so — without it every such call is an unbound-method error.
+   */
+  detail(message) {
+    console.log(`   \xB7 ${message}`);
+  },
   success(message) {
     console.log(`\u2713 ${message}`);
   },
@@ -1630,14 +1640,15 @@ function launchConfigurations(workspaceName) {
     presentation: { group: "mnci", order: index + 1 }
   }));
 }
-function vscodeWorkspace(workspaceName, existingTasks, existingLaunch) {
+function vscodeWorkspace(workspaceName, existingTasks, existingLaunch, existingSettings) {
   const userConfigurations = (existingLaunch?.configurations ?? []).filter(
     (configuration) => !String(configuration.name ?? "").startsWith(LAUNCH_CONFIG_PREFIX)
   );
+  const settings = { ...existingSettings, ...vscodeSettings() };
   return JSON.stringify(
     {
       folders: [{ path: ".", name: workspaceName }],
-      settings: vscodeSettings(),
+      settings,
       extensions: { recommendations: VSCODE_RECOMMENDED_EXTENSIONS },
       tasks: {
         version: existingTasks?.version ?? "2.0.0",
@@ -2234,7 +2245,8 @@ function removeProjectEslintConfigs(workspaceRoot) {
     (0, import_node_fs6.rmSync)((0, import_node_path11.join)(workspaceRoot, match), { force: true });
   }
 }
-function applyOverlay(workspaceRoot, options) {
+function applyOverlay(workspaceRoot, options, onProgress = () => {
+}) {
   const nxJsonPath = (0, import_node_path11.join)(workspaceRoot, "nx.json");
   const nxJson = readJson(nxJsonPath);
   const generators = {
@@ -2244,7 +2256,9 @@ function applyOverlay(workspaceRoot, options) {
   const sync = { ...nxJson.sync, ...SYNC_CONFIG };
   const mnci = { ...nxJson.mnci, ...mnciConfig(options) };
   const patched = withSharedGlobals(withEslintPlugin(withReleaseConfig(nxJson, options.ci)));
+  onProgress("nx.json \u2014 release, sync, generators, shared inputs, mnci block");
   writeFileEnsured(nxJsonPath, toJson({ ...patched, generators, sync, mnci }));
+  onProgress("package.json \u2014 root scripts, TS compilers, ESLint toolchain, overrides");
   const manifestPath = (0, import_node_path11.join)(workspaceRoot, "package.json");
   const manifest = readJson(manifestPath);
   const scripts = {
@@ -2283,37 +2297,53 @@ function applyOverlay(workspaceRoot, options) {
       nx
     })
   );
+  onProgress(
+    `.npmrc \u2014 ${options.registry.kind === "azure-artifacts" ? "Azure Artifacts feed routing and credentials" : "public npm registry auth"}`
+  );
   writeFileEnsured((0, import_node_path11.join)(workspaceRoot, ".npmrc"), npmrcContent(options.registry, options.scope));
+  onProgress("commitlint.config.mjs and .husky/commit-msg \u2014 conventional commit enforcement");
   writeFileEnsured((0, import_node_path11.join)(workspaceRoot, "commitlint.config.mjs"), COMMITLINT_CONFIG);
   const hookPath = (0, import_node_path11.join)(workspaceRoot, ".husky/commit-msg");
   writeFileEnsured(hookPath, COMMIT_MSG_HOOK);
   markExecutable(hookPath);
+  onProgress("eslint.config.mjs \u2014 the shared lint AND formatting opinion");
   writeFileEnsured((0, import_node_path11.join)(workspaceRoot, "eslint.config.mjs"), ESLINT_CONFIG);
   for (const retired of RETIRED_FORMATTER_FILES) {
     removeIfPresent((0, import_node_path11.join)(workspaceRoot, retired));
   }
+  onProgress(".devcontainer/devcontainer.json \u2014 a local toolchain matching CI");
   writeFileEnsured(
     (0, import_node_path11.join)(workspaceRoot, ".devcontainer/devcontainer.json"),
     devcontainerJson(options.workspaceName)
   );
   removeNxScaffolding(workspaceRoot);
+  onProgress(
+    `${options.workspaceName}.code-workspace \u2014 settings, extensions, launch configs`
+  );
   const codeWorkspacePath = (0, import_node_path11.join)(workspaceRoot, `${options.workspaceName}.code-workspace`);
   const existing = readCodeWorkspace(codeWorkspacePath);
   writeFileEnsured(
     codeWorkspacePath,
-    vscodeWorkspace(options.workspaceName, existing?.tasks, existing?.launch)
+    vscodeWorkspace(
+      options.workspaceName,
+      existing?.tasks,
+      existing?.launch,
+      existing?.settings
+    )
   );
   if (options.workspaceName !== "undefined") {
     (0, import_node_fs6.rmSync)((0, import_node_path11.join)(workspaceRoot, "undefined.code-workspace"), { force: true });
   }
   const publishUrl = pythonPublishUrl(options.registry);
   if (options.ci === "azure" || options.ci === "both") {
+    onProgress("azure-pipelines.yml \u2014 build, verify, pack and release");
     writeFileEnsured(
       (0, import_node_path11.join)(workspaceRoot, "azure-pipelines.yml"),
       azurePipelinesYaml(options.agent, options.variableGroup, publishUrl, options.registry.kind)
     );
   }
   if (options.ci === "github" || options.ci === "both") {
+    onProgress(".github/workflows/ci.yml and dependabot.yml");
     writeFileEnsured(
       (0, import_node_path11.join)(workspaceRoot, ".github/workflows/ci.yml"),
       githubActionsYaml(options.agent, publishUrl, options.registry.kind, options.ci)
@@ -2622,7 +2652,11 @@ async function runNew(name, options) {
   logger.step(
     "Applying MoNecromanCI overlay (VS Code workspace, release config, .npmrc, commitlint, pipeline, stack)"
   );
-  applyOverlay(workspaceRoot, { workspaceName, scope, registry, agent, variableGroup, ci, stack });
+  applyOverlay(
+    workspaceRoot,
+    { workspaceName, scope, registry, agent, variableGroup, ci, stack },
+    logger.detail
+  );
   (0, import_node_fs8.rmSync)((0, import_node_path13.join)(workspaceRoot, "node_modules"), { recursive: true, force: true });
   (0, import_node_fs8.rmSync)((0, import_node_path13.join)(workspaceRoot, "package-lock.json"), { force: true });
   logger.step("Installing the toolchain (commitlint + husky + linting/formatting)");
@@ -2737,10 +2771,11 @@ function runUpgrade(workspaceRoot, options) {
   }
   const persisted = readMnciConfig(workspaceRoot);
   const resolved = resolveOverlayOptions(workspaceRoot, options, persisted);
+  logger.step("Re-applying the MoNecromanCI overlay");
+  applyOverlay(workspaceRoot, resolved, logger.detail);
   logger.step(
-    "Re-applying the MoNecromanCI overlay (release config, .npmrc, commitlint, pipeline, stack)"
+    "Formatting the workspace (eslint --fix) \u2014 the slowest step, minutes on a large workspace"
   );
-  applyOverlay(workspaceRoot, resolved);
   runFormatter(workspaceRoot);
   logger.success("Done. Review the changes with `git diff` before committing.");
 }