pob 38.13.0 → 39.0.0

package/lib/generators/core/bun/templates/bunfig.toml.ejs

@@ -2,4 +2,20 @@
 [install]
 # Only install package versions published at least 3 days ago
 minimumReleaseAge = 259200 # seconds - in #23162 it'll allow "3d" too
-minimumReleaseAgeExcludes = ["@pob/root", "@pob/esbuild", "@pob/rollup", "@pob/rollup-esbuild", "@pob/rollup-typescript", "@pob/sort-object", "@pob/sort-pkg", "@pob/version", "pob-dependencies", "pob-dependencies", "alouette", "alouette-icons", "nightingale", "nightingale-logger", "nightingale-levels", "nightingale-types"]
+minimumReleaseAgeExcludes = [
+  "@pob/root",
+  "@pob/esbuild",
+  "@pob/rollup",
+  "@pob/rollup-esbuild",
+  "@pob/rollup-typescript",
+  "@pob/sort-object",
+  "@pob/sort-pkg",
+  "@pob/version",
+  "pob-dependencies",
+  "alouette",
+  "alouette-icons",
+  "nightingale",
+  "nightingale-logger",
+  "nightingale-levels",
+  "nightingale-types",
+]

package/lib/generators/lib/readme/LibReadmeGenerator.js

@@ -1,9 +1,8 @@
-/* oxlint-disable regexp/match-any */
-/* oxlint-disable regexp/no-super-linear-backtracking */
 import camelCase from "lodash.camelcase";
 import Generator from "yeoman-generator";
 import inMonorepo from "../../../utils/inMonorepo.js";
 import * as packageUtils from "../../../utils/package.js";
