pob 39.1.0 → 39.1.2

package/lib/generators/core/git/generators/github/CoreGitGithubGenerator.js

@@ -111,7 +111,7 @@ export default class CoreGitGithubGenerator extends Generator {
     });
   }
 
-  async configureProtectionRule(owner, repo) {
+  async #configureProtectionRule(owner, repo) {
     if (!this.options.ciEnabled) return;
     if (ciContexts.length === 0) {
       console.warn("No ci contexts: branch protection not configured");
@@ -166,7 +166,7 @@ export default class CoreGitGithubGenerator extends Generator {
    * Runs a step of the repository setup, printing which step failed and what
    * to run by hand instead of stopping the run.
    */
-  runStep(description, manualCommand, fn) {
+  #runStep(description, manualCommand, fn) {
     try {
       fn();
       return true;
@@ -179,7 +179,7 @@ export default class CoreGitGithubGenerator extends Generator {
     }
   }
 
-  async createRepository(owner, repo, pkg) {
+  async #createRepository(owner, repo, pkg) {
     const cwd = this.destinationPath();
 
     try {
@@ -210,7 +210,7 @@ export default class CoreGitGithubGenerator extends Generator {
       console.warn(
         `github repository ${owner}/${repo} already exists, syncing its settings`,
       );
-      await this.syncRepository(owner, repo, pkg);
+      await this.#syncRepository(owner, repo, pkg);
     }
 
     const hasCommit =
@@ -221,7 +221,7 @@ export default class CoreGitGithubGenerator extends Generator {
       }).exitCode === 0;
 
     if (!hasCommit) {
-      const committed = this.runStep(
+      const committed = this.#runStep(
         "create the initial commit",
         'git add --all . && git commit -m "chore: initial commit [skip ci]"',
         () => {
@@ -238,7 +238,7 @@ export default class CoreGitGithubGenerator extends Generator {
       if (!committed) return;
     }
 
-    const pushed = this.runStep(
+    const pushed = this.#runStep(
       "push to github",
       "git branch -M main && git push -u origin main",
       () => {
@@ -248,10 +248,10 @@ export default class CoreGitGithubGenerator extends Generator {
     );
     if (!pushed) return;
 
-    await this.configureProtectionRule(owner, repo);
+    await this.#configureProtectionRule(owner, repo);
   }
 
-  async syncRepository(owner, repo, pkg) {
+  async #syncRepository(owner, repo, pkg) {
     try {
       await githubRequest("PATCH", `repos/${owner}/${repo}`, {
         name: repo,
@@ -282,11 +282,11 @@ export default class CoreGitGithubGenerator extends Generator {
     }
 
     if (this.options.shouldCreate) {
-      await this.createRepository(owner, repo, pkg);
+      await this.#createRepository(owner, repo, pkg);
     } else {
       console.log("sync github info");
-      await this.syncRepository(owner, repo, pkg);
-      await this.configureProtectionRule(owner, repo);
+      await this.#syncRepository(owner, repo, pkg);
+      await this.#configureProtectionRule(owner, repo);
     }
   }
 }

package/lib/generators/core/pnpm/CorePnpmGenerator.js

@@ -1,8 +1,45 @@
+import { execFileSync } from "node:child_process";
 import sortObject from "@pob/sort-object";
-import { FAILSAFE_SCHEMA, dump, loadAll } from "js-yaml";
+import { FAILSAFE_SCHEMA, dump, load, loadAll } from "js-yaml";
+import { satisfies } from "semver";
 import Generator from "yeoman-generator";
 import { writeAndFormat } from "../../../utils/writeAndFormat.js";
 
+const pnpmVersionRange = "^12.0.0";
+
+// pnpm 12 writes the pnpm version in a first document of pnpm-lock.yaml when
+// devEngines.packageManager is not ignored. Removes it when it has nothing
+// else (no config dependencies).
+const removePackageManagerLockfileDocument = (lockfile) => {
+  if (!lockfile.startsWith("---\n")) return lockfile;
+  const end = lockfile.indexOf("\n---\n", 4);
+  if (end === -1) return lockfile;
+  const envDocument = load(lockfile.slice(4, end), { schema: FAILSAFE_SCHEMA });
+  const importer = envDocument?.importers?.["."] ?? {};
+  const hasOtherEntries = Object.keys(importer).some(
+    (key) =>
+      key !== "packageManagerDependencies" && key !== "configDependencies",
+  );
+  if (
+    hasOtherEntries ||
+    Object.keys(importer.configDependencies ?? {}).length > 0
+  ) {
+    return lockfile;
+  }
+  return lockfile.slice(end + "\n---\n".length);
+};
+
+const getRunningPnpmVersion = (cwd) => {
+  try {
+    return execFileSync("pnpm", ["--version"], {
+      cwd,
+      encoding: "utf8",
+    }).trim();
+  } catch {
+    return null;
+  }
+};
+
 const minimumReleaseAgeExcludePackages = [
   "@pob/*",
   "pob",
@@ -38,19 +75,26 @@ export default class CorePnpmGenerator extends Generator {
     const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
     if (this.options.enable) {
-      // devEngines.packageManager replaces packageManager: pnpm switches to
-      // this version on startup (including when pnpm install is run by pob
-      // with an older pnpm), and pnpm/action-setup reads it.
+      // devEngines.packageManager is read by pnpm/action-setup. onFail is
+      // "ignore": otherwise pnpm writes its version in pnpm-lock.yaml and it
+      // has to be updated manually. The version is checked by engines.pnpm.
       delete pkg.packageManager;
       pkg.devEngines = {
         ...pkg.devEngines,
         packageManager: {
           name: "pnpm",
-          version: "^12.0.0",
-          onFail: "download",
+          version: pnpmVersionRange,
+          onFail: "ignore",
         },
       };
 
+      const lockfilePath = this.destinationPath("pnpm-lock.yaml");
+      if (this.fs.exists(lockfilePath)) {
+        const lockfile = this.fs.read(lockfilePath);
+        const newLockfile = removePackageManagerLockfileDocument(lockfile);
+        if (newLockfile !== lockfile) this.fs.write(lockfilePath, newLockfile);
+      }
+
       const configString = this.fs.read(
         this.destinationPath("pnpm-workspace.yaml"),
         { defaults: "" },
@@ -118,11 +162,23 @@ export default class CorePnpmGenerator extends Generator {
           `pnpm-workspace.yaml: set allowBuilds to true or false for ${this.pendingAllowBuilds.join(", ")}`,
         );
       }
+      // the running pnpm can be older than the version required by pob, for
+      // example in the @pob/root renovate workflow after a pnpm major update
+      const runningPnpmVersion = getRunningPnpmVersion(this.destinationPath());
+      const pnpmArgs =
+        runningPnpmVersion && satisfies(runningPnpmVersion, pnpmVersionRange)
+          ? []
+          : ["with", pnpmVersionRange];
+
       // pob just modified package.json: the lockfile must be allowed to update,
       // in particular in the automatic update GitHub Actions workflow (CI
       // defaults to frozen lockfile)
-      this.spawnSync("pnpm", ["install", "--no-frozen-lockfile"], {});
-      this.spawnSync("pnpm", ["dedupe"], {});
+      this.spawnSync(
+        "pnpm",
+        [...pnpmArgs, "install", "--no-frozen-lockfile"],
+        {},
+      );
+      this.spawnSync("pnpm", [...pnpmArgs, "dedupe"], {});
 
       this.fs.delete("package-lock.json");
       this.fs.delete("yarn.lock");
@@ -131,11 +187,11 @@ export default class CorePnpmGenerator extends Generator {
 
       if (pkg.scripts?.preversion) {
         try {
-          this.spawnSync("pnpm", ["run", "preversion"]);
+          this.spawnSync("pnpm", [...pnpmArgs, "run", "preversion"]);
         } catch {}
       } else if (pkg.scripts?.build) {
         try {
-          this.spawnSync("pnpm", ["run", "build"]);
+          this.spawnSync("pnpm", [...pnpmArgs, "run", "build"]);
         } catch {}
       }
     }

package/lib/generators/monorepo/typescript/MonorepoTypescriptGenerator.js

@@ -72,7 +72,7 @@ export default class MonorepoTypescriptGenerator extends Generator {
   // linting and tsc -b: root config files (e.g. vitest.config.ts), a root
   // scripts/ dir, and each package's scripts/ dir (matched via the workspace
   // globs so all packages are covered)
-  hasTools() {
+  #hasTools() {
     return (
       hasRootConfigFiles(this.destinationPath()) ||
       existsSync(this.destinationPath("scripts"))
@@ -81,8 +81,8 @@ export default class MonorepoTypescriptGenerator extends Generator {
 
   // tsc fails on a tsconfig.json without files nor references, like the one of
   // a new monorepo without packages
-  hasTypescriptProjects() {
-    return JSON.parse(this.options.packagePaths).length > 0 || this.hasTools();
+  #hasTypescriptProjects() {
+    return JSON.parse(this.options.packagePaths).length > 0 || this.#hasTools();
   }
 
   writing() {
@@ -109,7 +109,7 @@ export default class MonorepoTypescriptGenerator extends Generator {
     );
 
     if (this.options.enable) {
-      packageUtils.addOrRemoveScripts(pkg, this.hasTypescriptProjects(), {
+      packageUtils.addOrRemoveScripts(pkg, this.#hasTypescriptProjects(), {
         tsc: "tsc -b",
       });
       packageUtils.addOrRemoveScripts(
@@ -161,7 +161,7 @@ export default class MonorepoTypescriptGenerator extends Generator {
     this.fs.delete(this.destinationPath("tsconfig.root-configs.json"));
     this.fs.delete(tsconfigTestPath);
 
-    if (!this.options.enable || !this.hasTypescriptProjects()) {
+    if (!this.options.enable || !this.#hasTypescriptProjects()) {
       this.fs.delete(tsconfigPath);
       this.fs.delete(tsconfigCheckPath);
       this.fs.delete(tsconfigBuildPath);
@@ -171,7 +171,7 @@ export default class MonorepoTypescriptGenerator extends Generator {
       const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
       const workspaceGlobs = pkg.workspaces || [];
-      const hasTools = this.hasTools();
+      const hasTools = this.#hasTools();
       if (hasTools) {
         await copyAndFormatTpl(
           this.fs,

package/lib/generators/monorepo/workspaces/MonorepoWorkspacesGenerator.js

@@ -85,8 +85,13 @@ export default class MonorepoWorkspacesGenerator extends Generator {
       if (!pkg.engines) pkg.engines = {};
       pkg.engines.yarn = "< 0.0.0";
       pkg.engines.npm = ">= 6.4.0";
+    } else if (this.options.packageManager === "pnpm") {
+      // checks the version locally: devEngines.packageManager is ignored by
+      // pnpm (see pob:core:pnpm)
+      if (!pkg.engines) pkg.engines = {};
+      pkg.engines.pnpm = ">= 12.0.0";
+      delete pkg.engines.yarn;
     } else if (pkg.engines) {
-      // the pnpm version is set in devEngines by pob:core:pnpm
       delete pkg.engines.pnpm;
       delete pkg.engines.yarn;
     }

package/lib/generators/pob/PobBaseGenerator.js

@@ -143,14 +143,14 @@ export default class PobBaseGenerator extends Generator {
     this.config.set("project", this.projectConfig);
   }
 
-  getPackageManager() {
+  #getPackageManager() {
     return inMonorepo && !inMonorepo.root
       ? inMonorepo.rootPackageManager
       : (this.projectConfig?.packageManager ?? "yarn");
   }
 
   default() {
-    const packageManager = this.getPackageManager();
+    const packageManager = this.#getPackageManager();
 
     this.composeWith("pob:core:bun", {
       type: this.projectConfig.type,
@@ -298,7 +298,7 @@ export default class PobBaseGenerator extends Generator {
   install() {
     if (this.options.fromPob) return;
 
-    switch (this.getPackageManager()) {
+    switch (this.#getPackageManager()) {
       case "npm":
         this.spawnSync("npm", ["install"]);
         break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pob",
-  "version": "39.1.0",
+  "version": "39.1.2",
   "description": "Pile of bones, library generator with git/babel/typescript/typedoc/readme/vitest",
   "keywords": [
     "skeleton"