pob 38.4.0 → 38.6.0

package/lib/generators/core/vscode/templates/settings.json.ejs

@@ -33,6 +33,7 @@
   "editor.formatOnSave": true,
   "eslint.codeActionsOnSave.mode": "all",
   "editor.codeActionsOnSave": {
+    "source.fixAll.oxc": "always",
     "source.fixAll.eslint": "always",
     "source.organizeImports": "never"
   },

package/lib/generators/generatedDocsOutputPath.test.js

@@ -0,0 +1,39 @@
+import * as fs from "node:fs/promises";
+import * as path from "node:path";
+import { describe, expect, it } from "vitest";
+
+const generatorsDir = import.meta.dirname;
+
+/**
+ * The "docs" directory is reserved for hand written documentation in generated
+ * projects. Generated output (typedoc, coverage lcov, gh-pages publish dir)
+ * lives in "generated-docs". This matches a bare "docs" path segment, while
+ * allowing "generated-docs", "generate:docs" and urls like
+ * "docs.renovatebot.com".
+ */
+const legacyDocsPath = /(?<![\w.:-])docs(?![\w.-])/;
+
+describe("generated documentation output path", () => {
+  it("never targets the reserved directory", async () => {
+    const entries = await fs.readdir(generatorsDir, {
+      recursive: true,
+      withFileTypes: true,
+    });
+
+    const offenders = [];
+    for (const entry of entries) {
+      if (!entry.isFile() || entry.name.endsWith(".test.js")) continue;
+      const filePath = path.join(entry.parentPath, entry.name);
+      const content = await fs.readFile(filePath, "utf8");
+      content.split("\n").forEach((line, index) => {
+        if (legacyDocsPath.test(line)) {
+          offenders.push(
+            `${path.relative(generatorsDir, filePath)}:${index + 1}: ${line.trim()}`,
+          );
+        }
+      });
+    }
+
+    expect(offenders).toEqual([]);
+  });
+});

package/lib/generators/lib/PobLibGenerator.js

@@ -1,6 +1,8 @@
 import { rmSync } from "node:fs";
 import Generator from "yeoman-generator";
+import { removeFromGitIndex } from "../../utils/git.js";
 import inMonorepo from "../../utils/inMonorepo.js";
+import removeLegacyGeneratedDocs from "../../utils/legacyGeneratedDocs.js";
 import { latestLTS } from "../../utils/nodeVersions.js";
 import * as packageUtils from "../../utils/package.js";
 
@@ -254,6 +256,17 @@ export default class PobLibGenerator extends Generator {
       this.pobjson.e2e = e2e;
     }
 
+    // build in git
+    if (!this.updateOnly) {
+      const { buildInGit } = await this.prompt({
+        type: "confirm",
+        name: "buildInGit",
+        message: "Would you like the build output committed in git ?",
+        default: this.pobjson.buildInGit === true,
+      });
+      this.pobjson.buildInGit = buildInGit;
+    }
+
     this.fs.writeJSON(this.destinationPath("package.json"), pkg);
 
     this.composeWith("pob:common:babel", {
@@ -378,8 +391,7 @@ export default class PobLibGenerator extends Generator {
       enable: !inMonorepo && this.pobjson.testing,
       packageManager,
       enablePublish: true,
-      withBabel,
-      withTypescript,
+      build: withBabel || withTypescript,
       isMonorepo: false,
       ci: this.options.ci,
       disableYarnGitCache: this.options.disableYarnGitCache,
@@ -397,6 +409,9 @@ export default class PobLibGenerator extends Generator {
     });
 
     const buildDirectory = withBabel || withTypescript ? "dist" : "";
+    const buildInGit = this.pobjson.buildInGit === true;
+    this.buildDirectory = buildDirectory;
+    this.buildInGit = buildInGit;
 
     // must be after doc, testing
     this.composeWith("pob:core:gitignore", {
@@ -405,6 +420,7 @@ export default class PobLibGenerator extends Generator {
       typescript: withTypescript,
       documentation: this.pobjson.documentation,
       testing: !!this.pobjson.testing,
+      paths: !buildInGit && buildDirectory ? `/${buildDirectory}` : "",
       buildDirectory,
       playwright: this.pobjson.e2e,
     });
@@ -464,7 +480,7 @@ export default class PobLibGenerator extends Generator {
       "lib-node14",
       "lib-node16",
       "coverage",
-      this.pobjson.documentation && "docs",
+      this.pobjson.documentation && "generated-docs",
       !(withBabel || withTypescript) && "dist",
     ]
       .filter(Boolean)
@@ -472,11 +488,23 @@ export default class PobLibGenerator extends Generator {
         rmSync(path, { recursive: true, force: true });
       });
 
+    removeLegacyGeneratedDocs((path) => this.destinationPath(path));
+
     const { pobjson } = this;
 
     this.config.set("lib", pobjson);
     this.config.save();
 
+    this.composeWith("pob:core:node", {
+      onlyLatestLTS: this.onlyLatestLTS,
+    });
     this.composeWith("pob:core:sort-package");
   }
+
+  end() {
+    // the build output is no longer committed: remove it from git, keeping it on disk.
+    if (!this.buildInGit && this.buildDirectory) {
+      removeFromGitIndex(this.destinationPath(), this.buildDirectory);
+    }
+  }
 }

