@mnci/cli 1.19.0 → 1.19.2

package/README.md

@@ -280,7 +280,8 @@ config (`@mnci/eslint-config`'s `nonJs()`) for the file types oxlint cannot read
 | JS/TS lint                      | ESLint, 452 rules                      | oxlint, 206 native + 225 bridged                         |
 | YAML/TOML/MD/CSS/HTML/JSON lint | ESLint                                 | **ESLint** (unchanged)                                   |
 | `@nx/dependency-checks`         | yes                                    | **yes** (unchanged)                                      |
-| Formatter                       | Prettier                               | oxfmt (~30x faster)                                      |
+| Formatter                       | Prettier                               | oxfmt (~6x faster on this repo)                          |
+| Formats `.toml`                 | no — Prettier has no TOML parser       | **yes**                                                  |
 | Config files                    | `eslint.config.mjs`, `.prettierrc.mjs` | `oxlint.config.ts`, `.oxfmtrc.json`, `eslint.config.mjs` |
 | VS Code extension               | ESLint + Prettier                      | Oxc (covers both) + ESLint                               |
 
@@ -290,6 +291,27 @@ all reported by nothing. Switching modes with `mnci upgrade --linter=<other>`
 rewrites the config files **and deletes the mode you left**, so a workspace never
 carries two formatter configs.
 
+**Exactly one formatter is declared, and that is a fix rather than tidiness.**
+`prettier` under `eslint`, `oxfmt` under `oxlint`, and switching modes drops the
+other from `devDependencies`. prettier stays in `node_modules` either way, since
+`@mnci/eslint-config` depends on it — so what matters is the _declaration_:
+`esbenp.prettier-vscode` resolves the formatter from the **project's**
+dependencies, so an oxlint workspace that still declared prettier is one where a
+globally installed Prettier extension reformats on save against the opinion oxfmt
+is not applying, while `npm run format:check` (oxfmt) reports the result as
+unformatted. Both configs valid, both binaries resolvable, neither one wrong on
+its own — the `.prettierrc` precedence bug in another costume. `mnci doctor`
+checks it.
+
+**oxfmt formats `.toml`; Prettier cannot.** `prettier` on a `.toml` exits with
+`No parser could be inferred for file`, so an oxlint workspace gets a formatted
+`pyproject.toml` and the default cannot — the one gap
+`@mnci/eslint-config`'s parser-only TOML block has always documented as
+unenforceable. It is the only file type where the two formatters differ in what
+they can parse, which is why `[toml]` is pinned for format-on-save under `oxlint`
+only: pinning it under `eslint` would route the file to a formatter that errors
+on it.
+
 **Finding and overriding a rule.** One root config importing a package is easy to
 own and hard to read: nothing in three lines says which of ~20 plugins reported
 the thing you disagree with. Every block in `@mnci/eslint-config` therefore

package/dist/cli.js

@@ -80,11 +80,12 @@ function runNpx(arguments_, cwd) {
     throw new Error(`npx ${arguments_.join(" ")} failed with exit code ${status}`);
   }
 }
