pob 9.7.4 → 9.8.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [9.8.0](https://github.com/christophehurpeau/pob/compare/pob@9.7.4...pob@9.8.0) (2021-12-12)
+
+
+### Bug Fixes
+
+* **pob:** dont try release-please if release is disabled ([86d6edf](https://github.com/christophehurpeau/pob/commit/86d6edf3e84cf98c0605044e09fb994fb036a3cc))
+* sort package after running yarn version update ([b9773f0](https://github.com/christophehurpeau/pob/commit/b9773f0ac08c857b87836cbb2a665557f652bffd))
+* **deps:** update @pob/eslint-config to v48.0.6 ([#1137](https://github.com/christophehurpeau/pob/issues/1137)) ([999b411](https://github.com/christophehurpeau/pob/commit/999b411e0e4a1c0a47e3c8f23ca20694ca8f2451))
+
+
+### Features
+
+* **pob:** add env in app gitignore ([148a02a](https://github.com/christophehurpeau/pob/commit/148a02a9437b638051b384c7bd61ce1195cae8aa))
+* allow to configure resolveJsonModule and fix baseUrl in tsconfig for apps ([d68393f](https://github.com/christophehurpeau/pob/commit/d68393f9bf02598aa3638e21d2dc407b9b282d1b))
+* **pob:** allow release-please in apps ([6d567c6](https://github.com/christophehurpeau/pob/commit/6d567c6ee49f4faa26d7ab23f042615134681158))
+* **pob:** suggest to enable release-please ([f62e46c](https://github.com/christophehurpeau/pob/commit/f62e46c8fd9e5936b10790288b14f516e9d8e6d6))
+* conditional publish in release workflow ([162c83e](https://github.com/christophehurpeau/pob/commit/162c83ed7875d7caeaef43169742eef8742825f5))
+
+
+
+
+
 ## [9.7.4](https://github.com/christophehurpeau/pob/compare/pob@9.7.3...pob@9.7.4) (2021-12-12)
 
 

package/lib/generators/app/PobAppGenerator.js

@@ -1,3 +1,4 @@
+import fs from 'fs';
 import Generator from 'yeoman-generator';
 import inLerna from '../../utils/inLerna.js';
 import inNpmLerna from '../../utils/inNpmLerna.js';
@@ -132,10 +133,12 @@ export default class PobAppGenerator extends Generator {
       dom: browser,
       jsx,
       updateOnly: this.options.updateOnly,
+      resolveJsonModule: true,
       baseUrl: (() => {
         if (
           this.appConfig.type === 'alp' ||
-          this.appConfig.type === 'pobpack'
+          this.appConfig.type === 'pobpack' ||
+          this.appConfig.type === 'node'
         ) {
           return './src';
         }
@@ -168,6 +171,21 @@ export default class PobAppGenerator extends Generator {
       ignorePaths: ignorePaths.join('\n'),
     });
 
+    this.composeWith('pob:common:release', {
+      enable: !inLerna && this.appConfig.testing && this.appConfig.ci,
+      withBabel: babel,
+      documentation: false,
+      updateOnly: this.options.updateOnly,
+    });
+
+    // only for gitignore
+    if (this.fs.exists('.env.example')) {
+      ignorePaths.push('/.env*', '!/.env.example');
+    }
+    if (fs.existsSync('private_key')) {
+      ignorePaths.push('/private_key');
+    }
+
     this.composeWith('pob:core:gitignore', {
       root: !inLerna || inLerna.root,
       documentation: false,

package/lib/generators/{lib/release/LibReleaseGenerator.js → common/release/CommonReleaseGenerator.js}

@@ -2,7 +2,7 @@ import Generator from 'yeoman-generator';
 import inLerna from '../../../utils/inLerna.js';
 import * as packageUtils from '../../../utils/package.js';
 
-export default class LibReleaseGenerator extends Generator {
+export default class CommonReleaseGenerator extends Generator {
   constructor(args, opts) {
     super(args, opts);
 
@@ -24,16 +24,41 @@ export default class LibReleaseGenerator extends Generator {
       required: true,
       desc: 'Include documentation',
     });
-  }
 
-  writing() {
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+    this.option('updateOnly', {
+      type: Boolean,
+      required: false,
+      defaults: false,
+      desc: 'Avoid asking questions',
+    });
+  }
 
-    const isReleasePleaseEnabled =
+  async prompting() {
+    this.isReleasePleaseEnabled =
       this.options.enable &&
       this.fs.exists(
         this.destinationPath('.github/workflows/release-please.yml'),
       );
+
+    if (
+      this.options.enable &&
+      !process.env.CI &&
+      !this.isReleasePleaseEnabled
+    ) {
+      const { enableReleasePlease } = await this.prompt({
+        type: 'confirm',
+        name: 'enableReleasePlease',
+        message: 'Would you like to enable release please ?',
+        default: true,
+      });
+      this.isReleasePleaseEnabled = enableReleasePlease;
+    }
+  }
+
+  writing() {
+    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+
+    const isReleasePleaseEnabled = this.isReleasePleaseEnabled;
     const isStandardVersionEnabled =
       this.options.enable && !isReleasePleaseEnabled;
 
@@ -79,7 +104,7 @@ export default class LibReleaseGenerator extends Generator {
         this.destinationPath('.github/workflows/release-please.yml'),
         {
           isLerna: !!inLerna,
-          // publish: ...
+          publish: !pkg.private,
         },
       );
     }

package/lib/generators/{lib → common}/release/templates/release-please.yml.ejs

@@ -27,8 +27,10 @@ jobs:
           node-version: 14
           registry-url: 'https://registry.npmjs.org'
         if: ${{ steps.release.outputs.release_created }}
+<% if (publish) { -%>
 
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
         if: ${{ steps.release.outputs.release_created }}
+<% } -%>

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

@@ -32,6 +32,12 @@ export default class CommonTypescriptGenerator extends Generator {
       desc: 'baseUrl option',
     });
 
+    this.option('resolveJsonModule', {
+      type: Boolean,
+      defaults: false,
+      desc: 'resolveJsonModule option',
+    });
+
     this.option('builddefs', {
       type: Boolean,
       defaults: true,
@@ -116,6 +122,7 @@ export default class CommonTypescriptGenerator extends Generator {
           jsx,
           dom,
           baseUrl: this.options.baseUrl,
+          resolveJsonModule: this.options.resolveJsonModule,
         },
       );
       if (

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

@@ -31,6 +31,9 @@
     "moduleResolution": "node",               /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
     "allowSyntheticDefaultImports": true,     /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
     "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    <% if (resolveJsonModule) { -%>
+    "resolveJsonModule": <%= resolveJsonModule %>,
+    <% } -%>
     "baseUrl": "<%= baseUrl %>"<% if (monorepoPackageNames) { %>,<% } %><%= '                            '.slice(0, -(baseUrl.length + (monorepoPackageNames ? 1 : 0))) %>/* Base directory to resolve non-absolute module names. */
     <% if (monorepoPackageNames && monorepoPackageNames.length !== 0) { -%>
 

package/lib/generators/core/yarn/CoreYarnGenerator.js

@@ -1,6 +1,7 @@
 import fs from 'fs';
 import yarnParsers from '@yarnpkg/parsers';
 import Generator from 'yeoman-generator';
+import ensureJsonFileFormatted from '../../../utils/ensureJsonFileFormatted.js';
 import inLerna from '../../../utils/inLerna.js';
 import * as packageUtils from '../../../utils/package.js';
 import { writeAndFormat } from '../../../utils/writeAndFormat.js';
@@ -40,6 +41,7 @@ export default class CoreYarnGenerator extends Generator {
         this.spawnCommandSync('yarn', ['set', 'version', 'latest']);
       } else {
         this.spawnCommandSync('yarn', ['set', 'version', 'latest']);
+        ensureJsonFileFormatted(this.destinationPath('package.json'));
       }
     }
   }

package/lib/generators/lib/PobLibGenerator.js

@@ -275,10 +275,11 @@ export default class PobLibGenerator extends Generator {
       codecov: this.pobjson.testing && this.pobjson.testing.codecov,
     });
 
-    this.composeWith('pob:lib:release', {
+    this.composeWith('pob:common:release', {
       enable: !inLerna && this.pobjson.testing && this.pobjson.testing.ci,
       withBabel: babelEnvs.length > 0,
       documentation: !!this.pobjson.documentation,
+      updateOnly: this.options.updateOnly,
     });
 
     // must be after doc, testing

package/lib/pob.js

@@ -12,6 +12,7 @@ import CommonBabelGenerator from './generators/common/babel/CommonBabelGenerator
 import CommonLintGenerator from './generators/common/format-lint/CommonLintGenerator.js';
 import CommonHuskyGenerator from './generators/common/husky/CommonHuskyGenerator.js';
 import CommonRemoveOldDependenciesGenerator from './generators/common/old-dependencies/CommonRemoveOldDependenciesGenerator.js';
+import CommonReleaseGenerator from './generators/common/release/CommonReleaseGenerator.js';
 import CommonTestingGenerator from './generators/common/testing/CommonTestingGenerator.js';
 import CommonTypescriptGenerator from './generators/common/typescript/CommonTypescriptGenerator.js';
 import CoreCIGenerator from './generators/core/ci/CoreCIGenerator.js';
@@ -29,7 +30,6 @@ import CoreYarnGenerator from './generators/core/yarn/CoreYarnGenerator.js';
 import PobLibGenerator from './generators/lib/PobLibGenerator.js';
 import LibDocGenerator from './generators/lib/doc/LibDocGenerator.js';
 import LibReadmeGenerator from './generators/lib/readme/LibReadmeGenerator.js';
-import LibReleaseGenerator from './generators/lib/release/LibReleaseGenerator.js';
 import PobMonorepoGenerator from './generators/monorepo/PobMonorepoGenerator.js';
 import MonorepoLernaGenerator from './generators/monorepo/lerna/MonorepoLernaGenerator.js';
 import MonorepoTypescriptGenerator from './generators/monorepo/typescript/MonorepoTypescriptGenerator.js';
@@ -103,6 +103,11 @@ env.registerStub(
   'pob:common:remove-old-dependencies',
   `${__dirname}/generators/common/old-dependencies/CommonRemoveOldDependenciesGenerator.js`,
 );
+env.registerStub(
+  CommonReleaseGenerator,
+  'pob:common:release',
+  `${__dirname}/generators/common/release/CommonReleaseGenerator.js`,
+);
 env.registerStub(
   CommonTestingGenerator,
   'pob:common:testing',
@@ -188,11 +193,6 @@ env.registerStub(
   'pob:lib:readme',
   `${__dirname}/generators/lib/readme/LibReadmeGenerator.js`,
 );
-env.registerStub(
-  LibReleaseGenerator,
-  'pob:lib:release',
-  `${__dirname}/generators/lib/release/LibReleaseGenerator.js`,
-);
 env.registerStub(
   PobMonorepoGenerator,
   'pob:monorepo',

package/lib/utils/ensureJsonFileFormatted.js

@@ -1,13 +1,17 @@
 import fs from 'fs';
+import sortPkg from '@pob/sort-pkg';
 import prettier from 'prettier';
 
 export default function ensureJsonFileFormatted(path) {
   try {
-    const pkgJson = fs.readFileSync(path, 'utf-8');
-    const formattedPkg = prettier.format(pkgJson, {
+    let contentJson = fs.readFileSync(path, 'utf-8');
+    if (path === 'package.json' || path.endsWith('/package.json')) {
+      contentJson = JSON.stringify(sortPkg(JSON.parse(contentJson)), null, 2);
+    }
+    const formattedPkg = prettier.format(contentJson, {
       filepath: path,
     });
-    if (pkgJson !== formattedPkg) {
+    if (contentJson !== formattedPkg) {
       console.warn(`formatted json file ${path}`);
       fs.writeFileSync(path, formattedPkg);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pob",
-  "version": "9.7.4",
+  "version": "9.8.0",
   "description": "Pile of bones, library generator with git/babel/typescript/typedoc/readme/jest",
   "keywords": [
     "skeleton"
@@ -42,8 +42,8 @@
     "@lerna/package-graph": "^4.0.0",
     "@lerna/project": "^4.0.0",
     "@pob/eslint-config": "48.0.5",
-    "@pob/eslint-config-typescript": "48.0.5",
-    "@pob/eslint-config-typescript-react": "48.0.5",
+    "@pob/eslint-config-typescript": "48.0.6",
+    "@pob/eslint-config-typescript-react": "48.0.6",
     "@pob/sort-eslint-config": "^3.0.1",
     "@pob/sort-object": "^4.0.1",
     "@pob/sort-pkg": "^4.0.1",
@@ -61,12 +61,12 @@
     "mem-fs-editor": "8.1.2",
     "minimist-argv": "^1.1.0",
     "parse-author": "^2.0.0",
-    "pob-dependencies": "6.3.2",
+    "pob-dependencies": "6.3.3",
     "prettier": "2.5.1",
     "semver": "^7.3.4",
     "update-notifier": "^5.0.1",
     "yeoman-environment": "^3.5.1",
     "yeoman-generator": "^5.4.0"
   },
-  "gitHead": "1d2df1b252aeeb0c92bd82dc3912e9ffa97aacbe"
+  "gitHead": "1c94efb8acec1f95aeeea9b673c22c56497b9fcd"
 }