package/lib/generators/lib/doc/LibDocGenerator.js

@@ -1,5 +1,6 @@
 import Generator from "yeoman-generator";
 import inMonorepo from "../../../utils/inMonorepo.js";
+import removeLegacyGeneratedDocs from "../../../utils/legacyGeneratedDocs.js";
 import * as packageUtils from "../../../utils/package.js";
 import { copyAndFormatTpl } from "../../../utils/writeAndFormat.js";
 
@@ -35,6 +36,8 @@ export default class LibDocGenerator extends Generator {
   }
 
   async writing() {
+    removeLegacyGeneratedDocs((path) => this.destinationPath(path));
+
     if (this.fs.exists(this.destinationPath("jsdoc.conf.json"))) {
       this.fs.delete(this.destinationPath("jsdoc.conf.json"));
     }
@@ -112,8 +115,8 @@ export default class LibDocGenerator extends Generator {
       }
     } else {
       // this.fs.delete(this.destinationPath('jsdoc.conf.js'));
-      if (this.fs.exists(this.destinationPath("docs"))) {
-        this.fs.delete(this.destinationPath("docs"));
+      if (this.fs.exists(this.destinationPath("generated-docs"))) {
+        this.fs.delete(this.destinationPath("generated-docs"));
       }
 
       if (this.fs.exists(this.destinationPath("tsconfig.doc.json"))) {

package/lib/generators/lib/doc/templates/tsconfig.doc.json.ejs

@@ -10,7 +10,7 @@
       "src/**/__tests__/**"
     ],
     "readme": "<%= readme %>",
-    "out": "docs",
+    "out": "generated-docs",
     "excludePrivate": true,
     "gitRevision": "main"
   },

package/lib/generators/lib/doc/templates/tsconfig.doc.json.lerna.ejs

@@ -50,7 +50,7 @@
     ],
 */ -%>
     "readme": "<%= readme %>",
-    "out": "docs",
+    "out": "generated-docs",
     "excludePrivate": true,
     "gitRevision": "master"
   }

package/lib/generators/lib/readme/templates/README.md.ejs