-function runPrettier(cwd, target = ".") {
-  const status = runShell("npx", ["prettier", "--write", "--log-level", "warn", target], cwd);
+function runFormatter(cwd, linter, target = ".") {
+  const [command, arguments_] = linter === "oxlint" ? ["oxfmt", ["--write", target]] : ["prettier", ["--write", "--log-level", "warn", target]];
+  const status = runShell("npx", [command, ...arguments_], cwd);
   if (status !== 0) {
     logger.warn(
-      `Prettier could not format '${target}' (exit code ${status}). The project was generated; run 'npm run format' to normalise it.`
+      `${command} could not format '${target}' (exit code ${status}). The project was generated; run 'npm run format' to normalise it.`
     );
   }
 }
@@ -1215,7 +1216,7 @@ async function runAdd(kind, name, options) {
     case "python-vendor": {
       await addPythonVendor(workspaceRoot, resolvedName, options, kindProvided);
       syncProjectReferences(workspaceRoot);
-      runPrettier(workspaceRoot);
+      runFormatter(workspaceRoot, stack.linter);
       return;
     }
     default: {
@@ -1226,7 +1227,7 @@ async function runAdd(kind, name, options) {
     }
   }
   syncProjectReferences(workspaceRoot);
-  runPrettier(workspaceRoot);
+  runFormatter(workspaceRoot, stack.linter);
   logger.success(`Added ${resolvedKind} '${resolvedName}'.`);
 }
 function syncProjectReferences(workspaceRoot) {
@@ -1243,7 +1244,14 @@ function readWorkspaceStack(workspaceRoot) {
   );
   const stack = nxJson.mnci?.stack;
   return {
-    testRunner: stack?.testRunner === "vitest" ? "vitest" : "jest"
+    testRunner: stack?.testRunner === "vitest" ? "vitest" : "jest",
+    // Defaults to `eslint` when absent, the same call `mnci upgrade` makes and
+    // for the same reason: every workspace generated before the choice existed
+    // has no persisted value and is an ESLint workspace. Reading it at all is
+    // the fix — this function returned `testRunner` alone, so `add` finished by
+    // formatting an oxlint workspace with Prettier, against Prettier's defaults,
+    // since the overlay had deleted the config that would have corrected it.
+    linter: stack?.linter === "oxlint" ? "oxlint" : "eslint"
   };
 }
 
@@ -1435,16 +1443,17 @@ function eslintToolchainDependencies(nxVersion) {
     eslint: ESLINT_VERSION,
     "@nx/eslint": nxVersion,
     "@nx/eslint-plugin": nxVersion,
-    "@mnci/eslint-config": eslintConfigSpec(),
-    // Declared rather than left to hoisting. `@mnci/eslint-config` depends on
-    // prettier, so `npx prettier` works either way — but the VS Code extension
-    // resolves prettier from the PROJECT's dependencies and silently falls back
-    // to its own bundled copy when it finds none. A workspace should declare the
-    // formatter it formats with instead of relying on npm flattening someone
-    // else's transitive dependency to the root.
-    prettier: PRETTIER_VERSION
+    "@mnci/eslint-config": eslintConfigSpec()
   };
 }
