pob 22.5.0 → 23.0.0

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [23.0.0](https://github.com/christophehurpeau/pob/compare/pob@22.5.0...pob@23.0.0) (2024-08-11)
+
+### ⚠ BREAKING CHANGES
+
+* update to eslint flat config
+
+### Features
+
+* update to eslint flat config ([9e9b530](https://github.com/christophehurpeau/pob/commit/9e9b530e1c89ad4f0fafa1af8f4a13816544f16c))
+
+Version bump for dependency: @pob/sort-eslint-config
+Version bump for dependency: @pob/sort-object
+Version bump for dependency: @pob/sort-pkg
+Version bump for dependency: yarn-workspace-utils
+Version bump for dependency: @pob/root
+
+
 ## [22.5.0](https://github.com/christophehurpeau/pob/compare/pob@22.4.1...pob@22.5.0) (2024-08-11)
 
 Version bump for dependency: @pob/root

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

@@ -1,12 +1,8 @@
-import fs from "node:fs";
 import path from "node:path";
 import Generator from "yeoman-generator";
-import ensureJsonFileFormatted from "../../../utils/ensureJsonFileFormatted.js";
 import inMonorepo from "../../../utils/inMonorepo.js";
 import * as packageUtils from "../../../utils/package.js";
-import { writeAndFormatJson } from "../../../utils/writeAndFormat.js";
 import { appIgnorePaths } from "../../app/ignorePaths.js";
-import updateEslintConfig from "./updateEslintConfig.js";
 
 export default class CommonLintGenerator extends Generator {
   constructor(args, opts) {
@@ -59,6 +55,12 @@ export default class CommonLintGenerator extends Generator {
       description: "Typescript enabled",
     });
 
+    this.option("build", {
+      type: Boolean,
+      required: false,
+      description: "Build",
+    });
+
     this.option("enableSrcResolver", {
       type: Boolean,
       required: false,
@@ -132,7 +134,7 @@ export default class CommonLintGenerator extends Generator {
       this.options.babel !== "undefined"
         ? this.options.babel === "true"
         : babelEnvs.length > 0;
-    const useTypescript = useBabel || pkg.pob?.typescript;
+    const useTypescript = this.options.typescript;
     const hasReact = useTypescript && packageUtils.hasReact(pkg);
     const useNode = !useBabel || babelEnvs.some((env) => env.target === "node");
     const useNodeOnly =
@@ -243,7 +245,6 @@ export default class CommonLintGenerator extends Generator {
     const globalEslint =
       this.options.monorepo ||
       (yoConfigPobMonorepo && yoConfigPobMonorepo.eslint !== false);
-    const globalTesting = yoConfigPobMonorepo && yoConfigPobMonorepo.testing;
     const composite = yoConfigPobMonorepo && yoConfigPobMonorepo.typescript;
     const { rootPackageManager, rootYarnNodeLinker } = inMonorepo || {};
     const lernaProjectType =
@@ -259,7 +260,10 @@ export default class CommonLintGenerator extends Generator {
       globalEslint &&
       !((inMonorepo && inMonorepo.root) || this.options.monorepo)
     ) {
-      if (!pkg.name.startsWith("@pob/eslint-config")) {
+      if (
+        !pkg.name.startsWith("@pob/eslint-config") &&
+        !pkg.name.startsWith("@pob/eslint-plugin")
+      ) {
         packageUtils.removeDevDependencies(
           pkg,
           [
@@ -348,113 +352,71 @@ export default class CommonLintGenerator extends Generator {
       }
     }
 
-    const isPobEslintConfig =
-      pkg.name === "eslint-config-pob" ||
-      pkg.name.startsWith("@pob/eslint-config") ||
-      pkg.name === "@pob/use-eslint-plugin";
-
-    const extendsConfigRoot = (() => {
-      if (isPobEslintConfig) {
-        if (pkg.name === "@pob/eslint-config-monorepo") {
-          return [
-            pkg.type === "commonjs"
-              ? "./@pob/eslint-config/lib/root-commonjs.js"
-              : "./@pob/eslint-config/lib/root-module.js",
-          ];
-        }
-        return [
-          pkg.type === "commonjs"
-            ? "../eslint-config/lib/root-commonjs.js"
-            : "../eslint-config/lib/root-module.js",
-        ];
+    const { imports, flatCascade } = (() => {
+      if (pkg.name === "@pob/eslint-config-monorepo") {
+        return {
+          imports: [
+            'import pobTypescriptConfig from "@pob/eslint-config-typescript"',
+            'import pobTypescriptConfigReact from "@pob/eslint-config-typescript-react"',
+          ],
+          flatCascade: [
+            // TODO
+          ],
+        };
       }
 
-      return [
-        pkg.type === "commonjs"
-          ? "@pob/eslint-config/root-commonjs"
-          : "@pob/eslint-config/root-module",
-      ];
-    })();
-
-    const extendsConfigSrc = (() => {
-      if (isPobEslintConfig) {
-        return [
-          pkg.type === "commonjs"
-            ? "../../eslint-config/lib/node-commonjs"
-            : "../../eslint-config/lib/node-module",
-        ];
-      }
+      return {
+        imports: [
+          useTypescript
+            ? 'import pobTypescriptConfig from "@pob/eslint-config-typescript"'
+            : 'import pobConfig from "@pob/eslint-config"',
+          useTypescript &&
+            hasReact &&
+            'import pobTypescriptConfigReact from "@pob/eslint-config-typescript-react"',
+        ].filter(Boolean),
+        flatCascade: (() => {
+          // TODO do something with useNodeOnly ?
+          console.log({ useNodeOnly });
+
+          if (!useTypescript) {
+            return [
+              useNode
+                ? "...pobConfig(import.meta.url).configs.nodeModule"
+                : "...pobConfig(import.meta.url).configs.baseModule",
+            ];
+          }
+          if (!hasReact) {
+            return [
+              useNode
+                ? "...pobTypescriptConfig(import.meta.url).configs.node"
+                : "...pobTypescriptConfig(import.meta.url).configs.base",
+            ];
+          }
 
-      if (useTypescript) {
-        return [
-          "@pob/eslint-config-typescript",
-          useNodeOnly && "@pob/eslint-config-typescript/node",
-          // useTypescript &&
-          //   pkg.pob?.rollup === false &&
-          //   '@pob/eslint-config-typescript/tsc-emit',
-          this.options.isApp && "@pob/eslint-config-typescript/app",
-          hasReact &&
-            `@pob/eslint-config-typescript-react${
+          return [
+            useNode
+              ? "...pobTypescriptConfig(import.meta.url).configs.node"
+              : "...pobTypescriptConfig(import.meta.url).configs.base",
+            `...pobTypescriptReactConfig(import.meta.url).configs.${
               pkg.dependencies?.["react-native-web"] ? "/react-native-web" : ""
             }`,
-        ].filter(Boolean);
-      }
-
-      return [
-        pkg.type === "commonjs"
-          ? "@pob/eslint-config/node-commonjs"
-          : "@pob/eslint-config/node-module",
-      ];
+            this.options.isApp &&
+              "...pobTypescriptConfig(import.meta.url).configs.app",
+          ];
+        })().filter(Boolean),
+      };
     })();
 
-    const ext = !useTypescript
-      ? `{${pkg.type === "commonjs" ? "mjs" : "cjs"},js}`
-      : `${hasReact ? "{ts,tsx}" : "ts"}`;
-
-    const testRunner = globalTesting
-      ? inMonorepo.pobConfig.monorepo.testRunner
-      : this.options.testRunner;
-    const testsOverride =
-      this.options.testing || globalTesting
-        ? {
-            files: [
-              `**/*.test.${ext}`,
-              `__tests__/**/*.${ext}`,
-              `**/__mocks__/**/*.${ext}`,
-            ],
-            ...(testRunner == null || testRunner === "jest"
-              ? { env: { jest: true } }
-              : {}),
-            rules: {
-              "import/no-extraneous-dependencies": [
-                "error",
-                { devDependencies: true },
-              ],
-            },
-          }
-        : null;
-
-    if (testsOverride) {
-      // if (!useBabel) {
-      //   testsOverride.extends = ['pob/babel'];
-      // }
-
-      if (useTypescript) {
-        testsOverride.extends = ["@pob/eslint-config-typescript/test"];
-        delete testsOverride.rules["import/no-extraneous-dependencies"];
-      }
-    }
-
     const eslintrcBadPath = this.destinationPath(".eslintrc");
     this.fs.delete(eslintrcBadPath);
     this.fs.delete(`${eslintrcBadPath}.yml`);
     this.fs.delete(`${eslintrcBadPath}.js`);
 
-    const rootEslintrcPath = this.options.rootAsSrc
+    const rootLegacyEslintrcPath = this.options.rootAsSrc
       ? false
       : this.destinationPath(".eslintrc.json");
 
-    const srcEslintrcPath = this.options.rootAsSrc
+    const srcLegacyEslintrcPath = this.options.rootAsSrc
       ? this.destinationPath(".eslintrc.json")
       : this.destinationPath(
           `${
@@ -462,96 +424,68 @@ export default class CommonLintGenerator extends Generator {
           }.eslintrc.json`,
         );
 
-    const getRootIgnorePatterns = () => {
-      const ignorePatterns = new Set();
+    if (rootLegacyEslintrcPath) this.fs.delete(rootLegacyEslintrcPath);
+    this.fs.delete(srcLegacyEslintrcPath);
 
-      if (inMonorepo && !inMonorepo.root && (useTypescript || pkg.types)) {
-        ignorePatterns.add("*.d.ts");
-      }
+    const eslintConfigPath = this.destinationPath("eslint.config.js");
 
-      if (inMonorepo && inMonorepo.root && this.options.documentation) {
-        ignorePatterns.add("/docs");
-      }
+    if (!inMonorepo || inMonorepo.root) {
+      const getRootIgnorePatterns = () => {
+        const ignorePatterns = new Set();
 
-      if ((!inMonorepo || !inMonorepo.root) && useTypescript) {
-        const buildPath = `/${this.options.buildDirectory}`;
-        if (
-          !this.options.rootIgnorePaths ||
-          !this.options.rootIgnorePaths.includes(buildPath)
-        ) {
-          ignorePatterns.add(buildPath);
+        if (useTypescript) {
+          ignorePatterns.add("*.d.ts");
         }
-      }
-      if (inMonorepo && inMonorepo.root && this.options.typescript) {
-        ignorePatterns.add("/rollup.config.mjs");
-      }
 
-      if (this.options.rootIgnorePaths) {
-        this.options.rootIgnorePaths
-          .split("\n")
-          .filter(Boolean)
-          .forEach((ignorePath) => {
-            if (ignorePath.startsWith("#")) return;
-            ignorePatterns.add(ignorePath);
-          });
-      }
+        if (inMonorepo && inMonorepo.root && this.options.documentation) {
+          ignorePatterns.add("/docs");
+        }
 
-      return ignorePatterns;
-    };
+        if ((!inMonorepo || !inMonorepo.root) && useTypescript) {
+          const buildPath = `/${this.options.buildDirectory}`;
+          if (
+            !this.options.rootIgnorePaths ||
+            !this.options.rootIgnorePaths.includes(buildPath)
+          ) {
+            ignorePatterns.add(buildPath);
+          }
+        }
+        if (inMonorepo && inMonorepo.root && this.options.build) {
+          ignorePatterns.add("/rollup.config.mjs");
+        }
 
-    if (rootEslintrcPath) {
-      try {
-        if (this.fs.exists(rootEslintrcPath)) {
-          ensureJsonFileFormatted(rootEslintrcPath);
+        if (this.options.rootIgnorePaths) {
+          this.options.rootIgnorePaths
+            .split("\n")
+            .filter(Boolean)
+            .forEach((ignorePath) => {
+              if (ignorePath.startsWith("#")) return;
+              ignorePatterns.add(ignorePath);
+            });
         }
 
-        const rootIgnorePatterns = getRootIgnorePatterns();
+        return ignorePatterns;
+      };
+
+      const ignorePatterns = getRootIgnorePatterns();
+      const srcDirectory =
+        useBabel || this.options.typescript ? this.options.srcDirectory : "lib";
 
-        const rootEslintrcConfig = updateEslintConfig(
-          this.fs.readJSON(rootEslintrcPath, {}),
+      if (this.fs.exists(eslintConfigPath)) {
+        // TODO update config !
+      } else {
+        this.fs.copyTpl(
+          this.templatePath("eslint.config.js.ejs"),
+          eslintConfigPath,
           {
-            extendsConfig: extendsConfigRoot,
-            ignorePatterns:
-              rootIgnorePatterns.size === 0
-                ? undefined
-                : [...rootIgnorePatterns],
+            imports,
+            flatCascade,
+            srcDirectory,
+            ignorePatterns: [...ignorePatterns],
           },
         );
-
-        writeAndFormatJson(this.fs, rootEslintrcPath, rootEslintrcConfig);
-      } catch (error) {
-        console.warn(`Could not parse/edit ${rootEslintrcPath}: `, error);
-      }
-    }
-    // no else: dont delete root eslintrc, src is root
-
-    if ((inMonorepo && inMonorepo.root) || this.options.monorepo) {
-      if (this.fs.exists(srcEslintrcPath)) {
-        this.fs.delete(srcEslintrcPath);
-      }
-    } else {
-      try {
-        if (this.fs.exists(srcEslintrcPath)) {
-          ensureJsonFileFormatted(srcEslintrcPath);
-        }
-
-        const ignorePatterns = this.options.rootAsSrc
-          ? getRootIgnorePatterns()
-          : new Set();
-        if (useTypescript || pkg.types) {
-          ignorePatterns.add("*.d.ts");
-        }
-
-        const srcEslintrcConfig = updateEslintConfig(
-          this.fs.readJSON(srcEslintrcPath, {}),
-          {
-            extendsConfig: extendsConfigSrc,
-            testsOverride,
-            useTypescript,
-            globalEslint,
-            ignorePatterns:
-              ignorePatterns.size === 0 ? undefined : [...ignorePatterns],
-            settings: {
+        // TODO
+        /*  settings: {
               "import/resolver": this.options.enableSrcResolver
                 ? {
                     node: {
@@ -563,39 +497,22 @@ export default class CommonLintGenerator extends Generator {
                   }
                 : false,
             },
-            relativePath: inMonorepo ? inMonorepo.relative : undefined,
-          },
-        );
-
-        writeAndFormatJson(this.fs, srcEslintrcPath, srcEslintrcConfig);
-      } catch (error) {
-        console.warn(`Could not parse/edit ${srcEslintrcPath}: `, error);
+            */
       }
+    } else {
+      this.fs.delete(eslintConfigPath);
     }
 
     // see monorepo/lerna/index.js
     if (!(inMonorepo && inMonorepo.root) && !this.options.monorepo) {
-      const srcDirectory =
-        useBabel || this.options.typescript ? this.options.srcDirectory : "lib";
-      const lintRootJsFiles = (useBabel && useNode) || !inMonorepo;
-
-      const lintPaths = [srcDirectory, "bin", "scripts", "migrations"].filter(
-        (dir) => fs.existsSync(this.destinationPath(dir)),
-      );
-
-      if (lintRootJsFiles) {
-        lintPaths.unshift("*.{js,cjs,mjs}");
-      }
-
-      const args =
-        "--report-unused-disable-directives --resolve-plugins-relative-to . --quiet";
+      const args = "--quiet";
 
       packageUtils.addScripts(pkg, {
         "lint:eslint": globalEslint
           ? `yarn ../.. run eslint ${args} ${path
               .relative("../..", ".")
               .replace("\\", "/")}`
-          : `eslint ${args} ${lintPaths.join(" ")}`,
+          : `eslint ${args} .`,
         lint: `${
           useTypescript && !composite ? "tsc && " : ""
         }yarn run lint:eslint`,

package/lib/generators/common/format-lint/templates/eslint.config.js.ejs

@@ -0,0 +1,5 @@
+<%- imports.map(v => `${v};\n`).join('') -%>
+
+export default [
+<%- flatCascade.map(v => `  ${v},\n`).join('') -%>
+];

package/lib/generators/core/npm/CoreNpmGenerator.js

@@ -50,6 +50,9 @@ export default class CoreNpmGenerator extends Generator {
 
       if (pkg.exports) {
         Object.values(pkg.exports).forEach((value) => {
+          if (typeof value === "string" && value.startsWith("./tsconfigs/")) {
+            files.add("tsconfigs");
+          }
           if (
             typeof value === "string" &&
             value.startsWith("./") &&

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

@@ -42,11 +42,14 @@
 
   // eslint config
   "eslint.workingDirectories": ["."],
-  "eslint.options": {
-    "resolvePluginsRelativeTo": ".",
-    "reportUnusedDisableDirectives": "error"
-  },
+  "eslint.useFlatConfig": true,
   "eslint.lintTask.enable": true,
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact"
+  ],
 
   // eslint & prettier formatter
   "eslint.format.enable": false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pob",
-  "version": "22.5.0",
+  "version": "23.0.0",
   "description": "Pile of bones, library generator with git/babel/typescript/typedoc/readme/jest",
   "keywords": [
     "skeleton"
@@ -40,12 +40,12 @@
   "pob": {},
   "prettier": "@pob/root/prettier-config",
   "dependencies": {
-    "@pob/eslint-config": "56.1.0",
-    "@pob/eslint-config-typescript": "56.1.0",
-    "@pob/eslint-config-typescript-react": "56.1.0",
-    "@pob/sort-eslint-config": "5.3.1",
-    "@pob/sort-object": "6.3.1",
-    "@pob/sort-pkg": "7.3.0",
+    "@pob/eslint-config": "57.3.0",
+    "@pob/eslint-config-typescript": "57.3.0",
+    "@pob/eslint-config-typescript-react": "57.3.0",
+    "@pob/sort-eslint-config": "6.0.0",
+    "@pob/sort-object": "7.0.0",
+    "@pob/sort-pkg": "8.0.0",
     "@prettier/sync": "0.5.2",
     "@types/inquirer": "9.0.7",
     "@yarnpkg/cli": "4.4.0",
@@ -64,16 +64,16 @@
     "mem-fs-editor": "11.0.1",
     "minimist": "1.2.8",
     "parse-author": "2.0.0",
-    "pob-dependencies": "13.4.1",
+    "pob-dependencies": "14.0.0",
     "prettier": "3.3.3",
     "semver": "7.6.3",
     "validate-npm-package-name": "^5.0.0",
-    "yarn-workspace-utils": "5.2.0",
+    "yarn-workspace-utils": "6.0.0",
     "yeoman-environment": "4.4.1",
     "yeoman-generator": "7.3.2"
   },
   "devDependencies": {
-    "@pob/root": "12.4.0",
+    "@pob/root": "13.0.0",
     "@types/node": "20.14.15",
     "typescript": "5.5.4"
   }

package/lib/.eslintrc.json

@@ -1,27 +0,0 @@
-{
-  "root": true,
-  "extends": ["@pob/eslint-config/node-module"],
-  "rules": {
-    "max-lines": "off",
-    "no-multi-assign": "off",
-    "no-nested-ternary": "off",
-    "no-console": "off",
-    "complexity": "off"
-  },
-  "overrides": [
-    {
-      "files": ["**/*.test.{cjs,js}", "__tests__/**/*.{cjs,js}"],
-      "env": {
-        "jest": true
-      },
-      "rules": {
-        "import/no-extraneous-dependencies": [
-          "error",
-          {
-            "devDependencies": true
-          }
-        ]
-      }
-    }
-  ]
-}