@@ -36,7 +36,7 @@ npm install --save <%= packageName %>
 <% if (documentation && ci && gitHost === 'github') { -%>
 ## API
 
-[https://<%= gitAccount %>.github.io/<%= packageName %>/docs](http://<%= gitAccount %>.github.io/<%= packageName %>/docs)
+[https://<%= gitAccount %>.github.io/<%= packageName %>/](https://<%= gitAccount %>.github.io/<%= packageName %>/)
 
 <% } -%>
 ## Usage

package/lib/generators/monorepo/PobMonorepoGenerator.js

@@ -2,6 +2,7 @@ import { execSync } from "node:child_process";
 import fs from "node:fs";
 import { platform } from "node:process";
 import Generator from "yeoman-generator";
+import removeLegacyGeneratedDocs from "../../utils/legacyGeneratedDocs.js";
 import * as packageUtils from "../../utils/package.js";
 import { packageManagerRun } from "../../utils/packageManagerUtils.js";
 import {
@@ -160,7 +161,7 @@ export default class PobMonorepoGenerator extends Generator {
       return;
     }
 
-    if (this.pobMonorepoConfig.ciPushWorkflow) {
+    if (this.pobMonorepoConfig?.ciPushWorkflow) {
       throw new Error(
         "ciPushWorkflow is deprecated, use disablePushWorkflow instead",
       );
@@ -181,7 +182,7 @@ export default class PobMonorepoGenerator extends Generator {
         name: "disablePushWorkflow",
         message: "Would you like to DISABLE push workflow ?",
         when: (answers) => answers.ci,
-        default: config.disablePushWorkflow,
+        default: config?.disablePushWorkflow,
       },
       {
         type: "confirm",
@@ -256,6 +257,14 @@ export default class PobMonorepoGenerator extends Generator {
 
     const splitCIJobs = this.packageNames.length > 8;
 
+    // the root has a build script when there are typescript definitions or rollup
+    // configs to build. The build output is not necessarily committed, so it must be
+    // built in ci and before publishing.
+    const hasRootBuild =
+      this.pobMonorepoConfig.typescript === true ||
+      (!this.options.isAppProject &&
+        this.packages.some((pkg) => pkg.pob?.bundler));
+
     this.composeWith("pob:common:testing", {
       monorepo: true,
       enable: this.pobMonorepoConfig.testing,
@@ -263,7 +272,7 @@ export default class PobMonorepoGenerator extends Generator {
       disableYarnGitCache: this.options.disableYarnGitCache,
       testing: this.pobMonorepoConfig.testing,
       e2eTesting: this.pobMonorepoConfig.e2eTesting,
-      build: this.pobMonorepoConfig.typescript === true,
+      build: hasRootBuild,
       typescript: this.pobMonorepoConfig.typescript,
       documentation: !!this.pobMonorepoConfig.documentation,
       codecov: this.pobMonorepoConfig.testing && this.pobMonorepoConfig.codecov,
@@ -295,7 +304,7 @@ export default class PobMonorepoGenerator extends Generator {
       documentation: this.pobMonorepoConfig.documentation,
       storybook: pkg?.devDependencies?.storybook,
       typescript: this.pobMonorepoConfig.typescript,
-      build: this.pobMonorepoConfig.typescript === true,
+      build: hasRootBuild,
       testing: this.pobMonorepoConfig.testing,
       testRunner: this.pobMonorepoConfig.testRunner,
       packageManager: this.options.packageManager,
@@ -354,7 +363,7 @@ export default class PobMonorepoGenerator extends Generator {
       enable: true,
       packageManager: this.options.packageManager,
       enablePublish: !this.options.isAppProject,
-      withBabel: this.pobMonorepoConfig.typescript,
+      build: hasRootBuild,
       isMonorepo: true,
       ci: this.pobMonorepoConfig.ci,
       disableYarnGitCache: this.options.disableYarnGitCache,
@@ -376,9 +385,11 @@ export default class PobMonorepoGenerator extends Generator {
 
     if (platform !== "win32") {
       execSync(
-        `rm -Rf ${["lib-*", "coverage", "docs"].filter(Boolean).join(" ")}`,
+        `rm -Rf ${["lib-*", "coverage", "generated-docs"].filter(Boolean).join(" ")}`,
       );
     }
+
+    removeLegacyGeneratedDocs((path) => this.destinationPath(path));
   }
 
   async writing() {
@@ -443,6 +454,9 @@ export default class PobMonorepoGenerator extends Generator {
       this.fs.writeJSON(this.destinationPath("package.json"), pkg);
     }
 
+    this.composeWith("pob:core:node", {
+      onlyLatestLTS: this.options.onlyLatestLTS,
+    });
     this.composeWith("pob:core:sort-package");
   }
 

package/lib/generators/monorepo/typescript/templates/tsconfig.json.ejs

@@ -1,11 +1,11 @@
 {
   "files": [],
   "references": [
-<% if (hasTools) { -%>
-    { "path": "tsconfig.tools.json" }<%= packagePaths.length > 0 ? ',' : '' %>
-<% } -%>
 <% packagePaths.forEach((packagePath, index) => { -%>
-    { "path": "<%= packagePath %>/tsconfig<%= tsConfigSuffix ? `.${tsConfigSuffix}` : '' %>.json" }<%= index === packagePaths.length -1 ? '' : ',' %>
+    { "path": "<%= packagePath %>/tsconfig<%= tsConfigSuffix ? `.${tsConfigSuffix}` : '' %>.json" }<%= index === packagePaths.length -1 && !hasTools ? '' : ',' %>
 <% }) -%>
+<% if (hasTools) { -%>
+    { "path": "tsconfig.tools.json" }
+<% } -%>
   ]
 }

package/lib/generators/monorepo/typescript/templates/tsconfig.tools.json.ejs

@@ -4,6 +4,7 @@
     "@pob/root/tsconfigs/targets/node-<%= nodeVersion %>.json"
   ],
   "include": [
+    "*.config.js",
     "*.config.ts",
     "*.config.mts",
     "*.config.cts",
@@ -13,7 +14,10 @@
 <% workspaceGlobs.forEach((workspaceGlob, index) => { -%>
     "<%= workspaceGlob %>/scripts/**/*.ts",
     "<%= workspaceGlob %>/scripts/**/*.mts",
-    "<%= workspaceGlob %>/scripts/**/*.cts"<%= index === workspaceGlobs.length - 1 ? '' : ',' %>
+    "<%= workspaceGlob %>/scripts/**/*.cts",
+    "<%= workspaceGlob %>/e2e/**/*.ts",
+    "<%= workspaceGlob %>/e2e/**/*.mts",
+    "<%= workspaceGlob %>/e2e/**/*.cts"<%= index === workspaceGlobs.length - 1 ? '' : ',' %>
 <% }) -%>
   ],
   "compilerOptions": {

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

@@ -96,9 +96,10 @@ export default class MonorepoWorkspacesGenerator extends Generator {
     const packageManager = this.options.packageManager;
 
     packageUtils.addScripts(pkg, {
-      lint: `${packageManager} run format && ${packageManager} run lint:eslint`,
+      lint: `${packageManager} run format && ${packageManager} run lint:oxlint && ${packageManager} run lint:eslint`,
       format: "oxfmt",
       "format:check": "oxfmt --check .",
+      "lint:oxlint": monorepoConfig && monorepoConfig.eslint && "oxlint",
       "lint:eslint":
         monorepoConfig &&
         monorepoConfig.eslint &&

package/lib/pob.js

@@ -31,6 +31,7 @@ import CoreEditorConfigGenerator from "./generators/core/editorconfig/CoreEditor
 import CoreGitGenerator from "./generators/core/git/CoreGitGenerator.js";
 import CoreGitGithubGenerator from "./generators/core/git/generators/github/CoreGitGithubGenerator.js";
 import CoreGitignoreGenerator from "./generators/core/gitignore/CoreGitignoreGenerator.js";
+import CoreNodeGenerator from "./generators/core/node/CoreNodeGenerator.js";
 import CoreNpmGenerator from "./generators/core/npm/CoreNpmGenerator.js";
 import CorePackageGenerator from "./generators/core/package/CorePackageGenerator.js";
 import CorePnpmGenerator from "./generators/core/pnpm/CorePnpmGenerator.js";
@@ -183,6 +184,11 @@ env.registerStub(
   "pob:core:gitignore",
   `${__dirname}/generators/core/gitignore/CoreGitignoreGenerator.js`,
 );
+env.registerStub(
+  CoreNodeGenerator,
+  "pob:core:node",
+  `${__dirname}/generators/core/node/CoreNodeGenerator.js`,
+);
 env.registerStub(
   CoreNpmGenerator,
   "pob:core:npm",

package/lib/utils/git.js

@@ -0,0 +1,27 @@
+import { execFileSync } from "node:child_process";
+
+export const isTrackedInGit = (cwd, path) => {
+  try {
+    return (
+      execFileSync("git", ["ls-files", "--", path], {
+        cwd,
+        encoding: "utf8",
+      }).trim() !== ""
+    );
+  } catch {
+    return false;
+  }
+};
+
+/**
+ * Removes a path from the git index, keeping it on disk. Used to migrate
+ * repositories where the build output was committed.
+ */
+export const removeFromGitIndex = (cwd, path) => {
+  if (!isTrackedInGit(cwd, path)) return false;
+
+  execFileSync("git", ["rm", "-r", "--cached", "--quiet", "--", path], { cwd });
+  console.log(`removed ${path} from git, it is no longer committed`);
+
+  return true;
+};

package/lib/utils/legacyGeneratedDocs.js

@@ -0,0 +1,26 @@
+import { existsSync, rmSync } from "node:fs";
+
+const GENERATED_MARKERS = [
+  ".nojekyll",
+  "assets",
+  "index.html",
+  "coverage.lcov",
+];
+
+/**
+ * Remove the legacy generated "docs" directory, which is now "generated-docs".
+ * Only removes it when it still looks generated, so that a hand-written
+ * markdown "docs" directory is left untouched.
+ *
+ * @param {(path: string) => string} destinationPath
+ */
+export default function removeLegacyGeneratedDocs(destinationPath) {
+  const docsPath = destinationPath("docs");
+  if (!existsSync(docsPath)) return;
+  if (
+    !GENERATED_MARKERS.some((marker) => existsSync(`${docsPath}/${marker}`))
+  ) {
+    return;
+  }
+  rmSync(docsPath, { recursive: true, force: true });
+}

package/lib/utils/legacyGeneratedDocs.test.js

@@ -0,0 +1,58 @@
+import * as fs from "node:fs/promises";
+import * as os from "node:os";
+import * as path from "node:path";
+import { describe, expect, it } from "vitest";
+import removeLegacyGeneratedDocs from "./legacyGeneratedDocs.js";
+
+async function prepareDocs(files) {
+  const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "pob-"));
+  if (files) {
+    await fs.mkdir(path.join(tmpDir, "docs"), { recursive: true });
+    for (const file of files) {
+      await fs.writeFile(path.join(tmpDir, "docs", file), "");
+    }
+  }
+  return tmpDir;
+}
+
+const exists = (docsPath) =>
+  fs
+    .stat(docsPath)
+    .then(() => true)
+    .catch(() => false);
+
+const run = (tmpDir) =>
+  removeLegacyGeneratedDocs((destination) => path.join(tmpDir, destination));
+
+describe("removeLegacyGeneratedDocs", () => {
+  it.each([".nojekyll", "index.html", "coverage.lcov"])(
+    "removes docs generated by typedoc or coverage, detected by %s",
+    async (marker) => {
+      const tmp = await prepareDocs([marker]);
+      run(tmp);
+      expect(await exists(path.join(tmp, "docs"))).toBe(false);
+    },
+  );
+
+  it("removes docs detected by the typedoc assets directory", async () => {
+    const tmp = await prepareDocs([]);
+    await fs.mkdir(path.join(tmp, "docs/assets"), { recursive: true });
+    run(tmp);
+    expect(await exists(path.join(tmp, "docs"))).toBe(false);
+  });
+
+  it("keeps hand written documentation", async () => {
+    const tmp = await prepareDocs(["guide.md", "README.md"]);
+    run(tmp);
+    expect(await fs.readdir(path.join(tmp, "docs"))).toEqual([
+      "README.md",
+      "guide.md",
+    ]);
+  });
+
+  it("does nothing when there is no docs directory", async () => {
+    const tmp = await prepareDocs(undefined);
+    expect(() => run(tmp)).not.toThrow();
+    expect(await exists(path.join(tmp, "docs"))).toBe(false);
+  });
+});

package/lib/utils/nodeEngines.js

@@ -0,0 +1,124 @@
+import semver from "semver";
+import { latestLTS, maintenanceLTS } from "./nodeVersions.js";
+import * as packageUtils from "./package.js";
+
+// 22.18.0 is the version with strip typescript out of experimental status
+const minVersionForMajor = new Map([
+  ["22", "22.18.0"],
+  ["24", "24.14.1"],
+  ["26", "26.0.0"],
+]);
+
+const legacyMajors = ["4", "6", "8", "10", "12", "14", "16", "18", "20"];
+
+/**
+ * Min node major supported, from pob envs when defined, from the LTS otherwise.
+ */
+export const getEnvsMinNodeMajor = (envs, onlyLatestLTS) => {
+  if (!envs) return onlyLatestLTS ? latestLTS : maintenanceLTS;
+  return String(
+    Math.min(
+      ...envs
+        .filter((env) => env.target === "node")
+        .map((env) => Number(env.version)),
+    ),
+  );
+};
+
+/**
+ * Min node major of a range, undefined when missing or not parseable
+ * (workspace:*, catalog:, npm: alias...).
+ */
+export const getMinMajor = (range) => {
+  if (!range) return undefined;
+  try {
+    const minVersion = semver.minVersion(range);
+    return minVersion ? semver.major(minVersion) : undefined;
+  } catch {
+    return undefined;
+  }
+};
+
+/**
+ * engines.node value for a min node major. When envs are not defined, an
+ * already higher engines.node is kept.
+ */
+export const resolveEnginesNode = (
+  currentEnginesNode,
+  minNodeMajor,
+  hasEnvs,
+) => {
+  const major = legacyMajors.includes(String(minNodeMajor))
+    ? maintenanceLTS
+    : String(minNodeMajor);
+  const minVersion = minVersionForMajor.get(major);
+  if (!minVersion) {
+    throw new Error(`Invalid min node version: ${minNodeMajor}`);
+  }
+
+  if (!hasEnvs) {
+    const currentMinMajor = getMinMajor(currentEnginesNode);
+    if (currentMinMajor !== undefined && currentMinMajor > Number(major)) {
+      return currentEnginesNode;
+    }
+  }
+
+  return `>=${minVersion}`;
+};
+
+/**
+ * Updates "@types/node" when it is lower than engines.node min major.
+ * Never adds it, never lowers devDependencies.
+ */
+export const updateTypesNodeFromEngines = (pkg) => {
+  const minMajor = getMinMajor(pkg.engines?.node);
+  if (minMajor === undefined) return;
+  const range = `>=${minMajor}.0.0`;
+
+  if (pkg.dependencies?.["@types/node"]) {
+    pkg.dependencies["@types/node"] = range;
+  }
+
+  const currentDevVersion = pkg.devDependencies?.["@types/node"];
+  if (currentDevVersion) {
+    const currentMinMajor = getMinMajor(currentDevVersion);
+    if (currentMinMajor !== undefined && currentMinMajor < minMajor) {
+      pkg.devDependencies["@types/node"] = range;
+    }
+  }
+};
+
+/**
+ * Sets engines.node from pob envs, then keeps "@types/node" in sync with it.
+ */
+export const updateNodeEngines = (pkg, { onlyLatestLTS } = {}) => {
+  const envs = pkg.pob?.envs || pkg.pob?.babelEnvs;
+  const hasTargetNode = envs?.some((env) => env.target === "node");
+
+  if (!pkg.engines) pkg.engines = {};
+
+  if (hasTargetNode || !envs) {
+    pkg.engines.node = resolveEnginesNode(
+      pkg.engines.node,
+      getEnvsMinNodeMajor(envs, onlyLatestLTS),
+      !!envs,
+    );
+
+    updateTypesNodeFromEngines(pkg);
+  } else {
+    packageUtils.removeDependencies(pkg, ["@types/node"]);
+    packageUtils.removeDevDependencies(pkg, ["@types/node"]);
+
+    // Supports oldest current or active LTS version of node
+    const minVersion = minVersionForMajor.get(
+      onlyLatestLTS ? latestLTS : maintenanceLTS,
+    );
+
+    if (
+      !pkg.engines.node ||
+      semver.lt(semver.minVersion(pkg.engines.node), minVersion)
+    ) {
+      pkg.engines.node = `>=${minVersion}`;
+    }
+  }
+};