+import { extractLibReadmeContent } from "../../../utils/readmeContent.js";
 import { copyAndFormatTpl } from "../../../utils/writeAndFormat.js";
 
 export default class LibReadmeGenerator extends Generator {
@@ -49,39 +48,7 @@ export default class LibReadmeGenerator extends Generator {
 
     if (this.fs.exists(readmePath)) {
       const readmeFullContent = this.fs.read(readmePath);
-      content = readmeFullContent.match(
-        /^<h1 align="center"[^#*]+([^]+)\[npm-image\]:/,
-      );
-      if (!content) {
-        content = readmeFullContent.match(
-          /^<h1 align="center"[^#*]+([^]+)\[daviddm-image\]:/,
-        );
-      }
-      if (!content) {
-        content = readmeFullContent.match(
-          /^<h3 align="center"[^#*]+([^]+)\[npm-image\]:/,
-        );
-      }
-      if (!content) {
-        content = readmeFullContent.match(
-          /^<h3 align="center"[^#*]+([^]+)\[daviddm-image\]:/,
-        );
-      }
-      if (!content) {
-        content = readmeFullContent.match(/^<h1 align="center"[^#*]+([^]+)$/);
-      }
-      if (!content) {
-        content = readmeFullContent.match(/^<h3 align="center"[^#*]+([^]+)$/);
-      }
-      if (!content) content = readmeFullContent.match(/^<h3[^#*]+([^]+)$/);
-      if (!content) {
-        content = readmeFullContent.match(/^#[^#*]+([^]+)\[npm-image\]:/);
-      }
-      if (!content) {
-        content = readmeFullContent.match(/^#[^#*]+([^]+)\[daviddm-image\]:/);
-      }
-      if (!content) content = readmeFullContent.match(/^#[^#*]+([^]+)$/);
-      content = content ? content[1].trim() : readmeFullContent;
+      content = extractLibReadmeContent(readmeFullContent);
     }
 
     const author = packageUtils.parsePkgAuthor(pkg);

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

@@ -6,6 +6,7 @@ import {
   workspacesRunExcluding,
   workspacesRunTopological,
 } from "../../../utils/packageManagerWorkspacesUtils.js";
+import { extractMonorepoReadmeContent } from "../../../utils/readmeContent.js";
 import { copyAndFormatTpl } from "../../../utils/writeAndFormat.js";
 
 export default class MonorepoWorkspacesGenerator extends Generator {
@@ -165,19 +166,7 @@ export default class MonorepoWorkspacesGenerator extends Generator {
 
     if (this.fs.exists(readmePath)) {
       const readmeFullContent = this.fs.read(readmePath);
-      // oxlint-disable-next-line regexp/no-super-linear-backtracking, regexp/match-any
-      content = readmeFullContent.match(/^<h1 align="center"[^#*]+([^]+)$/);
-      if (!content) {
-        // oxlint-disable-next-line regexp/no-super-linear-backtracking, regexp/match-any
-        content = readmeFullContent.match(/^<h3 align="center"[^#*]+([^]+)$/);
-      }
-      if (!content) {
-        // oxlint-disable-next-line regexp/no-super-linear-backtracking, regexp/match-any
-        content = readmeFullContent.match(/^<h3[^#*]+([^]+)$/);
-      }
-      // oxlint-disable-next-line regexp/no-super-linear-backtracking, regexp/match-any
-      if (!content) content = readmeFullContent.match(/^#[^#*]+([^]+)$/);
-      content = content ? content[1].trim() : readmeFullContent;
+      content = extractMonorepoReadmeContent(readmeFullContent);
     }
 
     return copyAndFormatTpl(
@@ -185,7 +174,7 @@ export default class MonorepoWorkspacesGenerator extends Generator {
       this.templatePath("README.md.ejs"),
       readmePath,
       {
-        title: pkg.description,
+        title: pkg.description || pkg.name.replace(/-monorepo$/, ""),
         description: "",
         packages: this.packages,
         ci: this.fs.exists(this.destinationPath(".github/workflows/push.yml")),

package/lib/utils/readmeContent.js

@@ -0,0 +1,52 @@
+// Generators regenerate the header of a README and keep the hand-written body
+// that follows it. The body is whatever comes after the generated header, so
+// it is found by matching the header itself — not by looking for the first
+// heading, which loses any prose placed right after the header, and stops early
+// on a `#` or `*` inside the header (a description such as "C# client").
+
+/* oxlint-disable regexp/no-super-linear-backtracking, regexp/match-any */
+
+// <h1>, optional <p> description, then the packages table
+const monorepoHeaderRegex =
+  /^<h1 align="center">[^]*?\n<h3>📦 Packages<\/h3>\n[^|]*(?:\|[^\n]*\n)+([^]*)$/;
+
+// <h1>, then the <p> description and badges blocks
+const libHeaderRegex =
+  /^<h1 align="center">[^]*?<\/h1>\n(?:\s*<p align="center">[^]*?<\/p>\n)+([^]*)$/;
+
+const matchFirst = (content, regexes) => {
+  for (const regex of regexes) {
+    const match = content.match(regex);
+    if (match) return match[1].trim();
+  }
+  return content;
+};
+
+export function extractMonorepoReadmeContent(readmeFullContent) {
+  return matchFirst(readmeFullContent, [
+    monorepoHeaderRegex,
+    // legacy headers
+    /^<h1 align="center"[^#*]+([^]+)$/,
+    /^<h3 align="center"[^#*]+([^]+)$/,
+    /^<h3[^#*]+([^]+)$/,
+    /^#[^#*]+([^]+)$/,
+  ]);
+}
+
+export function extractLibReadmeContent(readmeFullContent) {
+  return matchFirst(readmeFullContent, [
+    // legacy headers with badges as reference links at the end
+    /^<h1 align="center"[^#*]+([^]+)\[npm-image\]:/,
+    /^<h1 align="center"[^#*]+([^]+)\[daviddm-image\]:/,
+    /^<h3 align="center"[^#*]+([^]+)\[npm-image\]:/,
+    /^<h3 align="center"[^#*]+([^]+)\[daviddm-image\]:/,
+    libHeaderRegex,
+    // legacy headers
+    /^<h1 align="center"[^#*]+([^]+)$/,
+    /^<h3 align="center"[^#*]+([^]+)$/,
+    /^<h3[^#*]+([^]+)$/,
+    /^#[^#*]+([^]+)\[npm-image\]:/,
+    /^#[^#*]+([^]+)\[daviddm-image\]:/,
+    /^#[^#*]+([^]+)$/,
+  ]);
+}

package/lib/utils/readmeContent.test.js

@@ -0,0 +1,167 @@
+import { fileURLToPath } from "node:url";
+import { describe, expect, it } from "vitest";
+import { create as createMemFs } from "mem-fs";
+import { create as createEditor } from "mem-fs-editor";
+import {
+  extractLibReadmeContent,
+  extractMonorepoReadmeContent,
+} from "./readmeContent.js";
+import { copyAndFormatTpl } from "./writeAndFormat.js";
+
+const templatePath = (generator) =>
+  fileURLToPath(
+    new URL(
+      `../generators/${generator}/templates/README.md.ejs`,
+      import.meta.url,
+    ),
+  );
+
+// renders the README exactly as the generator writes it: template, then oxfmt
+async function render(generator, options) {
+  const fs = createEditor(createMemFs());
+  const destinationPath = "/virtual/README.md";
+  await copyAndFormatTpl(fs, templatePath(generator), destinationPath, options);
+  return fs.read(destinationPath);
+}
+
+const packages = [
+  { name: "pkg-a", description: "First package" },
+  { name: "pkg-b", description: "Second package" },
+];
+
+const renderMonorepo = (content, { title = "a monorepo" } = {}) =>
+  render("monorepo/workspaces", {
+    title,
+    description: "",
+    packages,
+    ci: false,
+    content,
+  });
+
+const renderLib = (content, options = {}) =>
+  render("lib/readme", {
+    title: "pkg-a",
+    privatePackage: false,
+    packageName: "pkg-a",
+    camelCaseProjectName: "pkgA",
+    description: "First package",
+    gitHost: "github",
+    gitAccount: "someone",
+    gitName: "pkg-a",
+    codecov: false,
+    documentation: false,
+    documentationUrl: undefined,
+    testing: false,
+    ci: false,
+    ...options,
+    content,
+  });
+
+const proseBody = `Every tool here answers the same two questions:
+
+- **why is this duplicated?** — which dependents force several versions.
+- **dedupe it** — compute the fixes and apply them.
+
+## Usage
+
+Run it.`;
+
+const headingBody = `## About
+
+Some text, with **bold**.`;
+
+describe("extractMonorepoReadmeContent", () => {
+  it.each([
+    ["a body starting with a heading", headingBody],
+    ["a body starting with prose", proseBody],
+  ])("keeps %s through regeneration", async (_, body) => {
+    const readme = await renderMonorepo(body);
+    expect(extractMonorepoReadmeContent(readme)).toBe(body);
+    // a second run is stable
+    expect(await renderMonorepo(extractMonorepoReadmeContent(readme))).toBe(
+      readme,
+    );
+  });
+
+  it("keeps the body when the title contains # or *", async () => {
+    const readme = await renderMonorepo(proseBody, {
+      title: "C# tools, **bold**",
+    });
+    expect(extractMonorepoReadmeContent(readme)).toBe(proseBody);
+  });
+
+  it("extracts nothing from a README without a body", async () => {
+    expect(extractMonorepoReadmeContent(await renderMonorepo(""))).toBe("");
+  });
+
+  // pm-tools README: hand-written prose right after the table lost everything
+  // up to the first `*`, i.e. the paragraph and the first bullet's `- `
+  it("strips a hand-edited header and keeps the prose after the table", () => {
+    const readme = `<h1 align="center">
+  pm-tools
+</h1>
+
+<p align="center">
+  Find out why a dependency is duplicated in a lockfile, and dedupe it.
+</p>
+
+<h3>📦 Packages</h3>
+
+This repository is a monorepo managed with [bun workspaces](https://bun.com/docs/install/workspaces).
+
+| Package               | Version | Description      |
+| --------------------- | ------- | ---------------- |
+| [pkg-a](packages/pkg-a) |         | First package    |
+
+${proseBody}
+`;
+    expect(extractMonorepoReadmeContent(readme)).toBe(proseBody);
+  });
+
+  it("falls back to the first heading for a README not generated by pob", () => {
+    expect(extractMonorepoReadmeContent("# title\n\nintro\n\n## Usage\n")).toBe(
+      "## Usage",
+    );
+  });
+});
+
+describe("extractLibReadmeContent", () => {
+  it.each([
+    ["a body starting with a heading", headingBody, {}],
+    ["a body starting with prose", proseBody, {}],
+    [
+      "a description containing # or *",
+      headingBody,
+      { description: "C# **x**" },
+    ],
+    ["no description", proseBody, { description: undefined }],
+    [
+      "an empty badges block",
+      proseBody,
+      { privatePackage: true, gitHost: undefined },
+    ],
+  ])(
+    "keeps the body with %s through regeneration",
+    async (_, body, options) => {
+      const readme = await renderLib(body, options);
+      expect(extractLibReadmeContent(readme)).toBe(body);
+      expect(await renderLib(extractLibReadmeContent(readme), options)).toBe(
+        readme,
+      );
+    },
+  );
+
+  it("strips legacy badges reference links", () => {
+    const readme = `<h1 align="center">
+  pkg-a
+</h1>
+
+## Usage
+
+Run it.
+
+[npm-image]: https://img.shields.io/npm/v/pkg-a.svg
+`;
+    expect(extractLibReadmeContent(readme)).toBe("## Usage\n\nRun it.");
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pob",
-  "version": "38.13.0",
+  "version": "39.0.0",
   "description": "Pile of bones, library generator with git/babel/typescript/typedoc/readme/vitest",
   "keywords": [
     "skeleton"
@@ -31,8 +31,8 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@pob/eslint-config": "67.11.0",
-    "@pob/eslint-config-typescript-react": "67.11.0",
+    "@pob/eslint-config": "67.12.0",
+    "@pob/eslint-config-typescript-react": "67.12.0",
     "@pob/sort-object": "11.2.0",
     "@pob/sort-pkg": "13.2.0",
     "@types/inquirer": "9.0.10",
@@ -46,25 +46,25 @@
     "lodash.camelcase": "^4.3.0",
     "lodash.kebabcase": "^4.1.1",
     "mem-fs": "4.1.5",
-    "mem-fs-editor": "12.0.6",
+    "mem-fs-editor": "12.1.0",
     "minimist": "1.2.8",
-    "oxfmt": "0.54.0",
+    "oxfmt": "0.72.0",
     "parse-author": "2.0.0",
-    "pob-dependencies": "27.11.0",
+    "pob-dependencies": "27.12.0",
     "semver": "7.8.5",
     "typescript": "npm:@typescript/typescript6@6.0.2",
     "validate-npm-package-name": "^8.0.0",
     "yeoman-environment": "6.1.0",
-    "yeoman-generator": "8.2.2"
+    "yeoman-generator": "10.0.1"
   },
   "devDependencies": {
-    "@pob/root": "27.13.0",
+    "@pob/root": "27.14.0",
     "@types/node": "24.19.1",
     "@typescript/native": "npm:typescript@7.0.2",
     "@yeoman/types": "1.11.1"
   },
   "engines": {
-    "node": ">=22.18.0"
+    "node": ">=24.14.1"
   },
   "pob": {
     "typescript": "check-only"