pob 19.1.1 → 20.0.0

package/lib/generators/common/typescript/CommonTypescriptGenerator.js

@@ -1,120 +1,120 @@
-import { existsSync } from 'node:fs';
-import Generator from 'yeoman-generator';
-import inMonorepo from '../../../utils/inMonorepo.js';
-import * as packageUtils from '../../../utils/package.js';
-import { copyAndFormatTpl } from '../../../utils/writeAndFormat.js';
+import { existsSync } from "node:fs";
+import Generator from "yeoman-generator";
+import inMonorepo from "../../../utils/inMonorepo.js";
+import * as packageUtils from "../../../utils/package.js";
+import { copyAndFormatTpl } from "../../../utils/writeAndFormat.js";
 
 export default class CommonTypescriptGenerator extends Generator {
   constructor(args, opts) {
     super(args, opts);
 
-    this.option('enable', {
+    this.option("enable", {
       type: Boolean,
       default: true,
-      desc: 'enable typescript',
+      desc: "enable typescript",
     });
 
-    this.option('isApp', {
+    this.option("isApp", {
       type: Boolean,
       required: true,
-      desc: 'is app',
+      desc: "is app",
     });
 
-    this.option('isAppLibrary', {
+    this.option("isAppLibrary", {
       type: Boolean,
       required: false,
       default: false,
     });
 
-    this.option('rootDir', {
+    this.option("rootDir", {
       type: String,
-      default: 'src',
-      desc: 'customize rootDir',
+      default: "src",
+      desc: "customize rootDir",
     });
 
-    this.option('srcDirectory', {
+    this.option("srcDirectory", {
       type: String,
-      default: 'src',
-      desc: 'customize srcDirectory, if different than rootDir',
+      default: "src",
+      desc: "customize srcDirectory, if different than rootDir",
     });
 
-    this.option('jsx', {
+    this.option("jsx", {
       type: Boolean,
       default: true,
-      desc: 'enable jsx with typescript',
+      desc: "enable jsx with typescript",
     });
 
-    this.option('jsxPreserve', {
+    this.option("jsxPreserve", {
       type: Boolean,
       default: false,
-      desc: 'force jsx preserve in tsconfig for legacy apps (nextjs, CRA)',
+      desc: "force jsx preserve in tsconfig for legacy apps (nextjs, CRA)",
     });
 
-    this.option('forceExcludeNodeModules', {
+    this.option("forceExcludeNodeModules", {
       type: Boolean,
       default: false,
-      desc: 'force exclude node_modules for legacy apps (nextjs, CRA)',
+      desc: "force exclude node_modules for legacy apps (nextjs, CRA)",
     });
 
-    this.option('forceAllowJs', {
+    this.option("forceAllowJs", {
       type: Boolean,
       default: false,
-      desc: 'force allow js for legacy apps (nextjs, CRA)',
+      desc: "force allow js for legacy apps (nextjs, CRA)",
     });
 
-    this.option('dom', {
+    this.option("dom", {
       type: Boolean,
       default: true,
-      desc: 'enable dom with typescript',
+      desc: "enable dom with typescript",
     });
 
-    this.option('baseUrl', {
+    this.option("baseUrl", {
       type: String,
-      default: '',
-      desc: 'baseUrl option',
+      default: "",
+      desc: "baseUrl option",
     });
 
-    this.option('resolveJsonModule', {
+    this.option("resolveJsonModule", {
       type: Boolean,
       default: false,
-      desc: 'resolveJsonModule option',
+      desc: "resolveJsonModule option",
     });
 
-    this.option('builddefs', {
+    this.option("builddefs", {
       type: Boolean,
       default: true,
-      desc: 'build .d.ts option',
+      desc: "build .d.ts option",
     });
-    this.option('plugins', {
+    this.option("plugins", {
       type: String,
-      default: '',
-      desc: 'typescript plugins',
+      default: "",
+      desc: "typescript plugins",
     });
-    this.option('nextConfig', {
+    this.option("nextConfig", {
       type: Boolean,
       default: false,
     });
-    this.option('additionalIncludes', {
+    this.option("additionalIncludes", {
       type: String,
-      default: '',
-      desc: 'typescript additional includes',
+      default: "",
+      desc: "typescript additional includes",
     });
 
-    this.option('onlyLatestLTS', {
+    this.option("onlyLatestLTS", {
       type: Boolean,
       required: false,
       default: false,
-      desc: 'only latest lts',
+      desc: "only latest lts",
     });
   }
 
   writing() {
-    if (this.fs.exists('flow-typed')) this.fs.delete('flow-typed');
-    if (this.fs.exists(this.destinationPath('.flowconfig'))) {
-      this.fs.delete(this.destinationPath('.flowconfig'));
+    if (this.fs.exists("flow-typed")) this.fs.delete("flow-typed");
+    if (this.fs.exists(this.destinationPath(".flowconfig"))) {
+      this.fs.delete(this.destinationPath(".flowconfig"));
     }
 
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+    const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
     const presets = (() => {
       const babelEnvs = pkg.pob?.babelEnvs || [];
@@ -124,39 +124,39 @@ export default class CommonTypescriptGenerator extends Generator {
 
       if (withBabel) {
         return jsx || this.options.dom
-          ? ['@pob/root/tsconfigs/targets/rollup-babel-with-dom.json']
-          : ['@pob/root/tsconfigs/targets/rollup-babel.json'];
+          ? ["@pob/root/tsconfigs/targets/rollup-babel-with-dom.json"]
+          : ["@pob/root/tsconfigs/targets/rollup-babel.json"];
       }
       if (withTypescript) {
-        const nodeVersion = this.options.onlyLatestLTS ? '20' : '18';
+        const nodeVersion = this.options.onlyLatestLTS ? "20" : "18";
         const envs = pkg.pob?.envs || [
           {
-            target: 'node',
-            version: '18',
+            target: "node",
+            version: "18",
           },
         ];
         if (pkg.pob.rollup === false || pkg.pob.bundler === false) {
           return [`@pob/root/tsconfigs/targets/node-${nodeVersion}.json`];
         }
-        if (envs && envs.every((env) => env.target === 'node')) {
+        if (envs && envs.every((env) => env.target === "node")) {
           return [
             `@pob/root/tsconfigs/targets/${
-              !pkg.pob.bundler || pkg.pob.bundler.startsWith('rollup')
-                ? 'rollup'
+              !pkg.pob.bundler || pkg.pob.bundler.startsWith("rollup")
+                ? "rollup"
                 : pkg.pob.bundler
             }-node-${nodeVersion}.json`,
           ];
         }
-        return ['@pob/root/tsconfigs/targets/rollup-es2015.json'];
+        return ["@pob/root/tsconfigs/targets/rollup-es2015.json"];
       }
 
       if (this.options.dom) {
-        return ['@pob/root/tsconfigs/targets/webpack.json'];
+        return ["@pob/root/tsconfigs/targets/webpack.json"];
       }
       return [];
     })();
 
-    packageUtils.removeDevDependencies(pkg, ['flow-bin']);
+    packageUtils.removeDevDependencies(pkg, ["flow-bin"]);
 
     if (pkg.scripts) {
       delete pkg.scripts.flow;
@@ -165,14 +165,14 @@ export default class CommonTypescriptGenerator extends Generator {
     packageUtils.addOrRemoveDevDependencies(
       pkg,
       this.options.enable ||
-        this.fs.exists(this.destinationPath('lib/index.d.ts')),
-      ['typescript'],
+        this.fs.exists(this.destinationPath("lib/index.d.ts")),
+      ["typescript"]
     );
 
-    const tsconfigPath = this.destinationPath('tsconfig.json');
-    const tsconfigCheckPath = this.destinationPath('tsconfig.check.json');
-    const tsconfigEslintPath = this.destinationPath('tsconfig.eslint.json');
-    const tsconfigBuildPath = this.destinationPath('tsconfig.build.json');
+    const tsconfigPath = this.destinationPath("tsconfig.json");
+    const tsconfigCheckPath = this.destinationPath("tsconfig.check.json");
+    const tsconfigEslintPath = this.destinationPath("tsconfig.eslint.json");
+    const tsconfigBuildPath = this.destinationPath("tsconfig.build.json");
 
     if (this.options.enable) {
       const { jsx, dom } = this.options;
@@ -192,8 +192,8 @@ export default class CommonTypescriptGenerator extends Generator {
         if (composite) {
           packageUtils.addOrRemoveDevDependencies(
             pkg,
-            inMonorepo.rootPackageManager === 'yarn',
-            ['typescript'],
+            inMonorepo.rootPackageManager === "yarn",
+            ["typescript"]
           );
 
           const packageLocations = new Map(
@@ -202,21 +202,21 @@ export default class CommonTypescriptGenerator extends Generator {
                 (packageName) =>
                   (pkg.dependencies && pkg.dependencies[packageName]) ||
                   (pkg.devDependencies && pkg.devDependencies[packageName]) ||
-                  (pkg.peerDependencies && pkg.peerDependencies[packageName]),
+                  (pkg.peerDependencies && pkg.peerDependencies[packageName])
               )
               .map((packageName) => [
                 packageName,
                 `../../${
-                  packageName[0] === '@'
+                  packageName[0] === "@"
                     ? // eslint-disable-next-line unicorn/no-nested-ternary
-                      yoConfig.pob.project.type === 'app'
+                      yoConfig.pob.project.type === "app"
                       ? `packages/${packageName.slice(
-                          packageName.indexOf('/') + 1,
+                          packageName.indexOf("/") + 1
                         )}`
                       : packageName
                     : `packages/${packageName}`
                 }`,
-              ]),
+              ])
           );
 
           monorepoPackageSrcPaths = [...packageLocations.entries()].map(
@@ -224,14 +224,14 @@ export default class CommonTypescriptGenerator extends Generator {
               packageName,
               `${packageLocation}/${
                 existsSync(`${packageLocations.get(packageName)}/tsconfig.json`)
-                  ? 'src'
-                  : 'lib'
+                  ? "src"
+                  : "lib"
               }`,
-            ],
+            ]
           );
           monorepoPackageReferences = yoConfig.pob.monorepo.packageNames
             .filter((packageName) =>
-              existsSync(`${packageLocations.get(packageName)}/tsconfig.json`),
+              existsSync(`${packageLocations.get(packageName)}/tsconfig.json`)
             )
             .map((packageName) => packageLocations.get(packageName));
           // monorepoPackageBuildReferences = yoConfig.pob.monorepo.packageNames
@@ -258,7 +258,7 @@ export default class CommonTypescriptGenerator extends Generator {
       */
       copyAndFormatTpl(
         this.fs,
-        this.templatePath('tsconfig.json.ejs'),
+        this.templatePath("tsconfig.json.ejs"),
         tsconfigPath,
         {
           emitDefinitions: this.options.builddefs,
@@ -277,12 +277,12 @@ export default class CommonTypescriptGenerator extends Generator {
           resolveJsonModule: this.options.resolveJsonModule,
           forceExcludeNodeModules: this.options.forceExcludeNodeModules,
           forceAllowJs: this.options.forceAllowJs,
-          plugins: this.options.plugins.split(',').filter(Boolean),
+          plugins: this.options.plugins.split(",").filter(Boolean),
           additionalIncludes: this.options.additionalIncludes
-            .split(',')
+            .split(",")
             .filter(Boolean),
           presets,
-        },
+        }
       );
 
       // if (
@@ -312,6 +312,6 @@ export default class CommonTypescriptGenerator extends Generator {
       this.fs.delete(tsconfigEslintPath);
     }
 
-    this.fs.writeJSON(this.destinationPath('package.json'), pkg);
+    this.fs.writeJSON(this.destinationPath("package.json"), pkg);
   }
 }

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

@@ -0,0 +1,12 @@
+{
+  "extends": [
+    "@pob/root/tsconfigs/base.json",
+    "@pob/root/tsconfigs/targets/node-18.json"
+  ],
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "noEmit": true
+  },
+  "include": ["lib/**/*.js"]
+}

package/lib/generators/core/ci/CoreCIGenerator.js

@@ -1,8 +1,8 @@
-import fs from 'node:fs';
-import Generator from 'yeoman-generator';
-import inMonorepo from '../../../utils/inMonorepo.js';
-import * as packageUtils from '../../../utils/package.js';
-import { copyAndFormatTpl } from '../../../utils/writeAndFormat.js';
+import fs from "node:fs";
+import Generator from "yeoman-generator";
+import inMonorepo from "../../../utils/inMonorepo.js";
+import * as packageUtils from "../../../utils/package.js";
+import { copyAndFormatTpl } from "../../../utils/writeAndFormat.js";
 
 export const ciContexts = [];
 
@@ -10,52 +10,52 @@ export default class CoreCIGenerator extends Generator {
   constructor(args, opts) {
     super(args, opts);
 
-    this.option('enable', {
+    this.option("enable", {
       type: Boolean,
       default: true,
-      desc: 'enable ci',
+      desc: "enable ci",
     });
 
-    this.option('enableReleasePlease', {
+    this.option("enableReleasePlease", {
       type: Boolean,
       default: true,
-      desc: 'enable release-please',
+      desc: "enable release-please",
     });
 
-    this.option('enableYarnVersion', {
+    this.option("enableYarnVersion", {
       type: Boolean,
       default: true,
-      desc: 'enable yarn version conventional commits',
+      desc: "enable yarn version conventional commits",
     });
 
-    this.option('build', {
+    this.option("build", {
       type: Boolean,
       default: true,
-      desc: 'enable build',
+      desc: "enable build",
     });
 
-    this.option('typescript', {
+    this.option("typescript", {
       type: Boolean,
       default: true,
-      desc: 'enable typescript',
+      desc: "enable typescript",
     });
 
-    this.option('testing', {
+    this.option("testing", {
       type: Boolean,
       default: true,
-      desc: 'enable testing',
+      desc: "enable testing",
     });
-    this.option('testRunner', {
+    this.option("testRunner", {
       type: String,
       required: false,
-      default: 'jest',
-      desc: 'test runner: jest | node',
+      default: "jest",
+      desc: "test runner: jest | node",
     });
 
-    this.option('e2eTesting', {
+    this.option("e2eTesting", {
       type: String,
-      default: '',
-      desc: 'e2e testing package path',
+      default: "",
+      desc: "e2e testing package path",
     });
 
     // this.option('babelEnvs', {
@@ -64,57 +64,57 @@ export default class CoreCIGenerator extends Generator {
     //   desc: 'Babel Envs',
     // });
 
-    this.option('ci', {
+    this.option("ci", {
       type: Boolean,
       required: true,
-      desc: 'ci with github actions',
+      desc: "ci with github actions",
     });
 
-    this.option('codecov', {
+    this.option("codecov", {
       type: Boolean,
       required: true,
-      desc: 'Include codecov report',
+      desc: "Include codecov report",
     });
 
-    this.option('documentation', {
+    this.option("documentation", {
       type: Boolean,
       required: true,
-      desc: 'Include documentation generation',
+      desc: "Include documentation generation",
     });
 
-    this.option('isApp', {
+    this.option("isApp", {
       type: Boolean,
       required: true,
-      desc: 'is app',
+      desc: "is app",
     });
 
-    this.option('onlyLatestLTS', {
+    this.option("onlyLatestLTS", {
       type: Boolean,
       required: true,
-      desc: 'only latest lts',
+      desc: "only latest lts",
     });
 
-    this.option('splitJobs', {
+    this.option("splitJobs", {
       type: Boolean,
       required: true,
-      desc: 'split CI jobs for faster result',
+      desc: "split CI jobs for faster result",
     });
 
-    this.option('disableYarnGitCache', {
+    this.option("disableYarnGitCache", {
       type: Boolean,
       required: false,
       default: false,
-      desc: 'Disable git cache. See https://yarnpkg.com/features/caching#offline-mirror.',
+      desc: "Disable git cache. See https://yarnpkg.com/features/caching#offline-mirror.",
     });
   }
 
   async prompting() {
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+    const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
     this.isReleasePleaseEnabled =
       this.options.enableReleasePlease &&
       !this.options.enableYarnVersion &&
-      !pkg.devDependencies?.['standard-version'];
+      !pkg.devDependencies?.["standard-version"];
 
     if (
       this.options.enableReleasePlease &&
@@ -123,9 +123,9 @@ export default class CoreCIGenerator extends Generator {
       !this.options.enableYarnVersion
     ) {
       const { enableReleasePlease } = await this.prompt({
-        type: 'confirm',
-        name: 'enableReleasePlease',
-        message: 'Would you like to enable release please ?',
+        type: "confirm",
+        name: "enableReleasePlease",
+        message: "Would you like to enable release please ?",
         default: true,
       });
       this.isReleasePleaseEnabled = enableReleasePlease;
@@ -133,12 +133,12 @@ export default class CoreCIGenerator extends Generator {
   }
 
   default() {
-    if (fs.existsSync(this.destinationPath('.circleci'))) {
-      fs.rmdirSync(this.destinationPath('.circleci'), { recursive: true });
+    if (fs.existsSync(this.destinationPath(".circleci"))) {
+      fs.rmdirSync(this.destinationPath(".circleci"), { recursive: true });
     }
 
     if (this.options.enable) {
-      const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+      const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
       const checks = !!pkg.scripts && !!pkg.scripts.checks;
       const testing =
@@ -149,16 +149,16 @@ export default class CoreCIGenerator extends Generator {
         this.fs,
         this.templatePath(
           this.options.splitJobs
-            ? 'github-action-push-workflow-split.yml.ejs'
-            : 'github-action-push-workflow.yml.ejs',
+            ? "github-action-push-workflow-split.yml.ejs"
+            : "github-action-push-workflow.yml.ejs"
         ),
-        this.destinationPath('.github/workflows/push.yml'),
+        this.destinationPath(".github/workflows/push.yml"),
         {
           packageManager: this.options.packageManager,
           disableYarnGitCache: this.options.disableYarnGitCache,
           testing,
           e2eTesting:
-            this.options.e2eTesting && this.options.e2eTesting !== 'false'
+            this.options.e2eTesting && this.options.e2eTesting !== "false"
               ? this.options.e2eTesting
               : false,
           checks,
@@ -173,64 +173,64 @@ export default class CoreCIGenerator extends Generator {
             this.isReleasePleaseEnabled &&
             inMonorepo &&
             inMonorepo.root &&
-            inMonorepo.pobConfig?.project?.type === 'lib',
-        },
+            inMonorepo.pobConfig?.project?.type === "lib",
+        }
       );
 
       ciContexts.push(
-        'reviewflow',
+        "reviewflow",
         ...(this.options.splitJobs
           ? [
-              checks && 'checks',
-              build && 'build',
-              'lint',
-              testing && !this.options.onlyLatestLTS && 'test (18)',
-              testing && 'test (20)',
+              checks && "checks",
+              build && "build",
+              "lint",
+              testing && !this.options.onlyLatestLTS && "test (18)",
+              testing && "test (20)",
             ].filter(Boolean)
           : [
-              !this.options.onlyLatestLTS && 'build (18.x)',
-              'build (20.x)',
-            ].filter(Boolean)),
+              !this.options.onlyLatestLTS && "build (18.x)",
+              "build (20.x)",
+            ].filter(Boolean))
       );
     } else {
-      this.fs.delete(this.destinationPath('.github/workflows/push.yml'));
+      this.fs.delete(this.destinationPath(".github/workflows/push.yml"));
     }
 
     if (
       this.options.enable &&
       !this.options.isApp &&
       (this.options.documentation ||
-        (this.options.testing && this.options.testing.runner !== 'node'))
+        (this.options.testing && this.options.testing.runner !== "node"))
     ) {
       copyAndFormatTpl(
         this.fs,
-        this.templatePath('github-action-documentation-workflow.yml.ejs'),
-        this.destinationPath('.github/workflows/gh-pages.yml'),
+        this.templatePath("github-action-documentation-workflow.yml.ejs"),
+        this.destinationPath(".github/workflows/gh-pages.yml"),
         {
           packageManager: this.options.packageManager,
           disableYarnGitCache: this.options.disableYarnGitCache,
           testing: this.options.testing,
           testRunner: this.options.testRunner,
           typedoc: this.options.documentation && this.options.typescript,
-        },
+        }
       );
     } else {
-      this.fs.delete(this.destinationPath('.github/workflows/gh-pages.yml'));
+      this.fs.delete(this.destinationPath(".github/workflows/gh-pages.yml"));
     }
   }
 
   writing() {
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+    const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
-    this.fs.delete(this.destinationPath('.travis.yml'));
-    this.fs.delete(this.destinationPath('circle.yml'));
+    this.fs.delete(this.destinationPath(".travis.yml"));
+    this.fs.delete(this.destinationPath("circle.yml"));
 
     if (!this.options.enable) {
-      packageUtils.removeDevDependencies(pkg, ['jest-junit-reporter']);
+      packageUtils.removeDevDependencies(pkg, ["jest-junit-reporter"]);
     } else {
-      packageUtils.removeDevDependencies(pkg, ['jest-junit-reporter']);
+      packageUtils.removeDevDependencies(pkg, ["jest-junit-reporter"]);
     }
 
-    this.fs.writeJSON(this.destinationPath('package.json'), pkg);
+    this.fs.writeJSON(this.destinationPath("package.json"), pkg);
   }
 }

package/lib/generators/core/clean/CoreCleanGenerator.js

@@ -1,20 +1,20 @@
-import Generator from 'yeoman-generator';
+import Generator from "yeoman-generator";
 
 export default class CoreCleanGenerator extends Generator {
   constructor(args, opts) {
     super(args, opts);
 
-    this.option('root', {
+    this.option("root", {
       type: Boolean,
       required: false,
       default: true,
-      desc: 'Root package.',
+      desc: "Root package.",
     });
   }
 
   writing() {
     if (!this.options.root) {
-      this.fs.delete('.idea');
+      this.fs.delete(".idea");
     }
   }
 }