@mnci/cli 4.36.0 → 4.37.0

package/dist/cli.js

@@ -429,6 +429,131 @@ function fileExists(path) {
   return (0, import_node_fs3.existsSync)(path);
 }
 
+// src/pipeline-customization/pipeline-markers.algorithm.ts
+var CHOOSABLE_PHASES = ["pack", "release"];
+var SLOT_BEGIN = /^(\s*)# mnci:slot (\S+)/;
+var SLOT_END = /^\s*# mnci:slot-end \S+/;
+var PHASE_BEGIN = /^(\s*)# mnci:phase (\S+)/;
+var PHASE_END = /^\s*# mnci:phase-end (\S+)/;
+var SWITCHED_OFF_HINT = "# mnci: switched off. Uncomment the lines below to run it again (mnci doctor lists it).";
+function slotMarkers(name, indent) {
+  return [
+    `${indent}# mnci:slot ${name}  (your own steps go between these two lines; mnci upgrade keeps them)`,
+    `${indent}# mnci:slot-end ${name}`
+  ].join("\n");
+}
+function phaseStart(name, indent) {
+  return `${indent}# mnci:phase ${name}  (delete or comment this block to switch it off; mnci upgrade keeps it off)`;
+}
+function phaseEnd(name, indent) {
+  return `${indent}# mnci:phase-end ${name}`;
+}
+function extractSlots(text) {
+  const slots = /* @__PURE__ */ new Map();
+  const lines = text.split("\n");
+  for (let index = 0; index < lines.length; index++) {
+    const begin = SLOT_BEGIN.exec(lines[index]);
+    if (!begin) {
+      continue;
+    }
+    const [, indent, name] = begin;
+    const content = [];
+    for (index++; index < lines.length && !SLOT_END.test(lines[index]); index++) {
+      content.push(lines[index].startsWith(indent) ? lines[index].slice(indent.length) : lines[index].trimStart());
+    }
+    slots.set(name, content);
+    index--;
+  }
+  return slots;
+}
+function injectSlots(generated, slots) {
+  const lines = generated.split("\n");
+  const result = [];
+  for (let index = 0; index < lines.length; index++) {
+    result.push(lines[index]);
+    const begin = SLOT_BEGIN.exec(lines[index]);
+    if (!begin) {
+      continue;
+    }
+    const [, indent, name] = begin;
+    const content = slots.get(name) ?? [];
+    for (const line of content) {
+      result.push(line === "" ? "" : `${indent}${line}`);
+    }
+    while (index + 1 < lines.length && !SLOT_END.test(lines[index + 1])) {
+      index++;
+    }
+  }
+  return result.join("\n");
+}
+function switchedOffPhases(text) {
+  const lines = text.split("\n");
+  if (lines.every((line) => !(PHASE_BEGIN.test(line) || SLOT_BEGIN.test(line)))) {
+    return [];
+  }
+  return CHOOSABLE_PHASES.filter((phase) => {
+    const begin = lines.findIndex((line) => PHASE_BEGIN.exec(line)?.[2] === phase);
+    if (begin === -1) {
+      return true;
+    }
+    for (let index = begin + 1; index < lines.length && PHASE_END.exec(lines[index])?.[1] !== phase; index++) {
+      const line = lines[index].trim();
+      if (line !== "" && !line.startsWith("#")) {
+        return false;
+      }
+    }
+    return true;
+  });
+}
+function commentOutPhases(generated, phases) {
+  if (phases.length === 0) {
+    return generated;
+  }
+  const lines = generated.split("\n");
+  const result = [];
+  for (let index = 0; index < lines.length; index++) {
+    result.push(lines[index]);
+    const begin = PHASE_BEGIN.exec(lines[index]);
+    if (!begin || !phases.includes(begin[2])) {
+      continue;
+    }
+    const [, indent, name] = begin;
+    result.push(`${indent}${SWITCHED_OFF_HINT}`);
+    for (index++; index < lines.length && PHASE_END.exec(lines[index])?.[1] !== name; index++) {
+      const line = lines[index];
+      result.push(line.trim() === "" || line.trimStart().startsWith("#") ? line : `${indent}# ${line.slice(indent.length)}`);
+    }
+    index--;
+  }
+  return result.join("\n");
+}
+function inspectPipeline(text) {
+  return {
+    verifyActive: text.split("\n").some((line) => !line.trimStart().startsWith("#") && /\bci verify\b/.test(line)),
+    switchedOff: switchedOffPhases(text)
+  };
+}
+
+// src/pipeline-customization/merge-pipeline.use-case.ts
+function mergePipeline(existing, generated) {
+  if (existing === void 0) {
+    return { text: generated, notes: [] };
+  }
+  const normalized = existing.replaceAll("\r\n", "\n");
+  if (!/^\s*# mnci:(?:slot|phase) /m.test(normalized)) {
+    return {
+      text: generated,
+      notes: ['This pipeline was written before mnci kept user slots, so it was regenerated whole. Edits outside the generated steps are in git history: re-apply them inside the new "# mnci:slot" blocks.']
+    };
+  }
+  const off = switchedOffPhases(normalized);
+  const text = commentOutPhases(injectSlots(generated, extractSlots(normalized)), off);
+  return {
+    text,
+    notes: off.map((phase) => `The ${phase} phase is switched off in this pipeline and stays off.`)
+  };
+}
+
 // src/workspace-overlay/overlay.use-case.ts
 var DEFAULT_STACK = { testRunner: "jest" };
 var TS_COMPILER_DEPENDENCIES = {
@@ -918,6 +1043,13 @@ function isUnmodifiedMnciEslintConfig(content) {
   const code = content.split("\n").map((line) => line.trim()).filter((line) => line !== "" && !line.startsWith("//"));
   return code.length === 2 && code[0] === "import mnci from '@mnci/eslint-config'" && code[1] === "export default mnci({ workspaceRoot: import.meta.dirname })";
 }
+function writePipeline(path, onProgress, generated) {
+  const { text, notes } = mergePipeline((0, import_node_fs4.existsSync)(path) ? (0, import_node_fs4.readFileSync)(path, "utf8") : void 0, generated);
+  for (const note of notes) {
+    onProgress(`  ${note}`);
+  }
+  writeFileEnsured(path, text);
+}
 function writeEslintEntryPoint(workspaceRoot, onProgress) {
   const path = (0, import_node_path3.join)(workspaceRoot, ESLINT_USER_FILENAME);
   if ((0, import_node_fs4.existsSync)(path) && !isUnmodifiedMnciEslintConfig((0, import_node_fs4.readFileSync)(path, "utf8"))) {
@@ -1429,6 +1561,8 @@ steps:
 ${npmAuthenticateStep}  - script: npm ci
     displayName: Install dependencies${npmCiEnv}
 
+${slotMarkers("after-install", "  ")}
+
   # Everything from here to the release is a command of the mnci CLI, a
   # devDependency of this workspace, so the version is the lockfile's and a
   # developer reproduces CI by running the same line. The guards that used to be
@@ -1472,6 +1606,7 @@ ${npmAuthenticateStep}  - script: npm ci
   - script: npx mnci ci verify
     displayName: Verify (sync check, then affected on a PR, every project on main)
 
+${phaseStart("pack", "  ")}
   # Pack every app into dist/drop/<type>-<name>.zip via each app's 'package'
   # target; skipped cleanly when the workspace has no apps yet.
   - script: npx mnci ci pack
@@ -1491,7 +1626,11 @@ ${npmAuthenticateStep}  - script: npm ci
   - script: node -e "const fs=require('node:fs');const path=require('node:path');for(const f of fs.globSync('dist/drop/*.zip')){console.log('##vso[build.addbuildtag]'+path.basename(f,'.zip'))}"
     displayName: Tag the run per app (type-name)
     condition: ${onMain}
+${phaseEnd("pack", "  ")}
 
+${slotMarkers("before-release", "  ")}
+
+${phaseStart("release", "  ")}
   # The release, in the order that keeps a failure safe: refuse a shallow
   # clone, prove the npm token and name the PyPI projects it would create (all
   # BEFORE anything is tagged), then version + tag + publish in one 'nx release'
@@ -1517,6 +1656,9 @@ ${npmAuthenticateStep}  - script: npm ci
       # A VS Code extension publishes with it; tools/vscode-extension.cjs skips the
       # Marketplace when it is unset, including when Azure leaves it as '$(VSCE_PAT)'.
       VSCE_PAT: $(VSCE_PAT)
+${phaseEnd("release", "  ")}
+
+${slotMarkers("after-release", "  ")}
 `;
   if (!nativeApps) {
     return document;
@@ -1643,6 +1785,8 @@ jobs:
         env:
           ${npmAuthName}: ${npmAuthValue}
 
+${slotMarkers("after-install", " ".repeat(6))}
+
       # Everything from here to the release is a command of the mnci CLI, a
       # devDependency of this workspace, so the version is the lockfile's and a
       # developer reproduces CI by running the same line. The guards that used to be
@@ -1682,6 +1826,7 @@ jobs:
       - run: npx mnci ci verify
         name: Verify (sync check, then affected on a PR, every project on main)
 
+${phaseStart("pack", " ".repeat(6))}
       # Pack every app into dist/drop/<type>-<name>.zip via each app's 'package'
       # target; skipped cleanly when the workspace has no apps yet.
       - run: npx mnci ci pack
@@ -1694,7 +1839,11 @@ jobs:
           name: drop
           path: dist/drop
           if-no-files-found: ignore
+${phaseEnd("pack", " ".repeat(6))}
+
+${slotMarkers("before-release", " ".repeat(6))}
 
+${phaseStart("release", " ".repeat(6))}
       # Signs in to Microsoft Entra ID as the Marketplace publishing identity (an
       # app registration with a federated credential for this repository's main
       # branch), so the release step publishes VS Code extensions with
@@ -1739,6 +1888,9 @@ jobs:
           VSCE_PAT: \${{ secrets.VSCE_PAT }}${githubReleases ? `
           GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
           GH_TOKEN: \${{ secrets.GITHUB_TOKEN }}` : ""}
+${phaseEnd("release", " ".repeat(6))}
+
+${slotMarkers("after-release", " ".repeat(6))}
 ${nativeApps ? githubNativeJob(npmAuthName, npmAuthValue) : ""}`;
 }
 var PIP_PROJECT_GLOBS = ["apps", "python-packages", "libs"];
@@ -2059,8 +2211,9 @@ function applyOverlay(workspaceRoot, options, onProgress = () => {
   const nativeApps = hasNativeGoApp(workspaceRoot);
   if (options.ci === "azure" || options.ci === "both") {
     onProgress("azure-pipelines.yml \u2014 build, verify, pack and release");
-    writeFileEnsured(
+    writePipeline(
       (0, import_node_path3.join)(workspaceRoot, "azure-pipelines.yml"),
+      onProgress,
       azurePipelinesYaml(
         options.agent,
         options.variableGroup,
@@ -2074,8 +2227,9 @@ function applyOverlay(workspaceRoot, options, onProgress = () => {
   }
   if (options.ci === "github" || options.ci === "both") {
     onProgress(".github/workflows/ci.yml and dependabot.yml");
-    writeFileEnsured(
+    writePipeline(
       (0, import_node_path3.join)(workspaceRoot, ".github/workflows/ci.yml"),
+      onProgress,
       githubActionsYaml(options.agent, publishUrl, options.registry.kind, options.ci, nugetUrl, nativeApps)
     );
     writeFileEnsured((0, import_node_path3.join)(workspaceRoot, ".github/dependabot.yml"), dependabotConfig(workspaceRoot));
@@ -7633,6 +7787,26 @@ function checkDeclarationSpecifiers(workspaceRoot) {
     ];
   });
 }
+function checkPipelinePhases(workspaceRoot) {
+  const files = ["azure-pipelines.yml", ".github/workflows/ci.yml"];
+  return files.filter((file) => fileExists((0, import_node_path31.join)(workspaceRoot, file))).flatMap((file) => {
+    const { verifyActive, switchedOff } = inspectPipeline((0, import_node_fs25.readFileSync)((0, import_node_path31.join)(workspaceRoot, file), "utf8"));
+    const verify = {
+      check: `${file} runs the enforced verify phase`,
+      ok: verifyActive,
+      detail: `${file} has no active \`mnci ci verify\` call, so CI would build and release code nothing checked`,
+      remedy: "run `mnci upgrade`, which restores it"
+    };
+    const warnings = switchedOff.map((phase) => ({
+      check: `${file}: the ${phase} phase is switched off`,
+      ok: true,
+      warning: true,
+      detail: `${file} does not run \`mnci ci ${phase}\``,
+      remedy: `uncomment the ${phase} block in ${file} to run it again`
+    }));
+    return [verify, ...warnings];
+  });
+}
 function collectFindings(workspaceRoot) {
   const nxJsonPath = (0, import_node_path31.join)(workspaceRoot, "nx.json");
   if (!fileExists(nxJsonPath)) {
@@ -7657,7 +7831,8 @@ function collectFindings(workspaceRoot) {
     checkSync(workspaceRoot),
     checkGoPluginRegistered(workspaceRoot),
     checkGoWorkInSync(workspaceRoot),
-    ...checkNativeApps(workspaceRoot)
+    ...checkNativeApps(workspaceRoot),
+    ...checkPipelinePhases(workspaceRoot)
   ].filter((finding) => finding !== void 0);
 }
 function runDoctor(workspaceRoot, options = {}) {
@@ -7671,7 +7846,12 @@ function runDoctor(workspaceRoot, options = {}) {
     return;
   }
   for (const finding of findings) {
-    if (finding.ok) {
+    if (finding.ok && finding.warning === true) {
+      logger.warn(`${finding.check} \u2014 ${finding.detail ?? ""}`);
+      if (finding.remedy) {
+        logger.info(`    to change it: ${finding.remedy}`);
+      }
+    } else if (finding.ok) {
       logger.success(finding.check);
     } else {
       logger.error(`${finding.check} \u2014 ${finding.detail ?? "failed"}`);