pob 39.3.0 → 40.0.0

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

@@ -1,5 +1,9 @@
+import { execFileSync } from "node:child_process";
+import fs from "node:fs";
 import path from "node:path";
+import { runTransform } from "@pob/codemods";
 import { format } from "oxfmt";
+import semver from "semver";
 import Generator from "yeoman-generator";
 import { quoteArg } from "../../../utils/execUtils.js";
 import inMonorepo from "../../../utils/inMonorepo.js";
@@ -56,6 +60,23 @@ const isPreviousEslintConfigOutput = async (
   return false;
 };
 
+// from this major, eslint no longer runs the rules checked by oxlint
+const OXLINT_ONLY_ESLINT_CONFIG_MAJOR = 68;
+
+/**
+ * Whether the project used a version of @pob/eslint-config running the rules
+ * checked by oxlint in eslint too.
+ *
+ * @param {string | undefined} range
+ */
+const isBeforeOxlintOnlyEslintConfig = (range) => {
+  if (!range || !semver.validRange(range)) return false;
+  const minVersion = semver.minVersion(range);
+  return (
+    minVersion !== null && minVersion.major < OXLINT_ONLY_ESLINT_CONFIG_MAJOR
+  );
+};
+
 // same as the base ignores of @pob/eslint-config: ignorePatterns are not
 // inherited through "extends"
 const oxlintBaseIgnorePatterns = [
@@ -202,6 +223,12 @@ export default class CommonFormatLintGenerator extends Generator {
 
   async writing() {
     const pkg = this.fs.readJSON(this.destinationPath("package.json"));
+    // the codemods run once from the root, which lints the whole project
+    this.runOxlintOnlyCodemods =
+      (!inMonorepo || inMonorepo.root || this.options.monorepo) &&
+      isBeforeOxlintOnlyEslintConfig(
+        pkg.devDependencies?.["@pob/eslint-config"],
+      );
     const babelEnvs =
       (pkg.pob &&
         (pkg.pob.babelEnvs ||
@@ -379,17 +406,14 @@ export default class CommonFormatLintGenerator extends Generator {
         pkg.name !== "@pob/use-eslint-plugin"
       ) {
         packageUtils.addDevDependencies(pkg, ["@pob/eslint-config"]);
-        packageUtils.addOrRemoveDevDependencies(
-          pkg,
-          shouldHavePluginsDependencies,
-          ["eslint-plugin-import", "eslint-plugin-unicorn"],
-        );
-
-        packageUtils.addOrRemoveDevDependencies(
-          pkg,
-          shouldHavePluginsDependencies,
-          ["eslint-plugin-node"],
-        );
+        // eslint plugins are dependencies of @pob/eslint-config, loaded by
+        // the flat config
+        packageUtils.removeDevDependencies(pkg, [
+          "eslint-plugin-import",
+          "eslint-plugin-node",
+          "eslint-plugin-unicorn",
+          "@typescript-eslint/eslint-plugin",
+        ]);
 
         if ((inMonorepo && inMonorepo.root) || this.options.monorepo) {
           if (hasReact) {
@@ -405,16 +429,18 @@ export default class CommonFormatLintGenerator extends Generator {
               "@pob/eslint-config-typescript-react",
             ]);
           }
+          // import-x loads the TypeScript parser by name, from the project
+          // with yarn PnP
           packageUtils.addOrRemoveDevDependencies(
             pkg,
             this.options.typescript && shouldHavePluginsDependencies,
-            ["@typescript-eslint/eslint-plugin", "@typescript-eslint/parser"],
+            ["@typescript-eslint/parser"],
           );
         } else {
           packageUtils.addOrRemoveDevDependencies(
             pkg,
             useTypescript && shouldHavePluginsDependencies,
-            ["@typescript-eslint/eslint-plugin", "@typescript-eslint/parser"],
+            ["@typescript-eslint/parser"],
           );
 
           packageUtils.addOrRemoveDevDependencies(pkg, hasReact, [
@@ -426,8 +452,10 @@ export default class CommonFormatLintGenerator extends Generator {
 
     /**
      * @param {boolean} withReact
+     * @param {boolean} [legacy] the output of pob before @pob/eslint-config
+     *   68, to update it
      */
-    const getEslintConfig = (withReact) => {
+    const getEslintConfig = (withReact, legacy = false) => {
       if (pkg.name === "@pob/eslint-config-monorepo") {
         return {
           imports: [
@@ -441,16 +469,19 @@ export default class CommonFormatLintGenerator extends Generator {
       }
 
       const flatCascade = (() => {
-        if (!useTypescript) {
+        if (!useTypescript && legacy) {
           return [
             useNode
               ? `...pobConfig.configs.node${pkg.type === "commonjs" ? "Commonjs" : "Module"}`
               : `...pobConfig.configs.base${pkg.type === "commonjs" ? "Commonjs" : "Module"}`,
           ];
         }
-        if (!withReact) {
+        // configs.node and configs.baseModule handle "type": "commonjs"
+        if (!useTypescript || !withReact) {
           return [
-            useNode ? "...pobConfig.configs.node" : "...pobConfig.configs.base",
+            useNode
+              ? "...pobConfig.configs.node"
+              : `...pobConfig.configs.${legacy ? "base" : "baseModule"}`,
           ];
         }
 
@@ -458,7 +489,7 @@ export default class CommonFormatLintGenerator extends Generator {
           useNode
             ? "...pobTypescriptConfigReact.configs.node"
             : "...pobTypescriptConfigReact.configs.base",
-          withReact && this.options.isApp && "...pobConfig.configs.app",
+          legacy && this.options.isApp && "...pobConfig.configs.app",
           pkg.dependencies?.["react-native-web"] &&
             '...pobTypescriptConfigReact.configs["react-native-web"]',
         ];
@@ -560,20 +591,25 @@ export default class CommonFormatLintGenerator extends Generator {
           (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) =>
+            [false, true]
+              .flatMap((legacy) => [
+                getEslintConfig(!hasReact, legacy),
+                legacy && getEslintConfig(hasReact, legacy),
+                // before the react configs were used when react is detected
+                hasReact && {
+                  ...getEslintConfig(hasReact, legacy),
+                  flatCascade: getEslintConfig(
+                    hasReact,
+                    legacy,
+                  ).flatCascade.map((config) =>
                     config.replace(
                       /^\.\.\.pobTypescriptConfigReact\.configs\.(node|base)$/,
                       "...pobConfig.configs.$1",
                     ),
-                ),
-              },
-            ].filter(Boolean),
+                  ),
+                },
+              ])
+              .filter(Boolean),
           )))
       ) {
         this.fs.write(eslintConfigPath, eslintConfigContent);
@@ -599,19 +635,20 @@ export default class CommonFormatLintGenerator extends Generator {
         ...oxlintConfig,
         extends: [
           pobOxlintConfigPath("base"),
-          // ES module rules, not for configs.nodeCommonjs
+          // ES module rules, not for .js files of "type": "commonjs" packages
           (useTypescript || pkg.type !== "commonjs") &&
             pobOxlintConfigPath("module"),
-          // like configs.node and configs.nodeModule (not configs.nodeCommonjs)
+          useNode && pobOxlintConfigPath("node"),
+          // .js files of "type": "commonjs" packages, after node.json
           useNode &&
-            (useTypescript || pkg.type !== "commonjs") &&
-            pobOxlintConfigPath("node"),
+            !useTypescript &&
+            pkg.type === "commonjs" &&
+            pobOxlintConfigPath("commonjs"),
           // type-aware rules: oxlint fails without tsgolint, even in a
           // project without TypeScript files
           useTypescript && pobOxlintConfigPath("typescript"),
-          // overrides of typescript.json, like the matching eslint configs
-          // (configs.app, configs.allowUnsafe, ...). Only app is known here:
-          // the others are kept when added by hand.
+          // overrides of typescript.json. Only app is known here: the others
+          // are kept when added by hand.
           ...(useTypescript
             ? [
                 "app",
@@ -626,8 +663,7 @@ export default class CommonFormatLintGenerator extends Generator {
                 )
                 .map(pobOxlintConfigPath)
             : []),
-          // like the @pob/eslint-config-typescript-react configs, after
-          // module.json and node.json: they override import/extensions.
+          // after module.json and node.json: they override import/extensions.
           // react-native.json is kept when added by hand.
           ...(hasReact
             ? ["react", "react-native", "react-native-web"]
@@ -688,4 +724,38 @@ export default class CommonFormatLintGenerator extends Generator {
 
     this.fs.writeJSON(this.destinationPath("package.json"), pkg);
   }
+
+  /**
+   * Updates eslint-disable comments and eslint.config.js for
+   * @pob/eslint-config running the rules checked by oxlint in oxlint only.
+   */
+  async end() {
+    if (!this.runOxlintOnlyCodemods) return;
+    const cwd = this.destinationPath();
+    const files = execFileSync(
+      "git",
+      ["ls-files", "--cached", "--others", "--exclude-standard"],
+      { cwd, encoding: "utf8" },
+    )
+      .split("\n")
+      .filter((file) => /\.[cm]?[jt]sx?$/.test(file) && !file.endsWith(".d.ts"))
+      .map((file) => path.join(cwd, file));
+    console.log(
+      "@pob/eslint-config 68: rewriting eslint-disable comments of rules checked by oxlint",
+    );
+    await runTransform("oxlint-directives", files, { silent: true });
+
+    const eslintConfigPath = ["eslint.config.js", "eslint.config.mjs"]
+      .map((fileName) => path.join(cwd, fileName))
+      .find((filePath) => fs.existsSync(filePath));
+    if (eslintConfigPath) {
+      await runTransform("oxlint-eslint-config", [eslintConfigPath]);
+      const { code } = await format(
+        eslintConfigPath,
+        fs.readFileSync(eslintConfigPath, "utf8"),
+        { printWidth: 80 },
+      );
+      fs.writeFileSync(eslintConfigPath, code);
+    }
+  }
 }

package/lib/utils/dependenciesPackages.cjs

@@ -1,5 +1,3 @@
 "use strict";
 
 exports.pobEslintConfig = require("@pob/eslint-config/package.json");
-
-exports.pobEslintConfigTypescriptReact = require("@pob/eslint-config-typescript-react/package.json");

package/lib/utils/package.js

@@ -5,10 +5,7 @@ import sortPkg from "@pob/sort-pkg";
 import parseAuthor from "parse-author";
 import pobDependencies from "pob-dependencies";
 import semver from "semver";
-import {
-  pobEslintConfig,
-  pobEslintConfigTypescriptReact,
-} from "./dependenciesPackages.cjs";
+import { pobEslintConfig } from "./dependenciesPackages.cjs";
 import pobPkg from "./packagejson.js";
 
 export { default as parseAuthor } from "parse-author";
@@ -63,24 +60,8 @@ const internalRemoveDependencies = (pkg, type, dependencyKeys) => {
 };
 
 const getVersionFromDependencyName = (dependency) => {
-  if (
-    [
-      // 'eslint-import-resolver-node',
-      "eslint-plugin-import",
-      "eslint-plugin-node",
-      "eslint-plugin-unicorn",
-    ].includes(dependency)
-  ) {
-    return pobEslintConfig.dependencies[dependency];
-  }
-  if (["eslint-plugin-jsx-a11y", "eslint-plugin-react"].includes(dependency)) {
-    return pobEslintConfigTypescriptReact.dependencies[dependency];
-  }
-  if (
-    ["@typescript-eslint/eslint-plugin", "@typescript-eslint/parser"].includes(
-      dependency,
-    )
-  ) {
+  // loaded by name by import-x, from the project with yarn PnP
+  if (dependency === "@typescript-eslint/parser") {
     return pobEslintConfig.dependencies[dependency];
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pob",
-  "version": "39.3.0",
+  "version": "40.0.0",
   "description": "Pile of bones, library generator with git/babel/typescript/typedoc/readme/vitest",
   "keywords": [
     "skeleton"
@@ -31,8 +31,9 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@pob/eslint-config": "67.14.0",
-    "@pob/eslint-config-typescript-react": "67.14.0",
+    "@pob/codemods": "0.18.0",
+    "@pob/eslint-config": "68.0.0",
+    "@pob/eslint-config-typescript-react": "68.0.0",
     "@pob/sort-object": "11.2.0",
     "@pob/sort-pkg": "13.2.0",
     "@types/inquirer": "9.0.10",
@@ -50,7 +51,7 @@
     "minimist": "1.2.8",
     "oxfmt": "0.72.0",
     "parse-author": "2.0.0",
-    "pob-dependencies": "27.14.0",
+    "pob-dependencies": "28.0.0",
     "semver": "7.8.5",
     "typescript": "npm:@typescript/typescript6@6.0.2",
     "validate-npm-package-name": "^8.0.0",
@@ -58,7 +59,7 @@
     "yeoman-generator": "10.0.1"
   },
   "devDependencies": {
-    "@pob/root": "27.17.0",
+    "@pob/root": "28.0.0",
     "@types/node": "24.19.1",
     "@typescript/native": "npm:typescript@7.0.2",
     "@yeoman/types": "1.13.1"