pob 17.4.0 → 18.0.0

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [18.0.0](https://github.com/christophehurpeau/pob/compare/pob@17.4.0...pob@18.0.0) (2023-12-29)
+
+
+### Features
+
+* improve tsconfigs ([9112fb1](https://github.com/christophehurpeau/pob/commit/9112fb13dd1ed9ab5191a39c92140a0d8653ff3a))
+
+
+### Bug Fixes
+
+* fix documentation lcov ([ff6166f](https://github.com/christophehurpeau/pob/commit/ff6166f77ad4faf6039d0dc69337ac6e20fa10af))
+* fix experimental-test-coverage option ([d598efd](https://github.com/christophehurpeau/pob/commit/d598efd3818cd1e26dfb34f4f636bc2469400fe7))
+* fix test override existing detection ([744d556](https://github.com/christophehurpeau/pob/commit/744d5569541d27c5c4beee84a620f0e40f369b29))
+* **pob:** fix node test runner coverage ([e9ba7b1](https://github.com/christophehurpeau/pob/commit/e9ba7b1f035bb318fe9e20cddd93df295a4df1d1))
+* **pob:** fix test override existing detection ([5916c16](https://github.com/christophehurpeau/pob/commit/5916c16162a28e333410315d8d82fbf3bea2f5cc))
+* **pob:** update test runner ([29f7f0c](https://github.com/christophehurpeau/pob/commit/29f7f0c539401fcb9086fa913beb7935da7a8857))
+
+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
+
+
 ## [17.4.0](https://github.com/christophehurpeau/pob/compare/pob@17.3.0...pob@17.4.0) (2023-12-28)
 
 

package/lib/generators/app/PobAppGenerator.js

@@ -193,6 +193,7 @@ export default class PobAppGenerator extends Generator {
       enable: typescript,
       isApp: true,
       isAppLibrary,
+      nextConfig: this.appConfig.type === 'next.js',
       // nextjs now supports src
       rootDir: this.appConfig.type === 'expo' ? '.' : srcDirectory,
       srcDirectory,

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

@@ -4,7 +4,9 @@ function updateOverrides(config, testsOverride) {
   const existingTestsOverrideIndex = !config.overrides
     ? -1
     : config.overrides.findIndex(
-        (override) => override.env && override.env.jest,
+        testsOverride.env?.jest
+          ? (override) => override.env && override.env.jest
+          : (override) => override.extends.includes(testsOverride.extends[0]),
       );
   if (!testsOverride) {
     if (existingTestsOverrideIndex !== -1) {

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

@@ -123,6 +123,7 @@ export default class CommonTestingGenerator extends Generator {
         enableYarnVersion: this.options.enableYarnVersion,
         disableYarnGitCache: this.options.disableYarnGitCache,
         testing: this.options.enable,
+        testRunner: this.options.runner,
         e2eTesting: this.options.e2eTesting,
         build: this.options.build,
         typescript: this.options.typescript,
@@ -207,6 +208,8 @@ export default class CommonTestingGenerator extends Generator {
 
     const createTestCommand = ({
       coverage,
+      coverageLcov,
+      coverageJson,
       watch,
       shouldUseExperimentalVmModules,
     }) => {
@@ -217,8 +220,14 @@ export default class CommonTestingGenerator extends Generator {
               ? 'NODE_OPTIONS=--experimental-vm-modules '
               : ''
           }jest${watch ? ' --watch' : ''}${
-            coverage
-              ? ' --coverage --coverageReporters=json --coverageReporters=text'
+            coverage || coverageJson || coverageLcov
+              ? ` --coverage ${
+                  coverageLcov
+                    ? '--coverageReporters=lcov'
+                    : `--coverageReporters=json${
+                        coverageJson ? '' : ' --coverageReporters=text'
+                      }`
+                }`
               : ''
           }`;
         }
@@ -227,8 +236,16 @@ export default class CommonTestingGenerator extends Generator {
             tsTestUtil === 'ts-node'
               ? 'TS_NODE_PROJECT=tsconfig.test.json '
               : ''
-          }node ${this.options.typescript ? `${tsTestLoaderOption} ` : ''}${
-            coverage ? ' --experimental-test-coverage' : ''
+          }${
+            coverage || coverageJson || coverageLcov
+              ? `npx c8${
+                  coverageLcov || coverageJson
+                    ? ` --reporter=${coverageJson ? 'json' : 'lcov'}`
+                    : ''
+                } --src ./${this.options.srcDirectory} `
+              : ''
+          }node ${
+            this.options.typescript ? `${tsTestLoaderOption} ` : ''
           }--test ${this.options.srcDirectory}/${
             this.options.typescript ? '**/*.test.ts' : '**/*.test.js'
           }`;
@@ -251,6 +268,8 @@ export default class CommonTestingGenerator extends Generator {
         delete pkg.scripts['generate:test-coverage'];
         delete pkg.scripts['test:watch'];
         delete pkg.scripts['test:coverage'];
+        delete pkg.scripts['test:coverage:json'];
+        delete pkg.scripts['test:coverage:lcov'];
       }
 
       writeAndFormatJson(this.fs, this.destinationPath('package.json'), pkg);
@@ -282,6 +301,14 @@ export default class CommonTestingGenerator extends Generator {
             shouldUseExperimentalVmModules,
             coverage: true,
           }),
+          'test:coverage:lcov': createTestCommand({
+            shouldUseExperimentalVmModules,
+            coverageLcov: true,
+          }),
+          'test:coverage:json': createTestCommand({
+            shouldUseExperimentalVmModules,
+            coverageJson: true,
+          }),
         });
 
         if (isJestRunner) {
@@ -355,6 +382,14 @@ export default class CommonTestingGenerator extends Generator {
             shouldUseExperimentalVmModules,
             coverage: true,
           }),
+          'test:coverage:lcov': createTestCommand({
+            shouldUseExperimentalVmModules,
+            coverageLcov: true,
+          }),
+          'test:coverage:json': createTestCommand({
+            shouldUseExperimentalVmModules,
+            coverageJson: true,
+          }),
         });
 
         if (this.options.runner === 'jest') {

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

@@ -90,6 +90,10 @@ export default class CommonTypescriptGenerator extends Generator {
       default: '',
       desc: 'typescript plugins',
     });
+    this.option('nextConfig', {
+      type: Boolean,
+      default: false,
+    });
     this.option('additionalIncludes', {
       type: String,
       default: '',
@@ -141,6 +145,10 @@ export default class CommonTypescriptGenerator extends Generator {
         }
         return ['@pob/root/tsconfigs/targets/rollup-es2015.json'];
       }
+
+      if (this.options.dom) {
+        return ['@pob/root/tsconfigs/targets/webpack.json'];
+      }
       return [];
     })();
 
@@ -258,6 +266,7 @@ export default class CommonTypescriptGenerator extends Generator {
           srcDirectory: this.options.srcDirectory || this.options.rootDir,
           jsx,
           jsxPreserve: this.options.jsxPreserve,
+          nextConfig: this.options.nextConfig,
           composite,
           dom,
           baseUrl: this.options.baseUrl,

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

@@ -62,6 +62,17 @@
 <% if(forceAllowJs) { -%>
     "allowJs": true,
 <% } -%>
+<% if(nextConfig) { -%>
+    "strictNullChecks": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "lib": ["dom", "esnext"],
+    "esModuleInterop": true,
+    "isolatedModules": true,
+<% } -%>
+  <% if (resolveJsonModule) { -%>
+    "resolveJsonModule": <%= resolveJsonModule %>,
+  <% } -%>
 <% if(plugins && plugins.length > 0) { -%>
     "plugins": [<%- plugins.map((pluginName) => `{"name": "${pluginName}"}`).join(', ') %>],
 <% } -%>
@@ -69,9 +80,6 @@
 <% if(!presets || presets.length === 0) { -%>
     /* Module Resolution Options */
     "moduleResolution": "bundler" /* Specify module resolution strategy. */,
-  <% if (resolveJsonModule) { -%>
-    "resolveJsonModule": <%= resolveJsonModule %>,
-  <% } -%>
     "allowSyntheticDefaultImports": true,     /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
     "esModuleInterop": true<% if (monorepoPackageSrcPaths) { %>,<% } %>                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
 <% } -%>

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

@@ -45,6 +45,12 @@ export default class CoreCIGenerator extends Generator {
       default: true,
       desc: 'enable testing',
     });
+    this.option('testRunner', {
+      type: String,
+      required: false,
+      default: 'jest',
+      desc: 'test runner: jest | node',
+    });
 
     this.option('e2eTesting', {
       type: String,
@@ -204,6 +210,7 @@ export default class CoreCIGenerator extends Generator {
           packageManager: this.options.packageManager,
           disableYarnGitCache: this.options.disableYarnGitCache,
           testing: this.options.testing,
+          testRunner: this.options.testRunner,
           typedoc: this.options.documentation && this.options.typescript,
         },
       );

package/lib/generators/core/ci/templates/github-action-documentation-workflow.yml.ejs

@@ -32,9 +32,10 @@ jobs:
         run: yarn typedoc --tsconfig tsconfig.doc.json
 <% } -%>
 
-<% if (testing) { -%>
+<% if (testing && testRunner === 'jest') { -%>
+
       - name: Generate Coverage
-        run: yarn test --coverage --coverageReporters=lcov --coverageDirectory=docs/coverage/
+        run: yarn test:coverage:lcov --coverageDirectory=docs/coverage/
 <% } -%>
 
       - name: Create nojekyll

package/lib/generators/core/ci/templates/github-action-push-workflow.yml.ejs

@@ -61,7 +61,7 @@ jobs:
 <% if (codecov) { -%>
 
       - name: Generate Test Coverage
-        run: <%= packageManager %> run test:coverage
+        run: <%= packageManager %> run test:coverage:json
         if: startsWith(matrix.node-version, '20.')
         env:
           CI: true

package/lib/generators/lib/PobLibGenerator.js

@@ -162,22 +162,49 @@ export default class PobLibGenerator extends Generator {
     // documentation
     if (inMonorepo && !inMonorepo.root) {
       this.pobjson.documentation = false;
-    } else if (!this.updateOnly) {
+    } else {
       const answers = await this.prompt([
         {
           type: 'confirm',
           name: 'documentation',
           message: 'Would you like documentation (manually generated) ?',
+          when: !this.updateOnly || this.pobjson.documentation === undefined,
           default:
             this.pobjson.documentation != null
               ? this.pobjson.documentation
               : true,
         },
+      ]);
+
+      Object.assign(this.pobjson, answers);
+    }
+
+    // testing
+    if (!this.updateOnly || this.pobjson.testing === undefined) {
+      const { testing } = await this.prompt({
+        type: 'confirm',
+        name: 'testing',
+        message: 'Would you like testing ?',
+        default: this.pobjson.testing || false,
+      });
+      this.pobjson.testing = !testing ? false : this.pobjson.testing || {};
+    }
+
+    if (this.pobjson.testing && !(inMonorepo || inMonorepo.root)) {
+      const testingPrompts = await this.prompt([
+        {
+          type: 'confirm',
+          name: 'ci',
+          message: 'Would you like ci with github actions ?',
+          when: !this.updateOnly || this.pobjson.testing?.ci === undefined,
+          default: this.pobjson.testing.ci !== false,
+        },
         {
-          type: 'checkbox',
+          type: 'list',
           name: 'runner',
           message: 'Testing runner ?',
-          default: 'jest',
+          when: !this.updateOnly || this.pobjson.testing?.runner === undefined,
+          default: this.pobjson.testing?.runner || 'jest',
           choices: [
             {
               name: 'Jest',
@@ -189,39 +216,15 @@ export default class PobLibGenerator extends Generator {
             },
           ],
         },
+        {
+          type: 'confirm',
+          name: 'codecov',
+          message: 'Would you like codecov ?',
+          when: !this.updateOnly || this.pobjson.testing?.codecov === undefined,
+          default: this.pobjson.testing.codecov === true,
+        },
       ]);
-
-      this.pobjson.documentation = !!answers.documentation;
-      this.pobjson.runner = !!answers.runner;
-    }
-
-    // testing
-    if (!this.updateOnly) {
-      const { testing } = await this.prompt({
-        type: 'confirm',
-        name: 'testing',
-        message: 'Would you like testing ?',
-        default: this.pobjson.testing || false,
-      });
-      this.pobjson.testing = !testing ? false : this.pobjson.testing || {};
-
-      if (this.pobjson.testing && !(inMonorepo || inMonorepo.root)) {
-        const testingPrompts = await this.prompt([
-          {
-            type: 'confirm',
-            name: 'ci',
-            message: 'Would you like ci with github actions ?',
-            default: this.pobjson.testing.ci !== false,
-          },
-          {
-            type: 'confirm',
-            name: 'codecov',
-            message: 'Would you like codecov ?',
-            default: this.pobjson.testing.codecov === true,
-          },
-        ]);
-        Object.assign(this.pobjson.testing, testingPrompts);
-      }
+      Object.assign(this.pobjson.testing, testingPrompts);
     }
 
     this.fs.writeJSON(this.destinationPath('package.json'), pkg);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pob",
-  "version": "17.4.0",
+  "version": "18.0.0",
   "description": "Pile of bones, library generator with git/babel/typescript/typedoc/readme/jest",
   "keywords": [
     "skeleton"
@@ -20,13 +20,13 @@
   "engines": {
     "node": ">=18.12.0"
   },
+  "sideEffects": false,
+  "bin": "./lib/pob.js",
   "main": "./lib/index.js",
   "exports": {
     ".": "./lib/index.js",
     "./package.json": "./package.json"
   },
-  "sideEffects": false,
-  "bin": "./lib/pob.js",
   "files": [
     "lib",
     "bin"
@@ -36,15 +36,15 @@
     "lint": "yarn run lint:eslint",
     "lint:eslint": "yarn ../.. run eslint --report-unused-disable-directives --resolve-plugins-relative-to . --quiet packages/pob"
   },
-  "prettier": "@pob/root/prettier-config",
   "pob": {},
+  "prettier": "@pob/root/prettier-config",
   "dependencies": {
     "@pob/eslint-config": "53.0.0",
     "@pob/eslint-config-typescript": "53.1.0",
     "@pob/eslint-config-typescript-react": "53.0.0",
-    "@pob/sort-eslint-config": "5.2.0",
-    "@pob/sort-object": "6.2.0",
-    "@pob/sort-pkg": "6.2.0",
+    "@pob/sort-eslint-config": "5.2.1",
+    "@pob/sort-object": "6.2.1",
+    "@pob/sort-pkg": "7.0.0",
     "@types/inquirer": "9.0.7",
     "@yarnpkg/cli": "4.0.2",
     "@yarnpkg/core": "4.0.2",
@@ -62,15 +62,15 @@
     "mem-fs-editor": "11.0.0",
     "minimist": "1.2.8",
     "parse-author": "2.0.0",
-    "pob-dependencies": "10.4.0",
+    "pob-dependencies": "11.0.0",
     "prettier": "2.8.8",
     "semver": "7.5.4",
     "validate-npm-package-name": "^5.0.0",
-    "yarn-workspace-utils": "3.1.0",
+    "yarn-workspace-utils": "3.1.1",
     "yeoman-environment": "4.1.3",
     "yeoman-generator": "7.1.1"
   },
   "devDependencies": {
-    "@pob/root": "8.12.0"
+    "@pob/root": "9.0.0"
   }
 }