pob 38.11.0 → 38.12.0

package/lib/generators/app/PobAppGenerator.js

@@ -240,12 +240,14 @@ export default class PobAppGenerator extends Generator {
 
     const enableHashSlash = shouldEnableHashSlash(this.appConfig.type);
 
+    this.useTypescript = Boolean(
+      typescript ||
+      pkg.pob?.typescript === "check-only" ||
+      (inMonorepo && inMonorepo.pobMonorepoConfig?.typescript === "check-only"),
+    );
+
     this.composeWith("pob:common:typescript", {
-      enable:
-        typescript ||
-        pkg.pob?.typescript === "check-only" ||
-        (inMonorepo &&
-          inMonorepo.pobMonorepoConfig?.typescript === "check-only"),
+      enable: this.useTypescript,
       onlyCheck:
         pkg.pob?.typescript === "check-only" ||
         (inMonorepo &&
@@ -387,6 +389,7 @@ export default class PobAppGenerator extends Generator {
       case "vite-with-server":
         this.composeWith("pob:app:vite", {
           enableServer: this.appConfig.type === "vite-with-server",
+          packageManager: this.options.packageManager,
         });
         break;
       case "expo":
@@ -428,6 +431,22 @@ export default class PobAppGenerator extends Generator {
       }
     }
 
+    // consumers and their tools (bundlers, type-aware lint) resolve the
+    // package through package.json, not through the tsconfig paths
+    if (this.appConfig.type === "untranspiled-library") {
+      const entry =
+        ["ts", "tsx", "js"]
+          .map((extension) => `./${srcDirectory}/index.${extension}`)
+          .find((path) => this.fs.exists(this.destinationPath(path))) ||
+        `./${srcDirectory}/index.${this.useTypescript ? "ts" : "js"}`;
+      if (!pkg.main) pkg.main = entry;
+      if (!pkg.exports) {
+        pkg.exports = { ".": entry };
+      } else if (typeof pkg.exports === "object" && !pkg.exports["."]) {
+        pkg.exports = { ".": entry, ...pkg.exports };
+      }
+    }
+
     if (this.appConfig.type === "expo") {
       pkg.expo = { install: { exclude: ["typescript"] } };
     } else if (pkg.expo) {

package/lib/generators/app/vite/AppViteGenerator.js

@@ -1,5 +1,14 @@
 import Generator from "yeoman-generator";
 import * as packageUtils from "../../../utils/package.js";
+import { packageManagerRun } from "../../../utils/packageManagerUtils.js";
+import { copyAndFormatTpl } from "../../../utils/writeAndFormat.js";
+
+const viteConfigFileNames = [
+  "vite.config.js",
+  "vite.config.mjs",
+  "vite.config.ts",
+  "vite.config.mts",
+];
 
 export default class AppViteGenerator extends Generator {
   constructor(args, opts) {
@@ -8,18 +17,27 @@ export default class AppViteGenerator extends Generator {
       type: Boolean,
       default: false,
     });
+
+    this.option("packageManager", {
+      type: String,
+      default: "yarn",
+    });
   }
 
-  writing() {
+  async writing() {
     const pkg = this.fs.readJSON(this.destinationPath("package.json"));
+    const run = (script) =>
+      packageManagerRun(this.options.packageManager, script);
+
+    packageUtils.addDevDependencies(pkg, ["vite"]);
 
     if (this.options.enableServer) {
       packageUtils.addScripts(pkg, {
-        build: "yarn run build:client && yarn run build:server",
+        build: `${run("build:client")} && ${run("build:server")}`,
         "build:client": "vite build --outDir dist/client",
         "build:server":
           "vite build --ssr src/entry-server.tsx --outDir dist/server",
-        preview: "yarn run build && yarn run start:prod",
+        preview: `${run("build")} && ${run("start:prod")}`,
         start: "node server.js",
         "start:prod": "NODE_ENV=production node server.js",
       });
@@ -30,6 +48,35 @@ export default class AppViteGenerator extends Generator {
         start: "vite",
         serve: "vite preview",
       });
+
+      // a new app: the files are never overwritten
+      const hasViteConfig = viteConfigFileNames.some((fileName) =>
+        this.fs.exists(this.destinationPath(fileName)),
+      );
+      if (!hasViteConfig) {
+        await copyAndFormatTpl(
+          this.fs,
+          this.templatePath("vite.config.js.ejs"),
+          this.destinationPath("vite.config.js"),
+          {},
+        );
+        if (!this.fs.exists(this.destinationPath("src/index.html"))) {
+          await copyAndFormatTpl(
+            this.fs,
+            this.templatePath("index.html.ejs"),
+            this.destinationPath("src/index.html"),
+            { name: pkg.name },
+          );
+        }
+        if (!this.fs.exists(this.destinationPath("src/index.ts"))) {
+          await copyAndFormatTpl(
+            this.fs,
+            this.templatePath("index.ts.ejs"),
+            this.destinationPath("src/index.ts"),
+            { name: pkg.name },
+          );
+        }
+      }
     }
 
     this.fs.writeJSON(this.destinationPath("package.json"), pkg);

package/lib/generators/app/vite/templates/index.html.ejs

@@ -0,0 +1,11 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title><%= name %></title>
+  </head>
+  <body>
+    <script type="module" src="./index.ts"></script>
+  </body>
+</html>

package/lib/generators/app/vite/templates/index.ts.ejs

@@ -0,0 +1 @@
+document.body.append("<%= name %>");

package/lib/generators/app/vite/templates/vite.config.js.ejs

@@ -0,0 +1,8 @@
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  root: "src",
+  build: {
+    outDir: "../dist",
+  },
+});

package/lib/generators/common/babel/templates/app.rollup.config.mjs.ejs

@@ -1,3 +1,4 @@
+// Generated by pob: do not edit, it is overwritten on each pob run.
 import { dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 <% if (config) { -%>

package/lib/generators/common/babel/templates/lib.rollup.config.mjs.ejs

@@ -1,3 +1,4 @@
+// Generated by pob: do not edit, it is overwritten on each pob run.
 import { dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import createRollupConfig from 'pob-babel/createRollupConfig.js';

package/lib/generators/common/e2e/CommonE2eGenerator.js

@@ -24,7 +24,12 @@ export default class CommonE2eGenerator extends Generator {
     ]);
 
     packageUtils.addOrRemoveScripts(pkg, this.options.enable, {
-      "test:e2e:prepare": "playwright install chromium",
+      // keeps the browsers added by hand, like webkit for iPhone projects
+      "test:e2e:prepare": pkg.scripts?.["test:e2e:prepare"]?.startsWith(
+        "playwright install ",
+      )
+        ? pkg.scripts["test:e2e:prepare"]
+        : "playwright install chromium",
       "test:e2e": "playwright test -c e2e/playwright.config.ts",
     });
 

package/lib/generators/common/format-lint/CommonLintGenerator.js

@@ -1,4 +1,5 @@
 import path from "node:path";
+import { format } from "oxfmt";
 import Generator from "yeoman-generator";
 import { quoteArg } from "../../../utils/execUtils.js";
 import inMonorepo from "../../../utils/inMonorepo.js";
@@ -13,6 +14,48 @@ import {
 } from "../../../utils/writeAndFormat.js";
 import { appIgnorePaths } from "../../app/ignorePaths.js";
 
+/**
+ * @param {string} eslintConfigPath
+ * @param {{ imports: string[], flatCascade: string[] }} eslintConfig
+ */
+const renderEslintConfig = async (
+  eslintConfigPath,
+  { imports, flatCascade },
+) => {
+  const { code } = await format(
+    eslintConfigPath,
+    `${imports.map((value) => `${value};\n`).join("")}
+export default [
+${flatCascade.map((value) => `  ${value},\n`).join("")}];
+`,
+    { printWidth: 80 },
+  );
+  return code;
+};
+
+/**
+ * Whether the content is what pob writes for one of the other configs, so it
+ * can be updated without losing changes made by hand.
+ *
+ * @param {string} eslintConfigPath
+ * @param {string} content
+ * @param {{ imports: string[], flatCascade: string[] }[]} previousEslintConfigs
+ */
+const isPreviousEslintConfigOutput = async (
+  eslintConfigPath,
+  content,
+  previousEslintConfigs,
+) => {
+  for (const eslintConfig of previousEslintConfigs) {
+    if (
+      (await renderEslintConfig(eslintConfigPath, eslintConfig)) === content
+    ) {
+      return true;
+    }
+  }
+  return false;
+};
+
 // same as the base ignores of @pob/eslint-config: ignorePatterns are not
 // inherited through "extends"
 const oxlintBaseIgnorePatterns = [
@@ -103,6 +146,13 @@ export default class CommonFormatLintGenerator extends Generator {
       description: "src directory is root",
     });
 
+    this.option("workspacesHaveReact", {
+      type: Boolean,
+      required: false,
+      default: false,
+      description: "Monorepo root: a workspace package uses react",
+    });
+
     this.option("appTypes", {
       type: String,
       required: false,
@@ -163,21 +213,16 @@ export default class CommonFormatLintGenerator extends Generator {
         ? this.options.babel === "true"
         : babelEnvs.length > 0;
     const useTypescript = this.options.typescript;
-    const hasReact = useTypescript && packageUtils.hasReact(pkg);
+    const isMonorepoRoot =
+      this.options.monorepo || Boolean(inMonorepo && inMonorepo.root);
+    // a monorepo root lints its packages: it needs the react configs when one
+    // of them uses react
+    const hasReact =
+      useTypescript &&
+      (packageUtils.hasReact(pkg) ||
+        (isMonorepoRoot && this.options.workspacesHaveReact));
     const useAppConfig = hasReact && this.options.isApp;
     const useNode = !useBabel || babelEnvs.some((env) => env.target === "node");
-    const useNodeOnly =
-      (!useBabel && !useTypescript) ||
-      (useTypescript &&
-        (!pkg.pob?.envs ||
-          pkg.pob?.envs?.every((env) => env.target === "node")) &&
-        (!pkg.pob?.entries ||
-          pkg.pob?.entries.every(
-            (entry) =>
-              typeof entry === "string" ||
-              (entry.target && entry.target !== "node"),
-          ))) ||
-      (babelEnvs.length > 0 && babelEnvs.every((env) => env.target === "node"));
 
     if (this.fs.exists(this.destinationPath(".eslintignore"))) {
       this.fs.delete(this.destinationPath(".eslintignore"));
@@ -347,7 +392,11 @@ export default class CommonFormatLintGenerator extends Generator {
         );
 
         if ((inMonorepo && inMonorepo.root) || this.options.monorepo) {
-          if (this.options.typescript) {
+          if (hasReact) {
+            packageUtils.addDevDependencies(pkg, [
+              "@pob/eslint-config-typescript-react",
+            ]);
+          } else if (this.options.typescript) {
             packageUtils.updateDevDependenciesIfPresent(pkg, [
               "@pob/eslint-config-typescript-react",
             ]);
@@ -375,7 +424,10 @@ export default class CommonFormatLintGenerator extends Generator {
       }
     }
 
-    const { imports, flatCascade } = (() => {
+    /**
+     * @param {boolean} withReact
+     */
+    const getEslintConfig = (withReact) => {
       if (pkg.name === "@pob/eslint-config-monorepo") {
         return {
           imports: [
@@ -388,53 +440,50 @@ export default class CommonFormatLintGenerator extends Generator {
         };
       }
 
+      const flatCascade = (() => {
+        if (!useTypescript) {
+          return [
+            useNode
+              ? `...pobConfig.configs.node${pkg.type === "commonjs" ? "Commonjs" : "Module"}`
+              : `...pobConfig.configs.base${pkg.type === "commonjs" ? "Commonjs" : "Module"}`,
+          ];
+        }
+        if (!withReact) {
+          return [
+            useNode ? "...pobConfig.configs.node" : "...pobConfig.configs.base",
+          ];
+        }
+
+        return [
+          useNode
+            ? "...pobTypescriptConfigReact.configs.node"
+            : "...pobTypescriptConfigReact.configs.base",
+          withReact && this.options.isApp && "...pobConfig.configs.app",
+          pkg.dependencies?.["react-native-web"] &&
+            '...pobTypescriptConfigReact.configs["react-native-web"]',
+        ];
+      })().filter(Boolean);
+
+      // non-published typescript (scripts/**/*.ts, root *.config.ts) is
+      // type-checked against tsconfig.tools.json rather than any emitting
+      // tsconfig.json; point typed lint at that project. The monorepo root
+      // owns the shared tsconfig.tools.json (its **/scripts/** glob covers
+      // package scripts too), and single repos own their own; in-monorepo
+      // packages inherit the root config.
+      if ((isMonorepoRoot || !inMonorepo) && useTypescript) {
+        flatCascade.push("...pobConfig.configs.toolsProject");
+      }
+
       return {
         imports: [
           'import pobConfig from "@pob/eslint-config"',
           useTypescript &&
-            hasReact &&
+            withReact &&
             'import pobTypescriptConfigReact from "@pob/eslint-config-typescript-react"',
         ].filter(Boolean),
-        flatCascade: (() => {
-          // TODO do something with useNodeOnly ?
-          console.log({ useNodeOnly });
-
-          if (!useTypescript) {
-            return [
-              useNode
-                ? `...pobConfig.configs.node${pkg.type === "commonjs" ? "Commonjs" : "Module"}`
-                : `...pobConfig.configs.base${pkg.type === "commonjs" ? "Commonjs" : "Module"}`,
-            ];
-          }
-          if (!hasReact) {
-            return [
-              useNode
-                ? "...pobConfig.configs.node"
-                : "...pobConfig.configs.base",
-            ];
-          }
-
-          return [
-            useNode ? "...pobConfig.configs.node" : "...pobConfig.configs.base",
-            useAppConfig && "...pobConfig.configs.app",
-            pkg.dependencies?.["react-native-web"] &&
-              '...pobTypescriptConfigReact.configs["react-native-web"]',
-          ];
-        })().filter(Boolean),
+        flatCascade,
       };
-    })();
-
-    const isMonorepoRoot =
-      this.options.monorepo || Boolean(inMonorepo && inMonorepo.root);
-    // non-published typescript (scripts/**/*.ts, root *.config.ts) is
-    // type-checked against tsconfig.tools.json rather than any emitting
-    // tsconfig.json; point typed lint at that project. The monorepo root owns
-    // the shared tsconfig.tools.json (its **/scripts/** glob covers package
-    // scripts too), and single repos own their own; in-monorepo packages
-    // inherit the root config.
-    if ((isMonorepoRoot || !inMonorepo) && useTypescript) {
-      flatCascade.push("...pobConfig.configs.toolsProject");
-    }
+    };
 
     const eslintrcBadPath = this.destinationPath(".eslintrc");
     this.fs.delete(eslintrcBadPath);
@@ -497,37 +546,44 @@ export default class CommonFormatLintGenerator extends Generator {
       };
 
       const ignorePatterns = getRootIgnorePatterns();
-      const srcDirectory =
-        useBabel || this.options.typescript ? this.options.srcDirectory : "lib";
-
-      if (this.fs.exists(eslintConfigPath)) {
-        // TODO update config !
-      } else {
-        await copyAndFormatTpl(
-          this.fs,
-          this.templatePath("eslint.config.js.ejs"),
-          eslintConfigPath,
-          {
-            imports,
-            flatCascade,
-            srcDirectory,
-            ignorePatterns: [...ignorePatterns],
-          },
+      const eslintConfigContent = await renderEslintConfig(
+        eslintConfigPath,
+        getEslintConfig(hasReact),
+      );
+      const existingEslintConfig = this.fs.read(eslintConfigPath, {
+        defaults: null,
+      });
+      if (
+        existingEslintConfig === null ||
+        // still the output of pob for other options: not edited by hand
+        (existingEslintConfig !== eslintConfigContent &&
+          (await isPreviousEslintConfigOutput(
+            eslintConfigPath,
+            existingEslintConfig,
+            [
+              getEslintConfig(!hasReact),
+              // before the react configs were used when react is detected
+              hasReact && {
+                ...getEslintConfig(hasReact),
+                flatCascade: getEslintConfig(hasReact).flatCascade.map(
+                  (config) =>
+                    config.replace(
+                      /^\.\.\.pobTypescriptConfigReact\.configs\.(node|base)$/,
+                      "...pobConfig.configs.$1",
+                    ),
+                ),
+              },
+            ].filter(Boolean),
+          )))
+      ) {
+        this.fs.write(eslintConfigPath, eslintConfigContent);
+      } else if (
+        hasReact &&
+        !existingEslintConfig.includes("@pob/eslint-config-typescript-react")
+      ) {
+        console.warn(
+          `${path.basename(eslintConfigPath)} was edited by hand and is not updated: use the configs of @pob/eslint-config-typescript-react to lint react`,
         );
-        // TODO
-        /*  settings: {
-              "import/resolver": this.options.enableSrcResolver
-                ? {
-                    node: {
-                      moduleDirectory: [
-                        "node_modules",
-                        this.options.srcDirectory,
-                      ],
-                    },
-                  }
-                : false,
-            },
-            */
       }
 
       // keeps existing options, only enforces the shared config and ignores.

package/lib/generators/common/format-lint/templates/oxfmtrc.jsonc.ejs

@@ -1,3 +1,4 @@
+// Generated by pob: do not edit, it is overwritten on each pob run.
 {
   "$schema": "./node_modules/oxfmt/configuration_schema.json",
   "printWidth": 80,

package/lib/generators/common/husky/templates/lint-staged.config.js.txt

@@ -1,3 +1,4 @@
+// Generated by pob: do not edit, it is overwritten on each pob run.
 import createLintStagedConfig from "@pob/root/createLintStagedConfig";
 
 export default createLintStagedConfig();

package/lib/generators/common/release/templates/workflow-release.yml.ejs

@@ -1,3 +1,4 @@
+# Generated by pob: do not edit, it is overwritten on each pob run.
 name: Release
 on:
   workflow_dispatch:
@@ -52,7 +53,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v6
         with:
-          version: 11
+          version: 12
 <% } -%>
 
       - uses: actions/setup-node@v7

package/lib/generators/common/testing/templates/vite.config.js.ejs

@@ -1,3 +1,4 @@
+// Generated by pob: do not edit, it is overwritten on each pob run.
 import { defineConfig } from "vitest/config";
 
 export default defineConfig({

package/lib/generators/common/transpiler/templates/app.rollup.config.mjs.ejs

@@ -1,3 +1,4 @@
+// Generated by pob: do not edit, it is overwritten on each pob run.
 import { dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import createRollupConfig from '@pob/<%= rollupConfigLib %>/createRollupConfig.js';

package/lib/generators/common/transpiler/templates/lib.rollup.config.mjs.ejs

@@ -1,3 +1,4 @@
+// Generated by pob: do not edit, it is overwritten on each pob run.
 import { dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import createRollupConfig from '@pob/<%= rollupConfigLib %>/createRollupConfig.js';

package/lib/generators/common/typescript/templates/tsconfig.check-js.json.ejs

@@ -1,3 +1,4 @@
+// Generated by pob: do not edit, it is overwritten on each pob run.
 {
   "extends": [
     "@pob/root/tsconfigs/base.json",

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

@@ -1,3 +1,4 @@
+// Generated by pob: do not edit, it is overwritten on each pob run.
 {
   "extends": [
     "@pob/root/tsconfigs/strict.json"<% if (presets.length > 0) { -%>,

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

@@ -1,3 +1,4 @@
+// Generated by pob: do not edit, it is overwritten on each pob run.
 {
   "extends": [
     "@pob/root/tsconfigs/strict.json",

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

@@ -1,3 +1,4 @@
+# Generated by pob: do not edit, it is overwritten on each pob run.
 [install]
 # Only install package versions published at least 3 days ago
 minimumReleaseAge = 259200 # seconds - in #23162 it'll allow "3d" too

package/lib/generators/core/ci/templates/github-action-documentation-workflow.yml.ejs

@@ -1,3 +1,4 @@
+# Generated by pob: do not edit, it is overwritten on each pob run.
 name: 'Create documentation and deploy to Github pages'
 on:
   push:
@@ -24,7 +25,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v6
         with:
-          version: 11
+          version: 12
 
 <% } -%>
       - uses: actions/setup-node@v7

package/lib/generators/core/ci/templates/github-action-push-workflow-split.yml.ejs

@@ -1,3 +1,4 @@
+# Generated by pob: do not edit, it is overwritten on each pob run.
 name: Push CI
 permissions:
   contents: read
@@ -25,7 +26,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v6
         with:
-          version: 11
+          version: 12
 
 <% } -%>
       - uses: actions/setup-node@v7
@@ -70,7 +71,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v6
         with:
-          version: 11
+          version: 12
 
 <% } -%>
       - uses: actions/setup-node@v7
@@ -117,7 +118,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v6
         with:
-          version: 11
+          version: 12
 
 <% } -%>
       - uses: actions/setup-node@v7
@@ -183,7 +184,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v6
         with:
-          version: 11
+          version: 12
 
 <% } -%>
       - uses: actions/setup-node@v7
@@ -259,7 +260,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v6
         with:
-          version: 11
+          version: 12
 
 <% } -%>
       - uses: actions/setup-node@v7

package/lib/generators/core/ci/templates/github-action-push-workflow.yml.ejs

@@ -1,3 +1,4 @@
+# Generated by pob: do not edit, it is overwritten on each pob run.
 name: Push CI
 permissions:
   contents: read
@@ -28,7 +29,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v6
         with:
-          version: 11
+          version: 12
 
 <% } -%>
       - name: Use Node.js ${{ matrix.node-version }}

package/lib/generators/core/claude/CoreClaudeGenerator.js

@@ -26,7 +26,7 @@ export default class CoreClaudeGenerator extends Generator {
 
     this.fs.write(
       claudeGitignorePath,
-      "/settings.local.json\n/skills/local.*\n",
+      "# Generated by pob: do not edit, it is overwritten on each pob run.\n/settings.local.json\n/skills/local.*\n",
     );
 
     const command =

package/lib/generators/core/editorconfig/templates/editorconfig

@@ -1,3 +1,4 @@
+# Generated by pob: do not edit, it is overwritten on each pob run.
 # EditorConfig helps developers define and maintain consistent
 # coding styles between different editors and IDEs
 # http://editorconfig.org