pob 9.12.3 → 9.13.0

package/CHANGELOG.md

@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [9.13.0](https://github.com/christophehurpeau/pob/compare/pob@9.12.3...pob@9.13.0) (2022-01-15)
+
+
+### Bug Fixes
+
+* disable gh-pages for apps ([0f935ff](https://github.com/christophehurpeau/pob/commit/0f935ff24207ebe782bb7f0a2f75372ab87ac240))
+* **deps:** update dependency @pob/eslint-config-typescript-react to v48.0.7 ([#1153](https://github.com/christophehurpeau/pob/issues/1153)) ([b96b1c4](https://github.com/christophehurpeau/pob/commit/b96b1c4497529772b58e18c04b6b19020bb4931f))
+* **deps:** update dependency @yarnpkg/parsers to v2.5.0-rc.8 ([#1155](https://github.com/christophehurpeau/pob/issues/1155)) ([4a01d49](https://github.com/christophehurpeau/pob/commit/4a01d4929b0b6ae0d19494e478357a6d7bf4acb6))
+* **pob:** add @babel/core when pkg has peer dependency ([acd04cb](https://github.com/christophehurpeau/pob/commit/acd04cbc77c914af56db8b83734d187cc926f4e4))
+* **pob:** extraEntries for pkg.type === "module" ([2fae75c](https://github.com/christophehurpeau/pob/commit/2fae75cdf6ee5678f436d11a15f02bd22f1a9c66))
+* **pob:** remove /private_key in gitignore ([368d819](https://github.com/christophehurpeau/pob/commit/368d8193d638ec41a7caa7a46e9cbcd6607dcaf2))
+
+
+### Features
+
+* generate documentation and coverage on gh-pages ([32e4801](https://github.com/christophehurpeau/pob/commit/32e4801e8a4d1ff221a7fe63d42c6fe52d46f796))
+
+
+
+
+
 ## [9.12.3](https://github.com/christophehurpeau/pob/compare/pob@9.12.2...pob@9.12.3) (2022-01-02)
 
 

package/README.md

@@ -40,9 +40,8 @@ You can check the code by running the task `yarn run lint`. With an editor, inst
 
 #### Documentation
 
-[jsdoc](http://usejsdoc.org/) allows to document the code and generate the api.
+[typedoc](https://typedoc.org/) allows to document the code and generate the api.
 [jest](https://www.npmjs.com/package/jest) is used to generate the coverage.
-You can generate the documentation with `yarn run generate:docs`.
 
 Documentation can be generated by github actions and pushed to github-pages.
 
@@ -61,9 +60,7 @@ Tests are in the directory `src` with jest. Use the task `yarn test` to run the
 
 ### Generate documentation
 
-- `generate:docs`: run `generate:api` and `generate:test-coverage`
-- `generate:api`: generate api with jsdoc
-- `generate:test-coverage`: generate coverage documentation
+Documentation (api + test coverage) is deployed to gh-pages via a github action.
 
 ### Publish a new release
 

package/lib/generators/app/PobAppGenerator.js

@@ -1,4 +1,3 @@
-import fs from 'fs';
 import Generator from 'yeoman-generator';
 import inLerna from '../../utils/inLerna.js';
 import inNpmLerna from '../../utils/inNpmLerna.js';
@@ -183,13 +182,11 @@ export default class PobAppGenerator extends Generator {
     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,
+      testing: this.appConfig.testing,
       withBabel: babel,
       paths: ignorePaths.join('\n'),
       buildInGit: false,

package/lib/generators/common/babel/CommonBabelGenerator.js

@@ -319,10 +319,12 @@ export default class CommonBabelGenerator extends Generator {
 
     /* dependencies */
 
-    packageUtils.addOrRemoveDevDependencies(pkg, useBabel, [
-      '@babel/core',
-      'pob-babel',
-    ]);
+    packageUtils.addOrRemoveDevDependencies(
+      pkg,
+      useBabel || (pkg.peerDependencies && pkg.peerDependencies['@babel/core']),
+      ['@babel/core'],
+    );
+    packageUtils.addOrRemoveDevDependencies(pkg, useBabel, ['pob-babel']);
 
     if (pkg.dependencies && pkg.dependencies['pob-babel']) {
       // update pob-babel in alp-dev
@@ -651,10 +653,13 @@ export default class CommonBabelGenerator extends Generator {
 
       if (pkg.pob.extraEntries) {
         pkg.pob.extraEntries.forEach((exportName) => {
-          pkg.exports[`./${exportName}`] = {
-            import: `./${exportName}.mjs`,
-            require: `./${exportName}.js`,
-          };
+          pkg.exports[`./${exportName}`] =
+            pkg.type === 'module'
+              ? `./${exportName}.js`
+              : {
+                  import: `./${exportName}.mjs`,
+                  require: `./${exportName}.js`,
+                };
         });
       }
     } else if (!pkg.exports) {

package/lib/generators/common/release/CommonReleaseGenerator.js

@@ -76,7 +76,6 @@ export default class CommonReleaseGenerator extends Generator {
         preversion: [
           'yarn run lint',
           this.options.withBabel && 'yarn run build',
-          this.options.documentation && 'yarn run generate:docs',
           'repository-check-dirty',
         ]
           .filter(Boolean)

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

@@ -85,6 +85,7 @@ export default class CommonTestingGenerator extends Generator {
       'babel-core',
       'ts-jest',
       'babel-jest',
+      'pob-lcov-reporter',
     ]);
 
     const yoConfigPobMonorepo = inLerna && inLerna.pobMonorepoConfig;
@@ -116,13 +117,10 @@ export default class CommonTestingGenerator extends Generator {
       packageUtils.addOrRemoveDevDependencies(
         pkg,
         enableForMonorepo || !globalTesting,
-        [
-          pkg.name !== 'pob-monorepo' && 'pob-lcov-reporter',
-          'jest',
-          '@types/jest',
-        ],
+        ['jest', '@types/jest'],
       );
 
+      packageUtils.removeScripts(['test:coverage']);
       if (this.options.monorepo && !globalTesting) {
         delete pkg.jest;
         packageUtils.addScripts(pkg, {
@@ -139,12 +137,6 @@ export default class CommonTestingGenerator extends Generator {
 
         packageUtils.addScripts(pkg, {
           test: jestCommand,
-          'generate:test-coverage': [
-            'rm -Rf docs/coverage/',
-            `NODE_ENV=production ${
-              transpileWithBabel ? 'BABEL_ENV=test ' : ''
-            }${jestCommand} --coverage --coverageReporters=pob-lcov-reporter --coverageDirectory=docs/coverage/`,
-          ].join(' ; '),
         });
 
         const workspacesWithoutStar = pkg.workspaces.map((workspace) => {
@@ -206,12 +198,6 @@ export default class CommonTestingGenerator extends Generator {
         packageUtils.addScripts(pkg, {
           test: jestCommand,
           'test:watch': `${jestCommand} --watch`,
-          'generate:test-coverage': [
-            'rm -Rf docs/coverage/',
-            `NODE_ENV=production ${
-              transpileWithBabel ? 'BABEL_ENV=test ' : ''
-            }${jestCommand} --coverage --coverageReporters=pob-lcov-reporter --coverageDirectory=docs/coverage/`,
-          ].join(' ; '),
         });
 
         const srcDirectory = transpileWithBabel ? 'src' : 'lib';

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

@@ -66,6 +66,7 @@ export default class CoreCIGenerator extends Generator {
     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'));
 
@@ -87,6 +88,25 @@ export default class CoreCIGenerator extends Generator {
     } else {
       this.fs.delete(this.destinationPath('.github/workflows/push.yml'));
     }
+
+    if (
+      this.options.enable &&
+      !this.options.isApp &&
+      (this.options.documentation || this.options.testing)
+    ) {
+      copyAndFormatTpl(
+        this.fs,
+        this.templatePath('github-action-documentation-workflow.yml.ejs'),
+        this.destinationPath('.github/workflows/gh-pages.yml'),
+        {
+          packageManager: this.options.packageManager,
+          testing: this.options.testing,
+          typedoc: this.options.documentation && this.options.typescript,
+        },
+      );
+    } else {
+      this.fs.delete(this.destinationPath('.github/workflows/gh-pages.yml'));
+    }
   }
 
   writing() {

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

@@ -0,0 +1,50 @@
+name: 'Create documentation and deploy to Github pages'
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  create-documentation-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: |
+            .yarn/unplugged
+            .yarn/install-state.gz
+          key: v2-dependencies--${{ matrix.node-version }}-${{ runner.OS }}-${{ hashFiles('yarn.lock') }}
+          restore-keys: |
+            v2-dependencies--${{ matrix.node-version }}-${{ runner.OS }}-
+            v2-dependencies--${{ matrix.node-version }}-
+
+      - name: Check Dependencies
+        run: yarn install --immutable --immutable-cache
+
+<% if (typedoc) { -%>
+      - name: Generate Typedoc
+        run: yarn typedoc --tsconfig tsconfig.doc.json
+<% } -%>
+
+<% if (testing) { -%>
+      - name: Generate Coverage
+        run: yarn test --coverage --coverageReporters=lcov --coverageDirectory=docs/coverage/
+<% } -%>
+
+      - name: Create nojekyll
+        run: touch docs/.nojekyll
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs

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

@@ -73,35 +73,25 @@ jobs:
         run: yarn run tsc
         if: startsWith(matrix.node-version, '16.')
 <% } -%>
-<% if (testing) { -%>
-
-      - name: Test
-        run: <%= packageManager %> run test
-        env:
-          CI: true
-<% } -%>
-<% if (documentation) { -%>
-
-      - name: Documentation
-        run: <%= packageManager %> run generate:docs
-        if: startsWith(matrix.node-version, '16.')
-        env:
-          CI: true
-<% } else if (codecov) { -%>
+<% if (codecov) { -%>
 
-      - name: Generate Coverage doc
-        run: <%= packageManager %> run generate:test-coverage
+      - name: Generate Test Coverage
+        run: <%= packageManager %> run test --coverage --coverageReporters=json --coverageReporters=text
         if: startsWith(matrix.node-version, '16.')
         env:
           CI: true
-<% } -%>
-<% if (codecov) { -%>
 
       - name: Send results to codecov
         uses: codecov/codecov-action@v2
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
         if: startsWith(matrix.node-version, '16.')
+<% } else if (testing) { -%>
+
+      - name: Test
+        run: <%= packageManager %> run test
+        env:
+          CI: true
 <% } -%>
 <% if (true) { -%>
 

package/lib/generators/core/gitignore/CoreGitignoreGenerator.js

@@ -18,6 +18,13 @@ export default class CoreGitignoreGenerator extends Generator {
       desc: 'Documentation enabled.',
     });
 
+    this.option('testing', {
+      type: Boolean,
+      required: false,
+      defaults: false,
+      desc: 'Testing enabled.',
+    });
+
     this.option('withBabel', {
       type: Boolean,
       required: false,
@@ -66,6 +73,7 @@ export default class CoreGitignoreGenerator extends Generator {
       this.fs.copyTpl(this.templatePath('gitignore.ejs'), dest, {
         root: this.options.root,
         documentation: this.options.documentation,
+        testing: this.options.testing,
         withBabel,
         typescript: withBabel || this.options.typescript,
         paths: this.options.paths,

package/lib/generators/core/gitignore/templates/gitignore.ejs

@@ -21,6 +21,17 @@ yarn-error.log*
 *.sublime-project
 *.sublime-workspace
 
+<% if (documentation) { -%>
+# generated documentation directory
+/docs
+<% } -%>
+
+<% if (testing) { -%>
+# jest default coverage directory
+/coverage
+<% } -%>
+
+
 <% if (typescript && buildInGit) { -%>
 # Typescript
 tsbuildinfo

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

@@ -129,17 +129,10 @@ export default class CoreYarnGenerator extends Generator {
         try {
           this.spawnCommandSync('yarn', ['run', 'preversion']);
         } catch {}
-      } else {
-        if (pkg.scripts.build) {
-          try {
-            this.spawnCommandSync('yarn', ['run', 'build']);
-          } catch {}
-        }
-        if (pkg.scripts['generate:docs']) {
-          try {
-            this.spawnCommandSync('yarn', ['run', 'generate:docs']);
-          } catch {}
-        }
+      } else if (pkg.scripts.build) {
+        try {
+          this.spawnCommandSync('yarn', ['run', 'build']);
+        } catch {}
       }
     }
   }

package/lib/generators/lib/PobLibGenerator.js

@@ -291,6 +291,7 @@ export default class PobLibGenerator extends Generator {
       withBabel: babelEnvs.length > 0,
       typescript: babelEnvs.length > 0,
       documentation: this.pobjson.documentation,
+      testing: !!this.pobjson.testing,
     });
 
     this.composeWith('pob:core:npm', {

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

@@ -146,19 +146,16 @@ export default class LibDocGenerator extends Generator {
     //   },
     // );
 
+    if (pkg.scripts) {
+      delete pkg.scripts['generate:docs'];
+    }
+
     if (this.options.enabled) {
       packageUtils.addScripts(pkg, {
-        'generate:docs':
-          'rm -Rf docs ; yarn run generate:api ; touch docs/.nojekyll',
         'generate:api': 'typedoc --tsconfig tsconfig.doc.json',
       });
-
-      if (this.options.testing && (!inLerna || !inLerna.root)) {
-        pkg.scripts['generate:docs'] += ' && yarn run generate:test-coverage';
-      }
     } else {
       delete pkg.scripts['generate:api'];
-      delete pkg.scripts['generate:docs'];
     }
 
     this.fs.writeJSON(this.destinationPath('package.json'), pkg);

package/lib/generators/monorepo/PobMonorepoGenerator.js

@@ -1,3 +1,4 @@
+import { execSync } from 'child_process';
 import fs from 'fs';
 import path from 'path';
 import { PackageGraph } from '@lerna/package-graph';
@@ -218,6 +219,8 @@ export default class PobMonorepoGenerator extends Generator {
     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');
@@ -229,13 +232,11 @@ export default class PobMonorepoGenerator extends Generator {
       packagePaths: JSON.stringify(packagePaths),
     });
 
-    if (this.pobLernaConfig.documentation) {
-      pkg.scripts.build = `${
-        pkg.scripts.build ? `${pkg.scripts.build} && ` : ''
-      }yarn run generate:docs`;
-    }
-
     this.fs.writeJSON(this.destinationPath('package.json'), pkg);
+
+    execSync(
+      `rm -Rf ${['lib-*', 'coverage', 'docs'].filter(Boolean).join(' ')}`,
+    );
   }
 
   end() {

package/lib/generators/monorepo/typescript/MonorepoTypescriptGenerator.js

@@ -61,9 +61,7 @@ export default class MonorepoTypescriptGenerator extends Generator {
       delete pkg.scripts.postbuild;
 
       if (!this.options.isAppProject) {
-        pkg.scripts.build += ` && yarn run build:definitions${
-          pkg.scripts['generate:docs'] ? ' && yarn run generate:docs' : ''
-        }`;
+        pkg.scripts.build += ' && yarn run build:definitions';
       }
 
       const packagePaths = JSON.parse(this.options.packagePaths);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pob",
-  "version": "9.12.3",
+  "version": "9.13.0",
   "description": "Pile of bones, library generator with git/babel/typescript/typedoc/readme/jest",
   "keywords": [
     "skeleton"
@@ -43,11 +43,11 @@
     "@lerna/project": "^4.0.0",
     "@pob/eslint-config": "48.0.5",
     "@pob/eslint-config-typescript": "48.0.6",
-    "@pob/eslint-config-typescript-react": "48.0.6",
+    "@pob/eslint-config-typescript-react": "48.0.7",
     "@pob/sort-eslint-config": "^3.0.1",
     "@pob/sort-object": "^4.0.1",
     "@pob/sort-pkg": "^4.0.1",
-    "@yarnpkg/parsers": "2.5.0-rc.7",
+    "@yarnpkg/parsers": "2.5.0-rc.8",
     "eslint": "8.6.0",
     "findup-sync": "^5.0.0",
     "git-remote-url": "^1.0.1",
@@ -61,11 +61,11 @@
     "mem-fs-editor": "9.4.0",
     "minimist-argv": "^1.1.0",
     "parse-author": "^2.0.0",
-    "pob-dependencies": "6.6.3",
+    "pob-dependencies": "6.7.0",
     "prettier": "2.5.1",
     "semver": "^7.3.4",
     "yeoman-environment": "^3.5.1",
     "yeoman-generator": "^5.4.0"
   },
-  "gitHead": "463af07ec0ae3131bc1728e275b8343d81025ddd"
+  "gitHead": "10fc86e0d2cf78d9b2b1299a708ce69b32fbfedc"
 }