@mnci/cli 4.0.7 → 4.0.8

package/dist/cli.js

@@ -1343,6 +1343,100 @@ function markPublic(manifestPath) {
 var WRONG_TYPES_PATH = "./dist/index.esm.d.ts";
 var ACTUAL_TYPES_PATH = "./dist/src/index.d.ts";
 var DECLARATION_MAP_EXCLUSION = "!**/*.d.ts.map";
+var ROLLUP_CONFIG_PLACEHOLDER = [
+  "  {",
+  "    // Provide additional rollup configuration here. See: https://rollupjs.org/configuration-options",
+  "    // e.g.",
+  "    // output: { sourcemap: true },",
+  "  }"
+].join("\n");
+var ROLLUP_CONFIG_WITH_DTS_FIX = [
+  "  {",
+  "    // Added by MoNecromanCI. @nx/rollup's dts-bundle plugin writes dist/index.d.ts",
+  "    // as a stub re-exporting the real declarations, and builds that specifier with",
+  "    // path.relative() - an OS-NATIVE path. On Windows it emits",
+  String.raw`    //   export * from "./src\\index";`,
+  "    // which is not a valid module specifier on ANY platform: a specifier is",
+  "    // URL-style, so / is correct everywhere and a backslash nowhere. It resolves on",
+  "    // Windows only because the resolver normalises separators there, leaving the",
+  "    // package untyped on Linux and macOS.",
+  "    //",
+  "    // mnci also points `types` past this stub, so nothing depends on it being",
+  "    // correct; this makes the emitted file correct too. Remove once Nx fixes the",
+  "    // plugin - its own devkit already exports normalizePath for exactly this.",
+  "    plugins: [",
+  "      {",
+  "        name: 'mnci-normalise-declaration-specifiers',",
+  "        writeBundle (outputOptions) {",
+  "          const { readFileSync, writeFileSync } = require('node:fs')",
+  "          const { join } = require('node:path')",
+  "          const stub = join(outputOptions.dir ?? './dist', 'index.d.ts')",
+  "          let source",
+  "          try {",
+  "            source = readFileSync(stub, 'utf8')",
+  "          } catch {",
+  "            return",
+  "          }",
+  "          // The stub carries a TWO-character escape (JSON.stringify escaped one",
+  "          // backslash), so this must not match a single one - that would turn",
+  String.raw`          // "./src\index" into "./src//index". Built from char codes so there is`,
+  "          // no escaping in this file to get wrong.",
+  "          const separator = String.fromCodePoint(92, 92)",
+  "          const normalised = source.replaceAll(separator, '/')",
+  "          if (normalised !== source) writeFileSync(stub, normalised)",
+  "        }",
+  "      }",
+  "    ]",
+  "  }"
+].join("\n");
+function repairDeclarationSpecifiers(projectRoot) {
+  const configPath = (0, import_node_path3.join)(projectRoot, "rollup.config.cjs");
+  if (!fileExists(configPath)) {
+    return;
+  }
+  const config = (0, import_node_fs3.readFileSync)(configPath, "utf8");
+  if (!config.includes(ROLLUP_CONFIG_PLACEHOLDER)) {
+    return;
+  }
+  writeFileEnsured(
+    configPath,
+    config.split(ROLLUP_CONFIG_PLACEHOLDER).join(ROLLUP_CONFIG_WITH_DTS_FIX)
+  );
+}
+function writeProjectReadme(projectRoot, projectName, testRunner) {
+  const runner = testRunner === "vitest" ? "[Vitest](https://vitest.dev)" : "[Jest](https://jestjs.io)";
+  writeFileEnsured(
+    (0, import_node_path3.join)(projectRoot, "README.md"),
+    [
+      `# ${projectName}`,
+      "",
+      "Generated by [MoNecromanCI](https://github.com/russoedu/MoNecromanCi).",
+      "",
+      "## Building",
+      "",
+      `Run \`nx build ${projectName}\` to build this project.`,
+      "",
+      "## Running unit tests",
+      "",
+      `Run \`nx test ${projectName}\` to execute the unit tests via ${runner}.`,
+      ""
+    ].join("\n")
+  );
+}
+function removeStaleGitkeeps(workspaceRoot) {
+  for (const scaffold of ["apps", "libs", "packages"]) {
+    const directory = (0, import_node_path3.join)(workspaceRoot, scaffold);
+    try {
+      const holdsAProject = (0, import_node_fs3.readdirSync)(directory, { withFileTypes: true }).some(
+        (entry) => entry.isDirectory()
+      );
+      if (holdsAProject) {
+        (0, import_node_fs3.rmSync)((0, import_node_path3.join)(directory, ".gitkeep"), { force: true });
+      }
+    } catch {
+    }
+  }
+}
 function repairPublishableManifest(manifestPath) {
   const manifest = readJson(manifestPath);
   if (manifest.types === WRONG_TYPES_PATH) {
@@ -1412,6 +1506,7 @@ function projectTask(name, kind) {
   return kind === "start" ? { ...base, isBackground: true } : { ...base, group: kind };
 }
 function registerProjectCommands(workspaceRoot, name, commands) {
+  removeStaleGitkeeps(workspaceRoot);
   const scripts = {
     [`${name}:qa`]: `nx run ${name}:lint && nx run ${name}:test`
   };
@@ -1879,6 +1974,8 @@ async function addNpmLib(workspaceRoot, name, options, kindProvided, stack) {
   const manifestPath = (0, import_node_path7.join)(workspaceRoot, "packages", name, "package.json");
   markPublic(manifestPath);
   repairPublishableManifest(manifestPath);
+  repairDeclarationSpecifiers((0, import_node_path7.join)(workspaceRoot, `packages/${name}`));
+  writeProjectReadme((0, import_node_path7.join)(workspaceRoot, `packages/${name}`), `${scope}/${name}`, stack.testRunner);
   removeGeneratedEslintConfig(workspaceRoot, `packages/${name}`);
   registerProjectCommands(workspaceRoot, name, { build: true });
 }
@@ -2207,6 +2304,8 @@ async function addReactLib(workspaceRoot, name, options, kindProvided, stack) {
   const publishableManifest = (0, import_node_path10.join)(workspaceRoot, "packages", name, "package.json");
   markPublic(publishableManifest);
   repairPublishableManifest(publishableManifest);
+  repairDeclarationSpecifiers((0, import_node_path10.join)(workspaceRoot, "packages", name));
+  writeProjectReadme((0, import_node_path10.join)(workspaceRoot, "packages", name), `${scope}/${name}`, stack.testRunner);
   removeGeneratedEslintConfig(workspaceRoot, `packages/${name}`);
   registerProjectCommands(workspaceRoot, name, { build: true });
 }
@@ -2228,6 +2327,8 @@ function addReactInternalLib(workspaceRoot, name, stack) {
   const privateManifest = (0, import_node_path10.join)(workspaceRoot, "libs", name, "package.json");
   markPrivate(privateManifest);
   repairPublishableManifest(privateManifest);
+  repairDeclarationSpecifiers((0, import_node_path10.join)(workspaceRoot, "libs", name));
+  writeProjectReadme((0, import_node_path10.join)(workspaceRoot, "libs", name), name, stack.testRunner);
   removeGeneratedEslintConfig(workspaceRoot, `libs/${name}`);
   registerProjectCommands(workspaceRoot, name, { build: true });
 }