pob 19.2.0 → 21.0.0

package/lib/generators/lib/doc/LibDocGenerator.js

@@ -1,48 +1,48 @@
-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 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 LibDocGenerator extends Generator {
   constructor(args, opts) {
     super(args, opts);
 
-    this.option('enabled', {
+    this.option("enabled", {
       type: Boolean,
       required: false,
       default: true,
-      desc: 'Enabled.',
+      description: "Enabled.",
     });
 
-    this.option('testing', {
+    this.option("testing", {
       type: Boolean,
       required: false,
       default: false,
-      desc: 'Coverage.',
+      description: "Coverage.",
     });
 
-    this.option('packageManager', {
+    this.option("packageManager", {
       type: String,
-      default: 'yarn',
-      desc: 'yarn or npm',
+      default: "yarn",
+      description: "yarn or npm",
     });
 
-    this.option('packageNames', {
+    this.option("packageNames", {
       type: String,
       required: false,
-      default: '{}',
+      default: "{}",
     });
   }
 
   writing() {
-    if (this.fs.exists(this.destinationPath('jsdoc.conf.json'))) {
-      this.fs.delete(this.destinationPath('jsdoc.conf.json'));
+    if (this.fs.exists(this.destinationPath("jsdoc.conf.json"))) {
+      this.fs.delete(this.destinationPath("jsdoc.conf.json"));
     }
-    if (this.fs.exists(this.destinationPath('jsdoc.conf.js'))) {
-      this.fs.delete(this.destinationPath('jsdoc.conf.js'));
+    if (this.fs.exists(this.destinationPath("jsdoc.conf.js"))) {
+      this.fs.delete(this.destinationPath("jsdoc.conf.js"));
     }
 
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+    const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
     if (this.options.enabled) {
       const jsx =
@@ -52,14 +52,14 @@ export default class LibDocGenerator extends Generator {
 
       if (inMonorepo && inMonorepo.root) {
         const existingConfig = this.fs.readJSON(
-          this.destinationPath('tsconfig.doc.json'),
+          this.destinationPath("tsconfig.doc.json"),
           { typedocOptions: {} },
         );
         // "external-modulemap": ".*packages/([^/]+)/.*",
         const packagePaths = JSON.parse(this.options.packagePaths);
 
         const filteredPackages = packagePaths
-          .filter((pkgPath) => !pkgPath.endsWith('-example'))
+          .filter((pkgPath) => !pkgPath.endsWith("-example"))
           .map((pkgPath) => {
             return {
               path: pkgPath,
@@ -85,8 +85,8 @@ export default class LibDocGenerator extends Generator {
         }
         copyAndFormatTpl(
           this.fs,
-          this.templatePath('tsconfig.doc.json.lerna.ejs'),
-          this.destinationPath('tsconfig.doc.json'),
+          this.templatePath("tsconfig.doc.json.lerna.ejs"),
+          this.destinationPath("tsconfig.doc.json"),
           {
             jsx,
             workspaces: pkg.workspaces,
@@ -94,7 +94,7 @@ export default class LibDocGenerator extends Generator {
             packagePaths: filteredPackages.map((p) => p.path),
             repositoryUrl: pkg.homepage, // or pkg.repository.replace(/\.git$/, '')
             packageManager: this.options.packageManager,
-            readme: existingConfig.typedocOptions.readme || 'README.md',
+            readme: existingConfig.typedocOptions.readme || "README.md",
           },
         );
       } else {
@@ -103,32 +103,32 @@ export default class LibDocGenerator extends Generator {
         );
         copyAndFormatTpl(
           this.fs,
-          this.templatePath('tsconfig.doc.json.ejs'),
-          this.destinationPath('tsconfig.doc.json'),
-          { jsx, readme: 'README.md', entryPoints },
+          this.templatePath("tsconfig.doc.json.ejs"),
+          this.destinationPath("tsconfig.doc.json"),
+          { jsx, readme: "README.md", entryPoints },
         );
       }
     } else {
       // this.fs.delete(this.destinationPath('jsdoc.conf.js'));
-      if (this.fs.exists(this.destinationPath('docs'))) {
-        this.fs.delete(this.destinationPath('docs'));
+      if (this.fs.exists(this.destinationPath("docs"))) {
+        this.fs.delete(this.destinationPath("docs"));
       }
 
-      if (this.fs.exists(this.destinationPath('tsconfig.doc.json'))) {
-        this.fs.delete(this.destinationPath('tsconfig.doc.json'));
+      if (this.fs.exists(this.destinationPath("tsconfig.doc.json"))) {
+        this.fs.delete(this.destinationPath("tsconfig.doc.json"));
       }
     }
 
     packageUtils.removeDevDependencies(pkg, [
-      'jsdoc',
-      'minami',
-      'jaguarjs-jsdoc',
-      'typedoc-plugin-lerna-packages',
-      '@chrp/typedoc-plugin-lerna-packages',
+      "jsdoc",
+      "minami",
+      "jaguarjs-jsdoc",
+      "typedoc-plugin-lerna-packages",
+      "@chrp/typedoc-plugin-lerna-packages",
     ]);
 
     packageUtils.addOrRemoveDevDependencies(pkg, this.options.enabled, [
-      'typedoc',
+      "typedoc",
     ]);
 
     // packageUtils.addOrRemoveDevDependencies(
@@ -147,17 +147,17 @@ export default class LibDocGenerator extends Generator {
     // );
 
     if (pkg.scripts) {
-      delete pkg.scripts['generate:docs'];
+      delete pkg.scripts["generate:docs"];
     }
 
     if (this.options.enabled) {
       packageUtils.addScripts(pkg, {
-        'generate:api': 'typedoc --tsconfig tsconfig.doc.json',
+        "generate:api": "typedoc --tsconfig tsconfig.doc.json",
       });
     } else {
-      delete pkg.scripts['generate:api'];
+      delete pkg.scripts["generate:api"];
     }
 
-    this.fs.writeJSON(this.destinationPath('package.json'), pkg);
+    this.fs.writeJSON(this.destinationPath("package.json"), pkg);
   }
 }

package/lib/generators/lib/readme/LibReadmeGenerator.js

@@ -1,48 +1,48 @@
-import camelCase from 'lodash.camelcase';
-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 camelCase from "lodash.camelcase";
+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 LibReadmeGenerator extends Generator {
   constructor(args, opts) {
     super(args, opts);
 
-    this.option('privatePackage', {
+    this.option("privatePackage", {
       type: Boolean,
       required: true,
-      desc: 'If the project is private',
+      description: "If the project is private",
     });
 
-    this.option('documentation', {
+    this.option("documentation", {
       type: Boolean,
       required: true,
-      desc: 'Include documentation',
+      description: "Include documentation",
     });
 
-    this.option('testing', {
+    this.option("testing", {
       type: Boolean,
       required: true,
-      desc: 'Include testing badge',
+      description: "Include testing badge",
     });
 
-    this.option('codecov', {
+    this.option("codecov", {
       type: Boolean,
       required: true,
-      desc: 'Include codecov badge',
+      description: "Include codecov badge",
     });
 
-    this.option('content', {
+    this.option("content", {
       type: String,
       required: false,
-      desc: 'Readme content',
+      description: "Readme content",
     });
   }
 
   writing() {
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+    const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
-    const readmePath = this.destinationPath('README.md');
+    const readmePath = this.destinationPath("README.md");
     let content = this.options.content;
 
     if (this.fs.exists(readmePath)) {
@@ -74,7 +74,7 @@ export default class LibReadmeGenerator extends Generator {
     try {
       copyAndFormatTpl(
         this.fs,
-        this.templatePath('README.md.ejs'),
+        this.templatePath("README.md.ejs"),
         readmePath,
         {
           privatePackage: pkg.private,
@@ -93,7 +93,7 @@ export default class LibReadmeGenerator extends Generator {
           codecov: this.options.codecov,
           documentation: this.options.documentation,
           documentationUrl:
-            this.options.documentation && gitHost === 'github'
+            this.options.documentation && gitHost === "github"
               ? `https://${gitAccount}.github.io/${gitName}/`
               : undefined,
           testing: this.options.testing,

package/lib/generators/monorepo/PobMonorepoGenerator.js

@@ -1,17 +1,17 @@
-import { execSync } from 'node:child_process';
-import fs from 'node:fs';
-import { platform } from 'node:process';
-import { getPluginConfiguration } from '@yarnpkg/cli';
-import { Configuration, Project } from '@yarnpkg/core';
-import { ppath } from '@yarnpkg/fslib';
+import { execSync } from "node:child_process";
+import fs from "node:fs";
+import { platform } from "node:process";
+import { getPluginConfiguration } from "@yarnpkg/cli";
+import { Configuration, Project } from "@yarnpkg/core";
+import { ppath } from "@yarnpkg/fslib";
 import {
   buildTopologicalOrderBatches,
   buildDependenciesMaps,
   getWorkspaceName,
-} from 'yarn-workspace-utils';
-import Generator from 'yeoman-generator';
-import * as packageUtils from '../../utils/package.js';
-import { copyAndFormatTpl } from '../../utils/writeAndFormat.js';
+} from "yarn-workspace-utils";
+import Generator from "yeoman-generator";
+import * as packageUtils from "../../utils/package.js";
+import { copyAndFormatTpl } from "../../utils/writeAndFormat.js";
 
 export const createYarnProject = async () => {
   const portablePath = ppath.cwd();
@@ -28,7 +28,7 @@ export const createYarnProject = async () => {
 
 const getAppTypes = (configs) => {
   const appConfigs = configs.filter(
-    (config) => config && config.project && config.project.type === 'app',
+    (config) => config && config.project && config.project.type === "app",
   );
 
   const appTypes = new Set();
@@ -42,11 +42,10 @@ const getAppTypes = (configs) => {
 const hasDist = (packages, configs) =>
   configs.some(
     (config, index) =>
-      !!(config && config.project && config.project.type === 'lib') &&
+      !!(config && config.project && config.project.type === "lib") &&
       !!(
-        packages[index].pob &&
-        packages[index].pob.babelEnvs &&
-        packages[index].pob.babelEnvs.length > 0
+        packages[index].pob?.babelEnvs?.length > 0 ||
+        packages[index].pob?.envs?.length > 0
       ),
   );
 
@@ -56,8 +55,8 @@ const hasBuild = (packages, configs) =>
       !!(
         config &&
         config.project &&
-        config.project.type === 'app' &&
-        config.app.type === 'alp-node'
+        config.project.type === "app" &&
+        config.app.type === "alp-node"
       ),
   );
 
@@ -65,44 +64,46 @@ export default class PobMonorepoGenerator extends Generator {
   constructor(args, opts) {
     super(args, opts);
 
-    this.option('updateOnly', {
+    this.option("updateOnly", {
       type: Boolean,
       required: false,
       default: false,
-      desc: 'Avoid asking questions',
+      description: "Avoid asking questions",
     });
 
-    this.option('isAppProject', {
+    this.option("isAppProject", {
       type: Boolean,
       required: false,
       default: false,
-      desc: 'app project, no pusblishing on npm',
+      description: "app project, no pusblishing on npm",
     });
 
-    this.option('packageManager', {
+    this.option("packageManager", {
       type: String,
-      default: 'yarn',
-      desc: 'yarn or npm',
+      default: "yarn",
+      description: "yarn or npm",
     });
 
-    this.option('yarnNodeLinker', {
+    this.option("yarnNodeLinker", {
       type: String,
       required: false,
-      default: 'pnp',
-      desc: 'Defines what linker should be used for installing Node packages (useful to enable the node-modules plugin), one of: pnp, node-modules.',
+      default: "pnp",
+      description:
+        "Defines what linker should be used for installing Node packages (useful to enable the node-modules plugin), one of: pnp, node-modules.",
     });
 
-    this.option('onlyLatestLTS', {
+    this.option("onlyLatestLTS", {
       type: Boolean,
       required: true,
-      desc: 'only latest lts',
+      description: "only latest lts",
     });
 
-    this.option('disableYarnGitCache', {
+    this.option("disableYarnGitCache", {
       type: Boolean,
       required: false,
       default: false,
-      desc: 'Disable git cache. See https://yarnpkg.com/features/caching#offline-mirror.',
+      description:
+        "Disable git cache. See https://yarnpkg.com/features/caching#offline-mirror.",
     });
   }
 
@@ -119,7 +120,7 @@ export default class PobMonorepoGenerator extends Generator {
     for (const batch of batches) {
       // sort by name to ensure consistent ordering
       batch.sort((a, b) =>
-        getWorkspaceName(a).localeCompare(getWorkspaceName(b), 'en'),
+        getWorkspaceName(a).localeCompare(getWorkspaceName(b), "en"),
       );
 
       batch.forEach((workspace) => {
@@ -143,66 +144,66 @@ export default class PobMonorepoGenerator extends Generator {
   }
 
   async prompting() {
-    const config = this.config.get('monorepo');
+    const config = this.config.get("monorepo");
 
     if (this.options.updateOnly && config) {
       this.pobLernaConfig = config;
       this.pobLernaConfig.packageNames = this.packageNames;
-      this.config.set('monorepo', this.pobLernaConfig);
+      this.config.set("monorepo", this.pobLernaConfig);
       return;
     }
 
     this.pobLernaConfig = await this.prompt([
       {
-        type: 'confirm',
-        name: 'ci',
-        message: 'Would you like ci with github actions ?',
+        type: "confirm",
+        name: "ci",
+        message: "Would you like ci with github actions ?",
         default: config
           ? config.ci
-          : this.fs.exists(this.destinationPath('.circleci/config.yml')) ||
-            this.fs.exists(this.destinationPath('.github/workflows')),
+          : this.fs.exists(this.destinationPath(".circleci/config.yml")) ||
+            this.fs.exists(this.destinationPath(".github/workflows")),
       },
       {
-        type: 'confirm',
-        name: 'testing',
-        message: 'Would you like testing ?',
+        type: "confirm",
+        name: "testing",
+        message: "Would you like testing ?",
         when: (answers) => answers.ci,
         default: config ? config.testing : true,
       },
       {
-        type: 'confirm',
-        name: 'codecov',
-        message: 'Would you like code coverage ?',
+        type: "confirm",
+        name: "codecov",
+        message: "Would you like code coverage ?",
         when: (answers) => answers.ci && answers.testing,
         default: config ? config.codecov : true,
       },
       {
-        type: 'confirm',
-        name: 'documentation',
-        message: 'Would you like documentation ?',
+        type: "confirm",
+        name: "documentation",
+        message: "Would you like documentation ?",
         when: (answers) => answers.ci && !this.options.isAppProject,
         default: config ? config.documentation : true,
       },
       {
-        type: 'confirm',
-        name: 'typescript',
-        message: 'Would you like typescript monorepo ?',
+        type: "confirm",
+        name: "typescript",
+        message: "Would you like typescript monorepo ?",
         default: config ? config.typescript : true,
       },
       {
-        type: 'confirm',
-        name: 'eslint',
-        message: 'Would you like eslint in monorepo ?',
+        type: "confirm",
+        name: "eslint",
+        message: "Would you like eslint in monorepo ?",
         default: config ? config.eslint : true,
       },
     ]);
     this.pobLernaConfig.packageNames = this.packageNames;
-    this.config.set('monorepo', this.pobLernaConfig);
-    this.config.delete('pob-config');
+    this.config.set("monorepo", this.pobLernaConfig);
+    this.config.delete("pob-config");
   }
 
   default() {
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'), {});
+    const pkg = this.fs.readJSON(this.destinationPath("package.json"), {});
 
     const packageNames = this.packageNames;
     const packagePaths = this.packageLocations.filter(
@@ -213,19 +214,19 @@ export default class PobMonorepoGenerator extends Generator {
 
     if (packagePaths.length === 0 && packageNames.length > 0) {
       console.log(packageNames, packagePaths);
-      throw new Error('packages should not be empty');
+      throw new Error("packages should not be empty");
     }
 
-    this.composeWith('pob:common:husky', {});
+    this.composeWith("pob:common:husky", {});
 
     const isYarnVersionEnabled = this.pobLernaConfig.ci;
 
     const splitCIJobs = this.packageNames.length > 8;
 
-    this.composeWith('pob:common:testing', {
+    this.composeWith("pob:common:testing", {
       monorepo: true,
       enable: this.pobLernaConfig.testing,
-      runner: this.pobLernaConfig.testRunner || 'jest',
+      runner: this.pobLernaConfig.testRunner || "jest",
       disableYarnGitCache: this.options.disableYarnGitCache,
       enableReleasePlease: false,
       enableYarnVersion: isYarnVersionEnabled,
@@ -242,7 +243,7 @@ export default class PobMonorepoGenerator extends Generator {
       splitCIJobs,
     });
 
-    this.composeWith('pob:common:format-lint', {
+    this.composeWith("pob:common:format-lint", {
       monorepo: true,
       documentation: this.pobLernaConfig.documentation,
       typescript: this.pobLernaConfig.typescript,
@@ -252,15 +253,15 @@ export default class PobMonorepoGenerator extends Generator {
       yarnNodeLinker: this.options.yarnNodeLinker,
       appTypes: JSON.stringify(getAppTypes(this.packageConfigs)),
       ignorePaths: [
-        hasDist(this.packages, this.packageConfigs) && '/dist',
-        hasBuild(this.packages, this.packageConfigs) && '/build',
+        hasDist(this.packages, this.packageConfigs) && "/dist",
+        hasBuild(this.packages, this.packageConfigs) && "/build",
       ]
         .filter(Boolean)
-        .join('\n'),
+        .join("\n"),
       rootIgnorePaths: [],
     });
 
-    this.composeWith('pob:lib:doc', {
+    this.composeWith("pob:lib:doc", {
       enabled: this.pobLernaConfig.documentation,
       testing: this.pobLernaConfig.testing,
       packageNames: JSON.stringify(packageNames),
@@ -268,7 +269,7 @@ export default class PobMonorepoGenerator extends Generator {
       packageManager: this.options.packageManager,
     });
 
-    this.composeWith('pob:core:vscode', {
+    this.composeWith("pob:core:vscode", {
       root: true,
       monorepo: true,
       packageManager: this.options.packageManager,
@@ -281,16 +282,16 @@ export default class PobMonorepoGenerator extends Generator {
     });
 
     // Always add a gitignore, because npm publish uses it.
-    this.composeWith('pob:core:gitignore', {
+    this.composeWith("pob:core:gitignore", {
       root: true,
       typescript: this.pobLernaConfig.typescript,
       documentation: this.pobLernaConfig.documentation,
       testing: this.pobLernaConfig.testing,
     });
 
-    this.composeWith('pob:common:remove-old-dependencies');
+    this.composeWith("pob:common:remove-old-dependencies");
 
-    this.composeWith('pob:common:release', {
+    this.composeWith("pob:common:release", {
       enable: true,
       enablePublish: !this.options.isAppProject,
       withBabel: this.pobLernaConfig.typescript,
@@ -301,7 +302,7 @@ export default class PobMonorepoGenerator extends Generator {
       updateOnly: this.options.updateOnly,
     });
 
-    this.composeWith('pob:monorepo:typescript', {
+    this.composeWith("pob:monorepo:typescript", {
       enable: this.pobLernaConfig.typescript,
       isAppProject: this.options.isAppProject,
       packageNames: JSON.stringify(packageNames),
@@ -309,18 +310,18 @@ export default class PobMonorepoGenerator extends Generator {
       testRunner: this.pobLernaConfig.testRunner,
     });
 
-    this.fs.writeJSON(this.destinationPath('package.json'), pkg);
+    this.fs.writeJSON(this.destinationPath("package.json"), pkg);
 
-    if (platform !== 'win32') {
+    if (platform !== "win32") {
       execSync(
-        `rm -Rf ${['lib-*', 'coverage', 'docs'].filter(Boolean).join(' ')}`,
+        `rm -Rf ${["lib-*", "coverage", "docs"].filter(Boolean).join(" ")}`,
       );
     }
   }
 
   writing() {
     if (!this.options.isAppProject) {
-      const pkg = this.fs.readJSON(this.destinationPath('package.json'), {});
+      const pkg = this.fs.readJSON(this.destinationPath("package.json"), {});
 
       const rollupConfigs = [];
       this.packageLocations.forEach((location) => {
@@ -336,32 +337,32 @@ export default class PobMonorepoGenerator extends Generator {
       if (rollupConfigs.length > 0) {
         copyAndFormatTpl(
           this.fs,
-          this.templatePath('monorepo.rollup.config.mjs.ejs'),
-          this.destinationPath('rollup.config.mjs'),
+          this.templatePath("monorepo.rollup.config.mjs.ejs"),
+          this.destinationPath("rollup.config.mjs"),
           {
             configLocations: rollupConfigs,
           },
         );
       } else {
-        this.fs.delete('rollup.config.mjs');
+        this.fs.delete("rollup.config.mjs");
       }
       packageUtils.addOrRemoveScripts(pkg, rollupConfigs.length > 0, {
-        'clean:build': 'yarn workspaces foreach --parallel -A run clean:build',
-        build: 'yarn clean:build && rollup --config rollup.config.mjs',
-        watch: 'yarn clean:build && rollup --config rollup.config.mjs --watch',
+        "clean:build": "yarn workspaces foreach --parallel -A run clean:build",
+        build: "yarn clean:build && rollup --config rollup.config.mjs",
+        watch: "yarn clean:build && rollup --config rollup.config.mjs --watch",
       });
       packageUtils.addOrRemoveDevDependencies(pkg, rollupConfigs.length, [
-        '@babel/core',
-        'pob-babel',
+        "@babel/core",
+        "pob-babel",
       ]);
-      this.fs.writeJSON(this.destinationPath('package.json'), pkg);
+      this.fs.writeJSON(this.destinationPath("package.json"), pkg);
     }
 
-    this.composeWith('pob:core:sort-package');
+    this.composeWith("pob:core:sort-package");
   }
 
   end() {
-    console.log('save config');
+    console.log("save config");
     this.config.save();
   }
 }