pob 22.0.0 → 22.1.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [22.1.0](https://github.com/christophehurpeau/pob/compare/pob@22.0.0...pob@22.1.0) (2024-06-08)
+
+### Features
+
+* **pob:** add __mocks__ folder in eslint config ([0b1b337](https://github.com/christophehurpeau/pob/commit/0b1b3373cb9fbe6abf1f520f5a84bc4de26d7756))
+* **pob:** add vitest dependency and very basic vite config ([ea23527](https://github.com/christophehurpeau/pob/commit/ea23527fa6c69b6e9c89a1f1287dd8aac696a3f3))
+
+Version bump for dependency: @pob/root
+
+
 ## [22.0.0](https://github.com/christophehurpeau/pob/compare/pob@21.1.0...pob@22.0.0) (2024-06-07)
 
 ### Bug Fixes

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

@@ -417,7 +417,11 @@ export default class CommonLintGenerator extends Generator {
     const testsOverride =
       this.options.testing || globalTesting
         ? {
-            files: [`**/*.test.${ext}`, `__tests__/**/*.${ext}`],
+            files: [
+              `**/*.test.${ext}`,
+              `__tests__/**/*.${ext}`,
+              `**/__mocks__/**/*.${ext}`,
+            ],
             ...(testRunner == null || testRunner === "jest"
               ? { env: { jest: true } }
               : {}),

package/lib/generators/common/testing/CommonTestingGenerator.js

@@ -249,7 +249,11 @@ export default class CommonTestingGenerator extends Generator {
       !isJestRunner ||
       (globalTesting && !enableForMonorepo)
     ) {
-      packageUtils.removeDevDependencies(pkg, ["jest", "@types/jest"]);
+      packageUtils.removeDevDependencies(pkg, [
+        "jest",
+        "@types/jest",
+        "vitest",
+      ]);
 
       delete pkg.jest;
       this.fs.delete(this.destinationPath("jest.config.js"));
@@ -339,6 +343,7 @@ export default class CommonTestingGenerator extends Generator {
     };
 
     const jestConfigPath = this.destinationPath("jest.config.json");
+    const vitestConfigPath = this.destinationPath("vite.config.js");
     packageUtils.addOrRemoveDevDependencies(
       pkg,
       this.options.enable &&
@@ -347,6 +352,14 @@ export default class CommonTestingGenerator extends Generator {
       ["jest", "@types/jest"],
     );
 
+    packageUtils.addOrRemoveDevDependencies(
+      pkg,
+      this.options.enable &&
+        (enableForMonorepo || !globalTesting) &&
+        testRunner === "vitest",
+      ["vitest"],
+    );
+
     if (!this.options.enable) {
       // if (inMonorepo) {
       //   if (pkg.scripts.test === 'echo "No tests"') {
@@ -384,247 +397,263 @@ export default class CommonTestingGenerator extends Generator {
         packageUtils.addScripts(pkg, {
           test: "yarn workspaces foreach --parallel -Av run test",
         });
-      } else if (this.options.monorepo) {
-        const shouldUseExperimentalVmModules = pkg.type === "module";
-
-        packageUtils.addScripts(pkg, {
-          test: createTestCommand({
-            workspacesPattern,
-            shouldUseExperimentalVmModules,
-          }),
-          "test:watch": createTestCommand({
-            workspacesPattern,
-            shouldUseExperimentalVmModules,
-            watch: true,
-          }),
-          "test:coverage": createTestCommand({
-            workspacesPattern,
-            shouldUseExperimentalVmModules,
-            coverage: true,
-          }),
-          "test:coverage:lcov": createTestCommand({
-            workspacesPattern,
-            shouldUseExperimentalVmModules,
-            coverageLcov: true,
-          }),
-          "test:coverage:json": createTestCommand({
-            workspacesPattern,
-            shouldUseExperimentalVmModules,
-            coverageJson: true,
-          }),
-        });
-
-        if (isJestRunner) {
-          hasReact = yoConfigPobMonorepo.packageNames.some((pkgName) =>
-            pkgName.startsWith("react-"),
-          );
-
-          const jestConfig = this.fs.readJSON(jestConfigPath, pkg.jest ?? {});
-          delete pkg.jest;
-
-          const srcDirectory = this.options.srcDirectory;
-          Object.assign(jestConfig, {
-            cacheDirectory: "./node_modules/.cache/jest",
-            testEnvironment: "node",
-            testMatch: [
-              `<rootDir>/${workspacesPattern}/*/@(${srcDirectory}|lib)/**/__tests__/**/*.${
-                transpileWithBabel ? "(ts|js|cjs|mjs)" : "(js|cjs|mjs)"
-              }${hasReact ? "?(x)" : ""}`,
-              `<rootDir>/${workspacesPattern}/*/@(${srcDirectory}|lib)/**/*.test.${
-                transpileWithBabel ? "(ts|js|cjs|mjs)" : "(js|cjs|mjs)"
-              }${hasReact ? "?(x)" : ""}`,
-            ],
-          });
-
-          if (shouldUseExperimentalVmModules) {
-            jestConfig.extensionsToTreatAsEsm = [
-              transpileWithBabel && ".ts",
-              transpileWithBabel && hasReact && ".tsx",
-            ].filter(Boolean);
-          } else {
-            delete jestConfig.extensionsToTreatAsEsm;
-          }
-
-          if (tsTestUtil === "swc" && !transpileWithBabel && withTypescript) {
-            jestConfig.transform = {
-              [hasReact ? "^.+\\.tsx?$" : "^.+\\.ts$"]: ["@swc/jest"],
-            };
-          } else if (jestConfig.transform) {
-            jestConfig.transform = Object.fromEntries(
-              Object.entries(jestConfig.transform).filter(
-                ([key, value]) =>
-                  value !== "@swc/jest" &&
-                  !(Array.isArray(value) && value[0] === "@swc/jest"),
-              ),
-            );
-            if (Object.keys(jestConfig.transform).length === 0) {
-              delete jestConfig.transform;
-            }
-          }
-
-          writeAndFormatJson(this.fs, jestConfigPath, jestConfig);
-        }
       } else {
-        const tsconfigTestPath = this.destinationPath("tsconfig.test.json");
-        if (testRunner === "node" && withTypescript) {
-          const nodeVersion = this.options.onlyLatestLTS ? "20" : "18";
+        if (this.testRunner === "vitest") {
           copyAndFormatTpl(
             this.fs,
-            this.templatePath("tsconfig.test.json.ejs"),
-            tsconfigTestPath,
+            this.templatePath("vite.config.js.ejs"),
+            vitestConfigPath,
             {
-              nodeVersion,
+              srcDirectory: this.options.srcDirectory,
             },
           );
-        } else {
-          this.fs.delete(tsconfigTestPath);
         }
 
-        if (globalTesting) {
-          if (pkg.scripts) {
-            delete pkg.scripts["generate:test-coverage"];
-            delete pkg.scripts["test:watch"];
-            delete pkg.scripts["test:coverage"];
-          }
-          packageUtils.addScripts(pkg, {
-            test: `yarn ../../ run test -- ${path
-              .relative("../..", ".")
-              .replace("\\", "/")}`,
-          });
-        } else {
-          const withTypescript =
-            pkg.pob?.envs?.length > 0 ||
-            pkg.pob?.bundler === "rollup-babel" ||
-            pkg.pob?.typescript;
-
-          const shouldUseExperimentalVmModules =
-            pkg.type === "module" && !inMonorepo;
+        if (this.options.monorepo) {
+          const shouldUseExperimentalVmModules = pkg.type === "module";
 
           packageUtils.addScripts(pkg, {
-            test: createTestCommand({ shouldUseExperimentalVmModules }),
+            test: createTestCommand({
+              workspacesPattern,
+              shouldUseExperimentalVmModules,
+            }),
             "test:watch": createTestCommand({
+              workspacesPattern,
               shouldUseExperimentalVmModules,
               watch: true,
             }),
             "test:coverage": createTestCommand({
+              workspacesPattern,
               shouldUseExperimentalVmModules,
               coverage: true,
             }),
             "test:coverage:lcov": createTestCommand({
+              workspacesPattern,
               shouldUseExperimentalVmModules,
               coverageLcov: true,
             }),
             "test:coverage:json": createTestCommand({
+              workspacesPattern,
               shouldUseExperimentalVmModules,
               coverageJson: true,
             }),
           });
 
-          if (testRunner === "jest") {
-            const srcDirectory = this.options.build
-              ? this.options.srcDirectory
-              : "lib";
+          if (isJestRunner) {
+            hasReact = yoConfigPobMonorepo.packageNames.some((pkgName) =>
+              pkgName.startsWith("react-"),
+            );
 
             const jestConfig = this.fs.readJSON(jestConfigPath, pkg.jest ?? {});
             delete pkg.jest;
+
+            const srcDirectory = this.options.srcDirectory;
             Object.assign(jestConfig, {
               cacheDirectory: "./node_modules/.cache/jest",
+              testEnvironment: "node",
               testMatch: [
-                `<rootDir>/${srcDirectory}/**/__tests__/**/*.${
-                  withTypescript ? "ts" : "?(m)js"
+                `<rootDir>/${workspacesPattern}/*/@(${srcDirectory}|lib)/**/__tests__/**/*.${
+                  transpileWithBabel ? "(ts|js|cjs|mjs)" : "(js|cjs|mjs)"
                 }${hasReact ? "?(x)" : ""}`,
-                `<rootDir>/${srcDirectory}/**/*.test.${
-                  withTypescript ? "ts" : "?(m)js"
+                `<rootDir>/${workspacesPattern}/*/@(${srcDirectory}|lib)/**/*.test.${
+                  transpileWithBabel ? "(ts|js|cjs|mjs)" : "(js|cjs|mjs)"
                 }${hasReact ? "?(x)" : ""}`,
               ],
-              collectCoverageFrom: [
-                `${srcDirectory}/**/*.${withTypescript ? "ts" : "?(m)js"}${
-                  hasReact ? "?(x)" : ""
-                }`,
-              ],
-              moduleFileExtensions: [
-                withTypescript && "ts",
-                withTypescript && hasReact && "tsx",
-                "js",
-                // 'jsx',
-                "json",
-              ].filter(Boolean),
-              // transform: {
-              //   [`^.+\\.ts${hasReact ? 'x?' : ''}$`]: 'babel-jest',
-              // },
             });
-            if (transpileWithEsbuild) {
-              jestConfig.transform = {
-                [hasReact ? "^.+\\.tsx?$" : "^.+\\.ts$"]: [
-                  "jest-esbuild",
-                  {
-                    format: shouldUseExperimentalVmModules ? "esm" : "cjs",
-                  },
-                ],
-              };
-            } else if (!transpileWithBabel && !withTypescript) {
-              delete jestConfig.transform;
-            } else {
-              if (
-                tsTestUtil === "swc" &&
-                !transpileWithBabel &&
-                withTypescript
-              ) {
-                jestConfig.transform = {
-                  [hasReact ? "^.+\\.tsx?$" : "^.+\\.ts$"]: ["@swc/jest"],
-                };
-              } else if (jestConfig.transform) {
-                jestConfig.transform = Object.fromEntries(
-                  Object.entries(jestConfig.transform).filter(
-                    ([key, value]) =>
-                      value !== "@swc/jest" &&
-                      !(Array.isArray(value) && value[0] === "@swc/jest"),
-                  ),
-                );
-                if (Object.keys(jestConfig.transform).length === 0) {
-                  delete jestConfig.transform;
-                }
-              }
-
-              if (jestConfig.transform) {
-                jestConfig.transform = Object.fromEntries(
-                  Object.entries(jestConfig.transform).filter(
-                    ([key, value]) =>
-                      !(
-                        value &&
-                        Array.isArray(value) &&
-                        value[0] === "jest-esbuild"
-                      ),
-                  ),
-                );
-                if (Object.keys(jestConfig.transform).length === 0) {
-                  delete jestConfig.transform;
-                }
-              }
-            }
 
             if (shouldUseExperimentalVmModules) {
               jestConfig.extensionsToTreatAsEsm = [
-                withTypescript && ".ts",
-                withTypescript && hasReact && ".tsx",
+                transpileWithBabel && ".ts",
+                transpileWithBabel && hasReact && ".tsx",
               ].filter(Boolean);
             } else {
               delete jestConfig.extensionsToTreatAsEsm;
             }
 
-            if (
-              !pkg.pob?.envs ||
-              pkg.pob?.envs.length === 0 ||
-              pkg.pob?.envs.some((env) => env.target === "node")
-            ) {
-              // jestConfig.testEnvironment = 'node'; this is the default now
-              delete jestConfig.testEnvironment;
-            } else {
-              delete jestConfig.testEnvironment;
+            if (tsTestUtil === "swc" && !transpileWithBabel && withTypescript) {
+              jestConfig.transform = {
+                [hasReact ? "^.+\\.tsx?$" : "^.+\\.ts$"]: ["@swc/jest"],
+              };
+            } else if (jestConfig.transform) {
+              jestConfig.transform = Object.fromEntries(
+                Object.entries(jestConfig.transform).filter(
+                  ([key, value]) =>
+                    value !== "@swc/jest" &&
+                    !(Array.isArray(value) && value[0] === "@swc/jest"),
+                ),
+              );
+              if (Object.keys(jestConfig.transform).length === 0) {
+                delete jestConfig.transform;
+              }
             }
 
             writeAndFormatJson(this.fs, jestConfigPath, jestConfig);
           }
+        } else {
+          const tsconfigTestPath = this.destinationPath("tsconfig.test.json");
+          if (testRunner === "node" && withTypescript) {
+            const nodeVersion = this.options.onlyLatestLTS ? "20" : "18";
+            copyAndFormatTpl(
+              this.fs,
+              this.templatePath("tsconfig.test.json.ejs"),
+              tsconfigTestPath,
+              {
+                nodeVersion,
+              },
+            );
+          } else {
+            this.fs.delete(tsconfigTestPath);
+          }
+
+          if (globalTesting) {
+            if (pkg.scripts) {
+              delete pkg.scripts["generate:test-coverage"];
+              delete pkg.scripts["test:watch"];
+              delete pkg.scripts["test:coverage"];
+            }
+            packageUtils.addScripts(pkg, {
+              test: `yarn ../../ run test -- ${path
+                .relative("../..", ".")
+                .replace("\\", "/")}`,
+            });
+          } else {
+            const withTypescript =
+              pkg.pob?.envs?.length > 0 ||
+              pkg.pob?.bundler === "rollup-babel" ||
+              pkg.pob?.typescript;
+
+            const shouldUseExperimentalVmModules =
+              pkg.type === "module" && !inMonorepo;
+
+            packageUtils.addScripts(pkg, {
+              test: createTestCommand({ shouldUseExperimentalVmModules }),
+              "test:watch": createTestCommand({
+                shouldUseExperimentalVmModules,
+                watch: true,
+              }),
+              "test:coverage": createTestCommand({
+                shouldUseExperimentalVmModules,
+                coverage: true,
+              }),
+              "test:coverage:lcov": createTestCommand({
+                shouldUseExperimentalVmModules,
+                coverageLcov: true,
+              }),
+              "test:coverage:json": createTestCommand({
+                shouldUseExperimentalVmModules,
+                coverageJson: true,
+              }),
+            });
+
+            if (testRunner === "jest") {
+              const srcDirectory = this.options.build
+                ? this.options.srcDirectory
+                : "lib";
+
+              const jestConfig = this.fs.readJSON(
+                jestConfigPath,
+                pkg.jest ?? {},
+              );
+              delete pkg.jest;
+              Object.assign(jestConfig, {
+                cacheDirectory: "./node_modules/.cache/jest",
+                testMatch: [
+                  `<rootDir>/${srcDirectory}/**/__tests__/**/*.${
+                    withTypescript ? "ts" : "?(m)js"
+                  }${hasReact ? "?(x)" : ""}`,
+                  `<rootDir>/${srcDirectory}/**/*.test.${
+                    withTypescript ? "ts" : "?(m)js"
+                  }${hasReact ? "?(x)" : ""}`,
+                ],
+                collectCoverageFrom: [
+                  `${srcDirectory}/**/*.${withTypescript ? "ts" : "?(m)js"}${
+                    hasReact ? "?(x)" : ""
+                  }`,
+                ],
+                moduleFileExtensions: [
+                  withTypescript && "ts",
+                  withTypescript && hasReact && "tsx",
+                  "js",
+                  // 'jsx',
+                  "json",
+                ].filter(Boolean),
+                // transform: {
+                //   [`^.+\\.ts${hasReact ? 'x?' : ''}$`]: 'babel-jest',
+                // },
+              });
+              if (transpileWithEsbuild) {
+                jestConfig.transform = {
+                  [hasReact ? "^.+\\.tsx?$" : "^.+\\.ts$"]: [
+                    "jest-esbuild",
+                    {
+                      format: shouldUseExperimentalVmModules ? "esm" : "cjs",
+                    },
+                  ],
+                };
+              } else if (!transpileWithBabel && !withTypescript) {
+                delete jestConfig.transform;
+              } else {
+                if (
+                  tsTestUtil === "swc" &&
+                  !transpileWithBabel &&
+                  withTypescript
+                ) {
+                  jestConfig.transform = {
+                    [hasReact ? "^.+\\.tsx?$" : "^.+\\.ts$"]: ["@swc/jest"],
+                  };
+                } else if (jestConfig.transform) {
+                  jestConfig.transform = Object.fromEntries(
+                    Object.entries(jestConfig.transform).filter(
+                      ([key, value]) =>
+                        value !== "@swc/jest" &&
+                        !(Array.isArray(value) && value[0] === "@swc/jest"),
+                    ),
+                  );
+                  if (Object.keys(jestConfig.transform).length === 0) {
+                    delete jestConfig.transform;
+                  }
+                }
+
+                if (jestConfig.transform) {
+                  jestConfig.transform = Object.fromEntries(
+                    Object.entries(jestConfig.transform).filter(
+                      ([key, value]) =>
+                        !(
+                          value &&
+                          Array.isArray(value) &&
+                          value[0] === "jest-esbuild"
+                        ),
+                    ),
+                  );
+                  if (Object.keys(jestConfig.transform).length === 0) {
+                    delete jestConfig.transform;
+                  }
+                }
+              }
+
+              if (shouldUseExperimentalVmModules) {
+                jestConfig.extensionsToTreatAsEsm = [
+                  withTypescript && ".ts",
+                  withTypescript && hasReact && ".tsx",
+                ].filter(Boolean);
+              } else {
+                delete jestConfig.extensionsToTreatAsEsm;
+              }
+
+              if (
+                !pkg.pob?.envs ||
+                pkg.pob?.envs.length === 0 ||
+                pkg.pob?.envs.some((env) => env.target === "node")
+              ) {
+                // jestConfig.testEnvironment = 'node'; this is the default now
+                delete jestConfig.testEnvironment;
+              } else {
+                delete jestConfig.testEnvironment;
+              }
+
+              writeAndFormatJson(this.fs, jestConfigPath, jestConfig);
+            }
+          }
         }
       }
     }

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

@@ -0,0 +1,13 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    setupFiles: ["<%= srcDirectory %>/tests/setup.ts"],
+    include: ["<%= srcDirectory %>/**/__tests__/**/*.ts?(x)", "<%= srcDirectory %>/**/*.test.ts?(x)"],
+    coverage: {
+      include: ["<%= srcDirectory %>/**/*.ts?(x)"],
+      reportsDirectory: "docs/coverage",
+      reporter: (process.env.POB_VITEST_COVERAGE || "json,text").split(","),
+    },
+  },
+});

package/lib/generators/lib/PobLibGenerator.js

@@ -213,6 +213,10 @@ export default class PobLibGenerator extends Generator {
           when: !this.updateOnly || this.pobjson.testing?.runner === undefined,
           default: this.pobjson.testing?.runner || "jest",
           choices: [
+            {
+              name: "Vitest",
+              value: "vitest",
+            },
             {
               name: "Jest",
               value: "jest",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pob",
-  "version": "22.0.0",
+  "version": "22.1.0",
   "description": "Pile of bones, library generator with git/babel/typescript/typedoc/readme/jest",
   "keywords": [
     "skeleton"
@@ -64,7 +64,7 @@
     "mem-fs-editor": "11.0.1",
     "minimist": "1.2.8",
     "parse-author": "2.0.0",
-    "pob-dependencies": "13.0.0",
+    "pob-dependencies": "13.1.0",
     "prettier": "3.3.1",
     "semver": "7.6.2",
     "validate-npm-package-name": "^5.0.0",
@@ -73,7 +73,7 @@
     "yeoman-generator": "7.2.0"
   },
   "devDependencies": {
-    "@pob/root": "12.0.0",
+    "@pob/root": "12.1.0",
     "@types/node": "20.14.2",
     "typescript": "5.4.5"
   }