+var LINTER_ONLY_DEPENDENCIES = {
+  eslint: ["prettier"],
+  oxlint: ["@mnci/oxlint-config", "oxlint", "oxfmt"]
+};
+function withoutStaleLinterDependencies(devDeps, linter) {
+  const stale = new Set(LINTER_ONLY_DEPENDENCIES[linter === "oxlint" ? "eslint" : "oxlint"]);
+  return Object.fromEntries(Object.entries(devDeps).filter(([name]) => !stale.has(name)));
+}
 function rootLintTarget(linter) {
   if (linter !== "oxlint") return ROOT_LINT_TARGET;
   return {
@@ -1610,8 +1619,13 @@ var FORMATTED_LANGUAGES = [
   "jsonc",
   "yaml",
   "markdown",
-  "css"
+  "css",
+  "html"
 ];
+var OXFMT_ONLY_LANGUAGES = ["toml"];
+function formattedLanguages(linter) {
+  return [...FORMATTED_LANGUAGES, ...linter === "oxlint" ? OXFMT_ONLY_LANGUAGES : []];
+}
 function vscodeExtensions(linter) {
   return [...LINTER_EXTENSIONS[linter], ...SHARED_VSCODE_EXTENSIONS];
 }
@@ -1649,7 +1663,7 @@ function vscodeSettings(linter) {
     // while `.json`/`.jsonc`/`.yaml` were — exactly the three that had explicit
     // entries here and nothing else did.
     ...Object.fromEntries(
-      FORMATTED_LANGUAGES.map((language) => [
+      formattedLanguages(linter).map((language) => [
         `[${language}]`,
         { "editor.defaultFormatter": formatter }
       ])
@@ -2260,16 +2274,20 @@ function applyOverlay(workspaceRoot, options) {
     ...rootScripts(options.stack.linter)
   };
   const existingDevDeps = manifest.devDependencies;
-  const devDeps = {
-    ...existingDevDeps,
-    ...TS_COMPILER_DEPENDENCIES,
-    // The preset pins `nx` itself; the ESLint plugins must match it exactly.
-    ...eslintToolchainDependencies(existingDevDeps?.nx ?? "latest"),
-    // Additive, not a replacement: the hybrid keeps the whole ESLint toolchain
-    // for the file types oxlint cannot parse.
-    ...options.stack.linter === "oxlint" && oxlintToolchainDependencies(),
-    prettier: PRETTIER_VERSION
-  };
+  const devDeps = withoutStaleLinterDependencies(
+    {
+      ...existingDevDeps,
+      ...TS_COMPILER_DEPENDENCIES,
+      // The preset pins `nx` itself; the ESLint plugins must match it exactly.
+      ...eslintToolchainDependencies(existingDevDeps?.nx ?? "latest"),
+      // Additive for the linter, exclusive for the formatter: the hybrid keeps
+      // the whole ESLint toolchain for the file types oxlint cannot parse, but
+      // exactly one of prettier/oxfmt formats the workspace. Declaring both is
+      // how an editor ends up applying the one CI does not check.
+      ...options.stack.linter === "oxlint" ? oxlintToolchainDependencies() : { prettier: PRETTIER_VERSION }
+    },
+    options.stack.linter
+  );
   const overrides = {
     ...manifest.overrides,
     ...ESLINT_PEER_OVERRIDES
@@ -2386,6 +2404,23 @@ function checkLinterModeIsConsistent(workspaceRoot) {
     remedy: "run `mnci upgrade`, which removes the mode the workspace did not choose"
   };
 }
+function declaredDevDependencies(workspaceRoot) {
+  const manifestPath = (0, import_node_path12.join)(workspaceRoot, "package.json");
+  if (!fileExists(manifestPath)) return {};
+  const manifest = readJson(manifestPath);
+  return manifest.devDependencies ?? {};
+}
+function checkOneFormatterDeclared(workspaceRoot) {
+  const linter = readMnciConfig(workspaceRoot).stack?.linter ?? "eslint";
+  const stale = linter === "oxlint" ? "prettier" : "oxfmt";
+  const declared = declaredDevDependencies(workspaceRoot)[stale] !== void 0;
+  return {
+    check: `only ${linter === "oxlint" ? "oxfmt" : "prettier"} is declared as the formatter`,
+    ok: !declared,
+    detail: `${stale} is declared but nothing runs it \u2014 the editor may still resolve and apply it, disagreeing with \`npm run format:check\``,
+    remedy: "run `mnci upgrade`, which drops the formatter of the mode you left"
+  };
+}
 function checkOxlintToolchainDeclared(workspaceRoot) {
   const linter = readMnciConfig(workspaceRoot).stack?.linter ?? "eslint";
   if (linter !== "oxlint") {
@@ -2396,10 +2431,7 @@ function checkOxlintToolchainDeclared(workspaceRoot) {
       remedy: ""
     };
   }
-  const manifest = readJson(
-    (0, import_node_path12.join)(workspaceRoot, "package.json")
-  );
-  const devDeps = manifest?.devDependencies ?? {};
+  const devDeps = declaredDevDependencies(workspaceRoot);
   const missing = ["oxlint", "oxfmt", "@mnci/oxlint-config"].filter(
     (dependency) => devDeps[dependency] === void 0
   );
@@ -2505,6 +2537,7 @@ function collectFindings(workspaceRoot) {
     ...checkEslintConfigs(workspaceRoot),
     checkPrettierConfig(workspaceRoot),
     checkLinterModeIsConsistent(workspaceRoot),
+    checkOneFormatterDeclared(workspaceRoot),
     checkOxlintToolchainDeclared(workspaceRoot),
     checkEslintPlugin(nxJson),
     checkResolvedEslint(workspaceRoot),
@@ -2621,8 +2654,10 @@ async function runNew(name, options) {
     throw new Error(`npm install of the toolchain failed with exit code ${installStatus}`);
   }
   runShell("npx", ["husky"], workspaceRoot);
-  logger.step("Formatting the workspace (Prettier, JavaScript Standard Style)");
-  runPrettier(workspaceRoot);
+  logger.step(
+    `Formatting the workspace (${stack.linter === "oxlint" ? "oxfmt" : "Prettier"}, JavaScript Standard Style)`
+  );
+  runFormatter(workspaceRoot, stack.linter);
   logger.success("Done. Next steps:");
   logger.info(`  cd ${workspaceName}`);
   logger.info("  mnci add react-app web        # or: react-lib, react-internal-lib, node-app,");
@@ -2728,7 +2763,7 @@ function runUpgrade(workspaceRoot, options) {
     "Re-applying the MoNecromanCI overlay (release config, .npmrc, commitlint, pipeline, stack)"
   );
   applyOverlay(workspaceRoot, resolved);
-  runPrettier(workspaceRoot);
+  runFormatter(workspaceRoot, resolved.stack.linter);
   logger.success("Done. Review the changes with `git diff` before committing.");
 }