pob 19.2.0 → 20.0.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [20.0.0](https://github.com/christophehurpeau/pob/compare/pob@19.2.0...pob@20.0.0) (2024-05-05)
+
+Note: no notable changes
+
+Version bump for dependency: sort-eslint-config
+Version bump for dependency: sort-object
+Version bump for dependency: sort-pkg
+Version bump for dependency: yarn-workspace-utils
+Version bump for dependency: root
+
+
 ## [19.2.0](https://github.com/christophehurpeau/pob/compare/pob@19.1.1...pob@19.2.0) (2024-05-05)
 
 

package/lib/generators/app/PobAppGenerator.js

@@ -1,174 +1,174 @@
-import { execSync } from 'node:child_process';
-import { platform } from 'node:process';
-import Generator from 'yeoman-generator';
-import inMonorepo from '../../utils/inMonorepo.js';
-import * as packageUtils from '../../utils/package.js';
-import { appIgnorePaths } from './ignorePaths.js';
+import { execSync } from "node:child_process";
+import { platform } from "node:process";
+import Generator from "yeoman-generator";
+import inMonorepo from "../../utils/inMonorepo.js";
+import * as packageUtils from "../../utils/package.js";
+import { appIgnorePaths } from "./ignorePaths.js";
 
 const appsWithTypescript = [
-  'alp',
-  'next.js',
-  'remix',
-  'pobpack',
-  'expo',
-  'yarn-plugin',
+  "alp",
+  "next.js",
+  "remix",
+  "pobpack",
+  "expo",
+  "yarn-plugin",
 ];
-const appsWithBrowser = ['alp', 'next.js', 'remix'];
+const appsWithBrowser = ["alp", "next.js", "remix"];
 
 export default class PobAppGenerator extends Generator {
   constructor(args, opts) {
     super(args, opts);
 
-    this.option('updateOnly', {
+    this.option("updateOnly", {
       type: Boolean,
       required: false,
       default: false,
-      desc: 'Avoid asking questions',
+      desc: "Avoid asking questions",
     });
 
-    this.option('fromPob', {
+    this.option("fromPob", {
       type: Boolean,
       required: false,
       default: false,
     });
 
-    this.option('packageManager', {
+    this.option("packageManager", {
       type: String,
-      default: 'yarn',
-      desc: 'yarn or npm',
+      default: "yarn",
+      desc: "yarn or npm",
     });
 
-    this.option('yarnNodeLinker', {
+    this.option("yarnNodeLinker", {
       type: String,
       required: false,
-      default: 'node-modules',
-      desc: 'Defines what linker should be used for installing Node packages (useful to enable the node-modules plugin), one of: pnp, node-modules.',
+      default: "node-modules",
+      desc: "Defines what linker should be used for installing Node packages (useful to enable the node-modules plugin), one of: pnp, node-modules.",
     });
 
-    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.",
     });
   }
 
   initializing() {
     this.appConfig =
-      this.config.get('app') || this.config.get('pob-app-config');
+      this.config.get("app") || this.config.get("pob-app-config");
 
-    this.config.delete('pob-app-config'); // deprecated
+    this.config.delete("pob-app-config"); // deprecated
 
     // see lib, in case the app migrating from a lib when app were not available
-    this.config.delete('pob'); // deprecated
-    this.config.delete('pob-config'); // deprecated
-    this.fs.delete('.pob.json'); // deprecated
-    this.config.delete('pob-lib-config'); // in case coming from lib
+    this.config.delete("pob"); // deprecated
+    this.config.delete("pob-config"); // deprecated
+    this.fs.delete(".pob.json"); // deprecated
+    this.config.delete("pob-lib-config"); // in case coming from lib
   }
 
   async prompting() {
     const config = this.appConfig;
 
     if (config && this.options.updateOnly) {
-      this.config.set('app', this.appConfig);
+      this.config.set("app", this.appConfig);
       this.config.save();
       return;
     }
 
     this.appConfig = await this.prompt([
       {
-        type: 'list',
-        name: 'type',
-        message: 'What kind of app is this ?',
-        default: (config && config.type) || 'alp',
+        type: "list",
+        name: "type",
+        message: "What kind of app is this ?",
+        default: (config && config.type) || "alp",
         choices: [
-          'alp',
-          'pobpack',
-          'next.js',
-          'remix',
-          'node',
-          'node-library', // monorepo library for app. Not a real library
-          'untranspiled-library', // monorepo library for app. Not a real library
-          'alp-node',
-          'expo',
-          'other',
+          "alp",
+          "pobpack",
+          "next.js",
+          "remix",
+          "node",
+          "node-library", // monorepo library for app. Not a real library
+          "untranspiled-library", // monorepo library for app. Not a real library
+          "alp-node",
+          "expo",
+          "other",
         ],
       },
       {
-        type: 'confirm',
-        name: 'export',
-        message: 'Use next export ?',
+        type: "confirm",
+        name: "export",
+        message: "Use next export ?",
         default: false,
-        when: (values) => values.type === 'next.js',
+        when: (values) => values.type === "next.js",
       },
       {
-        type: 'confirm',
-        name: 'testing',
-        message: 'Do you want testing ?',
+        type: "confirm",
+        name: "testing",
+        message: "Do you want testing ?",
         default:
           !config || config.testing === undefined ? false : config.testing,
       },
       {
-        type: 'confirm',
-        name: 'codecov',
-        message: 'Do you want codecov ?',
+        type: "confirm",
+        name: "codecov",
+        message: "Do you want codecov ?",
         default: !config || false,
         when: (values) => values.testing,
       },
       {
-        type: 'confirm',
-        name: 'ci',
-        message: 'Do you want ci ?',
+        type: "confirm",
+        name: "ci",
+        message: "Do you want ci ?",
         default: !config || config.ci === undefined ? true : config.ci,
         when: () => !inMonorepo,
       },
     ]);
 
-    this.config.set('app', this.appConfig);
+    this.config.set("app", this.appConfig);
     this.config.save();
   }
 
   default() {
     const srcDirectory =
-      this.appConfig.type === 'yarn-plugin' ? 'sources' : 'src';
+      this.appConfig.type === "yarn-plugin" ? "sources" : "src";
     const isAppLibrary =
-      this.appConfig.type === 'node-library' ||
-      this.appConfig.type === 'untranspiled-library';
+      this.appConfig.type === "node-library" ||
+      this.appConfig.type === "untranspiled-library";
 
     if (
-      this.appConfig.type === 'node' ||
-      this.appConfig.type === 'node-library' ||
-      this.appConfig.type === 'alp-node'
+      this.appConfig.type === "node" ||
+      this.appConfig.type === "node-library" ||
+      this.appConfig.type === "alp-node"
     ) {
-      this.composeWith('pob:common:babel', {
+      this.composeWith("pob:common:babel", {
         updateOnly: this.options.updateOnly,
         onlyLatestLTS: true,
         isApp: true,
         isAppLibrary,
-        useAppConfig: this.appConfig.type === 'alp-node',
+        useAppConfig: this.appConfig.type === "alp-node",
         testing: this.appConfig.testing,
         documentation: false,
         fromPob: this.options.fromPob,
-        buildDirectory: 'build',
+        buildDirectory: "build",
       });
-      this.composeWith('pob:common:transpiler', {
+      this.composeWith("pob:common:transpiler", {
         updateOnly: this.options.updateOnly,
         onlyLatestLTS: true,
         isApp: true,
         isAppLibrary,
-        useAppConfig: this.appConfig.type === 'alp-node',
+        useAppConfig: this.appConfig.type === "alp-node",
         testing: this.appConfig.testing,
         documentation: false,
         fromPob: this.options.fromPob,
         srcDirectory,
-        buildDirectory: 'build',
+        buildDirectory: "build",
       });
     }
 
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+    const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
     if (!inMonorepo || inMonorepo.root) {
-      this.composeWith('pob:common:husky', {});
+      this.composeWith("pob:common:husky", {});
     }
 
     const babelEnvs = (pkg.pob && pkg.pob.babelEnvs) || [];
@@ -178,7 +178,7 @@ export default class PobAppGenerator extends Generator {
     const node = true;
     const browser =
       appsWithBrowser.includes(this.appConfig.type) ||
-      (babel && babelEnvs.some((env) => env.target === 'browser'));
+      (babel && babelEnvs.some((env) => env.target === "browser"));
     const jsx =
       babelEnvs.length > 0 && pkg.pob.jsx !== undefined
         ? pkg.pob.jsx
@@ -190,61 +190,61 @@ export default class PobAppGenerator extends Generator {
 
     const ignorePaths = appIgnorePaths[this.appConfig.type](
       this.appConfig,
-      pkg,
+      pkg
     ).filter(Boolean);
 
-    this.composeWith('pob:common:typescript', {
+    this.composeWith("pob:common:typescript", {
       enable: typescript,
       isApp: true,
       isAppLibrary,
-      nextConfig: this.appConfig.type === 'next.js',
+      nextConfig: this.appConfig.type === "next.js",
       // nextjs now supports src
-      rootDir: this.appConfig.type === 'expo' ? '.' : srcDirectory,
+      rootDir: this.appConfig.type === "expo" ? "." : srcDirectory,
       srcDirectory,
       builddefs: false,
       dom: browser,
       jsx,
-      jsxPreserve: this.appConfig.type === 'next.js',
-      forceExcludeNodeModules: this.appConfig.type === 'next.js',
-      forceAllowJs: this.appConfig.type === 'next.js',
+      jsxPreserve: this.appConfig.type === "next.js",
+      forceExcludeNodeModules: this.appConfig.type === "next.js",
+      forceAllowJs: this.appConfig.type === "next.js",
       updateOnly: this.options.updateOnly,
       resolveJsonModule: true,
       onlyLatestLTS: true,
       baseUrl: (() => {
         if (
-          this.appConfig.type === 'alp' ||
-          this.appConfig.type === 'pobpack' ||
-          this.appConfig.type === 'alp-node' ||
-          this.appConfig.type === 'next.js'
+          this.appConfig.type === "alp" ||
+          this.appConfig.type === "pobpack" ||
+          this.appConfig.type === "alp-node" ||
+          this.appConfig.type === "next.js"
         ) {
           return `./${srcDirectory}`;
         }
-        if (this.appConfig.type === 'remix') {
-          return '.';
+        if (this.appConfig.type === "remix") {
+          return ".";
         }
-        return '';
+        return "";
       })(),
       plugins: (() => {
-        if (this.appConfig.type === 'next.js') {
-          return 'next';
+        if (this.appConfig.type === "next.js") {
+          return "next";
         }
-        return '';
+        return "";
       })(),
       additionalIncludes: (() => {
         // if (this.appConfig.type === 'next.js') {
         //   return '.next/types/**/*.ts';
         // }
-        return '';
+        return "";
       })(),
     });
 
-    this.composeWith('pob:common:remove-old-dependencies');
+    this.composeWith("pob:common:remove-old-dependencies");
 
     const enableReleasePlease =
       !inMonorepo && this.appConfig.testing && this.appConfig.ci;
 
-    if (this.appConfig.type !== 'remix') {
-      this.composeWith('pob:common:testing', {
+    if (this.appConfig.type !== "remix") {
+      this.composeWith("pob:common:testing", {
         enable: this.appConfig.testing,
         disableYarnGitCache: this.options.disableYarnGitCache,
         enableReleasePlease,
@@ -252,11 +252,11 @@ export default class PobAppGenerator extends Generator {
         runner: this.appConfig.testing
           ? (inMonorepo
               ? inMonorepo.pobMonorepoConfig.testRunner
-              : this.appConfig.testRunner) || 'jest'
+              : this.appConfig.testRunner) || "jest"
           : undefined,
-        e2eTesting: this.appConfig.e2e ? '.' : '',
+        e2eTesting: this.appConfig.e2e ? "." : "",
         typescript,
-        build: typescript && this.appConfig.type !== 'expo',
+        build: typescript && this.appConfig.type !== "expo",
         documentation: false,
         codecov: this.appConfig.codecov,
         ci: this.appConfig.ci,
@@ -267,11 +267,11 @@ export default class PobAppGenerator extends Generator {
         srcDirectory,
       });
 
-      this.composeWith('pob:app:e2e-testing', {
+      this.composeWith("pob:app:e2e-testing", {
         enable: this.appConfig.e2e,
       });
 
-      this.composeWith('pob:common:format-lint', {
+      this.composeWith("pob:common:format-lint", {
         isApp: true,
         documentation: false,
         testing: this.appConfig.testing,
@@ -284,16 +284,16 @@ export default class PobAppGenerator extends Generator {
         enableSrcResolver: true,
         packageManager: this.options.packageManager,
         yarnNodeLinker: this.options.yarnNodeLinker,
-        rootIgnorePaths: ignorePaths.join('\n'),
+        rootIgnorePaths: ignorePaths.join("\n"),
         srcDirectory,
-        buildDirectory: this.appConfig.type === 'expo' ? '.expo' : 'build',
+        buildDirectory: this.appConfig.type === "expo" ? ".expo" : "build",
       });
 
-      this.composeWith('pob:common:release', {
+      this.composeWith("pob:common:release", {
         enable:
           !inMonorepo &&
           this.appConfig.testing &&
-          pkg.name !== 'yarn-plugin-conventional-version',
+          pkg.name !== "yarn-plugin-conventional-version",
         enablePublish: false,
         withBabel: babel,
         isMonorepo: false,
@@ -304,7 +304,7 @@ export default class PobAppGenerator extends Generator {
       });
     }
 
-    this.composeWith('pob:core:vscode', {
+    this.composeWith("pob:core:vscode", {
       root: !inMonorepo,
       monorepo: false,
       packageManager: this.options.packageManager,
@@ -315,45 +315,45 @@ export default class PobAppGenerator extends Generator {
     });
 
     // only for gitignore
-    if (this.fs.exists('.env.example')) {
-      ignorePaths.push('/.env*', '!/.env.example');
+    if (this.fs.exists(".env.example")) {
+      ignorePaths.push("/.env*", "!/.env.example");
     }
 
-    this.composeWith('pob:core:gitignore', {
+    this.composeWith("pob:core:gitignore", {
       root: !inMonorepo || inMonorepo.root,
       documentation: false,
       testing: this.appConfig.testing,
       withBabel: babel,
-      paths: ignorePaths.join('\n'),
+      paths: ignorePaths.join("\n"),
       buildInGit: false,
     });
 
-    this.composeWith('pob:core:npm', { enable: false });
+    this.composeWith("pob:core:npm", { enable: false });
 
     switch (this.appConfig.type) {
-      case 'next.js':
-        this.composeWith('pob:app:nextjs', {
+      case "next.js":
+        this.composeWith("pob:app:nextjs", {
           export: this.appConfig.export,
         });
         break;
-      case 'remix':
-        this.composeWith('pob:app:remix', {});
+      case "remix":
+        this.composeWith("pob:app:remix", {});
         break;
       // no default
     }
 
-    if (platform !== 'win32') {
+    if (platform !== "win32") {
       execSync(
-        `rm -Rf ${['lib-*', 'coverage', 'docs', 'dist']
+        `rm -Rf ${["lib-*", "coverage", "docs", "dist"]
           .filter(Boolean)
-          .join(' ')}`,
+          .join(" ")}`
       );
     }
   }
 
   writing() {
     // Re-read the content at this point because a composed generator might modify it.
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+    const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
     // if (isNpm) {
     //   if (!pkg.engines) pkg.engines = {};
@@ -363,8 +363,8 @@ export default class PobAppGenerator extends Generator {
       delete pkg.engines.yarn;
     }
 
-    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");
   }
 }

package/lib/generators/app/e2e-testing/AppE2ETestingGenerator.js

@@ -1,34 +1,34 @@
-import Generator from 'yeoman-generator';
-import * as packageUtils from '../../../utils/package.js';
+import Generator from "yeoman-generator";
+import * as packageUtils from "../../../utils/package.js";
 // import * as templateUtils from '../../../utils/templateUtils.js';
-import { writeAndFormatJson } from '../../../utils/writeAndFormat.js';
+import { writeAndFormatJson } from "../../../utils/writeAndFormat.js";
 
 export default class AppE2ETestingGenerator extends Generator {
   constructor(args, opts) {
     super(args, opts);
 
-    this.option('enable', {
+    this.option("enable", {
       type: Boolean,
       default: true,
-      desc: 'enable e2e testing',
+      desc: "enable e2e testing",
     });
 
-    this.option('ci', {
+    this.option("ci", {
       type: Boolean,
       required: true,
-      desc: 'ci',
+      desc: "ci",
     });
   }
 
   writing() {
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+    const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
     packageUtils.addOrRemoveDevDependencies(pkg, this.options.enable, [
-      '@playwright/test',
+      "@playwright/test",
     ]);
 
     packageUtils.addOrRemoveScripts(pkg, this.options.enable, {
-      'test:e2e': 'playwright test',
+      "test:e2e": "playwright test",
     });
 
     // templateUtils.addOrRemoveTemplate(
@@ -40,6 +40,6 @@ export default class AppE2ETestingGenerator extends Generator {
     if (this.options.enable) {
     }
 
-    writeAndFormatJson(this.fs, this.destinationPath('package.json'), pkg);
+    writeAndFormatJson(this.fs, this.destinationPath("package.json"), pkg);
   }
 }

package/lib/generators/app/ignorePaths.js

@@ -1,35 +1,35 @@
 export const appIgnorePaths = {
-  alp: (config) => ['# alp paths', '/build', '/public', '/data'],
-  'next.js': (config, pkg) =>
+  alp: (config) => ["# alp paths", "/build", "/public", "/data"],
+  "next.js": (config, pkg) =>
     [
-      '# next.js paths',
-      '/.next',
-      '/out',
-      '/build',
-      '/.env.local',
-      pkg?.dependencies?.tamagui ? '# tamagui' : undefined,
-      pkg?.dependencies?.tamagui ? '/.tamagui' : undefined,
+      "# next.js paths",
+      "/.next",
+      "/out",
+      "/build",
+      "/.env.local",
+      pkg?.dependencies?.tamagui ? "# tamagui" : undefined,
+      pkg?.dependencies?.tamagui ? "/.tamagui" : undefined,
     ].filter(Boolean),
-  remix: (config) => ['# remix paths', '/.cache', '/build', '/public/build'],
-  pobpack: (config) => ['/build', '/public'],
-  node: (config) => ['/build'],
-  'node-library': (config) => ['/build'],
-  'untranspiled-library': (config) => [],
-  'alp-node': (config) => ['/build'],
+  remix: (config) => ["# remix paths", "/.cache", "/build", "/public/build"],
+  pobpack: (config) => ["/build", "/public"],
+  node: (config) => ["/build"],
+  "node-library": (config) => ["/build"],
+  "untranspiled-library": (config) => [],
+  "alp-node": (config) => ["/build"],
   other: (config) => [],
   expo: (config) => [
-    '/.expo/',
-    '*.jks',
-    '*.p8',
-    '*.p12',
-    '*.key',
-    '*.mobileprovision',
-    '*.orig.*',
-    '/web-build/',
+    "/.expo/",
+    "*.jks",
+    "*.p8",
+    "*.p12",
+    "*.key",
+    "*.mobileprovision",
+    "*.orig.*",
+    "/web-build/",
 
     // only if option is enabled which is not by default
     // '# Temporary files created by Metro to check the health of the file watcher',
     // '/.metro-health-check*',
   ],
-  'yarn-plugin': (config) => [],
+  "yarn-plugin": (config) => [],
 };

package/lib/generators/app/nextjs/AppNextjsGenerator.js

@@ -1,28 +1,28 @@
-import Generator from 'yeoman-generator';
-import * as packageUtils from '../../../utils/package.js';
+import Generator from "yeoman-generator";
+import * as packageUtils from "../../../utils/package.js";
 
 export default class AppNextjsGenerator extends Generator {
   constructor(args, opts) {
     super(args, opts);
 
-    this.option('export', {
+    this.option("export", {
       type: Boolean,
       required: false,
       default: true,
-      desc: 'Use next export.',
+      desc: "Use next export.",
     });
   }
 
   writing() {
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+    const pkg = this.fs.readJSON(this.destinationPath("package.json"));
 
     packageUtils.addScripts(pkg, {
-      start: 'next dev',
-      'start:prod': 'next start',
+      start: "next dev",
+      "start:prod": "next start",
       // NODE_ENV=production is for tamagui
-      build: 'NODE_ENV=production next build',
+      build: "NODE_ENV=production next build",
     });
 
-    this.fs.writeJSON(this.destinationPath('package.json'), pkg);
+    this.fs.writeJSON(this.destinationPath("package.json"), pkg);
   }
 }