metapak-nfroidure 11.2.1 → 12.0.2

package/CHANGELOG.md

@@ -1,3 +1,37 @@
+## [12.0.2](https://github.com/nfroidure/metapak-nfroidure/compare/v12.0.1...v12.0.2) (2022-06-06)
+
+
+### Bug Fixes
+
+* **tsesm:** fix vscode file presence for monorepos ([a2bc240](https://github.com/nfroidure/metapak-nfroidure/commit/a2bc240595be3a964339caa7812f01d710334cfb))
+
+
+
+## [12.0.1](https://github.com/nfroidure/metapak-nfroidure/compare/v12.0.0...v12.0.1) (2022-05-29)
+
+
+### Bug Fixes
+
+* **tsesm:** fix TypeScript + Jest configuration ([b7c6768](https://github.com/nfroidure/metapak-nfroidure/commit/b7c67688a494acc8cc918a61e75054d2c1ac7d80))
+
+
+
+# [12.0.0](https://github.com/nfroidure/metapak-nfroidure/compare/v11.2.1...v12.0.0) (2022-05-27)
+
+
+### Bug Fixes
+
+* **ci:** fix CI Config ([aea9263](https://github.com/nfroidure/metapak-nfroidure/commit/aea92638c3a579306b4060e62c7c22447a9ccc16))
+* **configs:** fix GH Actions file name ([2c5d8af](https://github.com/nfroidure/metapak-nfroidure/commit/2c5d8af959a9a1755ef6754799f776ea8af016a6))
+
+
+### Features
+
+* **configs:** add GH Actions instead of TravisCI ([bf679d6](https://github.com/nfroidure/metapak-nfroidure/commit/bf679d68dd4bf2209adeced107014743d33b487c)), closes [#19](https://github.com/nfroidure/metapak-nfroidure/issues/19)
+* **configs:** add TypeScript+ESM build configuration ([145c9ba](https://github.com/nfroidure/metapak-nfroidure/commit/145c9ba57cb3f9e86bdd9a0b08ea4050f27aaa53)), closes [#31](https://github.com/nfroidure/metapak-nfroidure/issues/31)
+
+
+
 ## [11.2.1](https://github.com/nfroidure/metapak-nfroidure/compare/v11.2.0...v11.2.1) (2022-05-25)
 
 

package/README.md

@@ -8,7 +8,6 @@
 > A metapak module for my open source projects.
 
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nfroidure/metapak-nfroidure/blob/master/LICENSE)
-[![Build status](https://travis-ci.com/nfroidure/metapak-nfroidure.svg?branch=master)](https://travis-ci.com/github/nfroidure/metapak-nfroidure)
 [![Coverage Status](https://coveralls.io/repos/github/nfroidure/metapak-nfroidure/badge.svg?branch=master)](https://coveralls.io/github/nfroidure/metapak-nfroidure?branch=master)
 
 

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "metapak-nfroidure",
   "description": "A metapak module for my open source projects.",
-  "version": "11.2.1",
+  "version": "12.0.2",
   "metapak": {
     "configs": [
       "main",
       "readme",
       "jest",
       "eslint",
-      "travis",
+      "ghactions",
       "codeclimate"
     ],
     "data": {
@@ -48,7 +48,7 @@
     "metapak": "^3.1.5"
   },
   "engines": {
-    "node": ">=12.19.0"
+    "node": ">=16.15.0"
   },
   "bugs": {
     "url": "https://github.com/nfroidure/metapak-nfroidure/issues"
@@ -62,7 +62,7 @@
     "eslint": "^8.16.0",
     "eslint-plugin-prettier": "^4.0.0",
     "jest": "^28.1.0",
-    "metapak": "^4.0.2",
+    "metapak": "^4.0.4",
     "prettier": "^2.6.2"
   },
   "config": {

package/src/babel/__snapshots__/package.test.js.snap

@@ -41,7 +41,7 @@ Object {
         "@babel/env",
         Object {
           "targets": Object {
-            "node": "12.19.0",
+            "node": "16.15.0",
           },
         },
       ],
@@ -116,7 +116,7 @@ Object {
         "@babel/env",
         Object {
           "targets": Object {
-            "node": "12.19.0",
+            "node": "16.15.0",
           },
         },
       ],
@@ -216,7 +216,7 @@ Object {
         "@babel/env",
         Object {
           "targets": Object {
-            "node": "12.19.0",
+            "node": "16.15.0",
           },
         },
       ],
@@ -307,7 +307,7 @@ Object {
         "@babel/env",
         Object {
           "targets": Object {
-            "node": "12.19.0",
+            "node": "16.15.0",
           },
         },
       ],
@@ -397,7 +397,7 @@ Object {
         "@babel/env",
         Object {
           "targets": Object {
-            "node": "12.19.0",
+            "node": "16.15.0",
           },
         },
       ],

package/src/config.js

@@ -3,7 +3,7 @@
 // DRY, set here vars that may be used several times
 // in your metapak module
 module.exports = {
-  lastNodeLTS: '12.19.0',
-  lastNode: '14.0.0',
+  lastNodeLTS: '16.15.0',
+  lastNode: '18.2.0',
   apiPath: 'API.md',
 };

package/src/eslint/package.js

@@ -53,7 +53,7 @@ module.exports = (packageConf) => {
   };
 
   // Special configuration for TypeScript
-  if (configs.includes('typescript')) {
+  if (configs.includes('typescript') || configs.includes('tsesm')) {
     packageConf.devDependencies['@typescript-eslint/eslint-plugin'] = '^5.26.0';
     packageConf.devDependencies['@typescript-eslint/parser'] = '^5.26.0';
     packageConf.eslintConfig.parser = '@typescript-eslint/parser';
@@ -75,8 +75,11 @@ module.exports = (packageConf) => {
           )
             .concat(['eslint', 'eslint-config-prettier', 'prettier'])
             .concat(
-              configs.includes('typescript')
-                ? ['@typescript-eslint/parser']
+              configs.includes('typescript') || configs.includes('tsesm')
+                ? [
+                    '@typescript-eslint/eslint-plugin',
+                    '@typescript-eslint/parser',
+                  ]
                 : []
             )
         ),

package/src/ghactions/assets/_dot_github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - name: Install dependencies
+        run: npm ci
+      - name: Run pre-commit tests
+        run: npm run precz

package/src/ghactions/assets.js

@@ -0,0 +1,30 @@
+'use strict';
+
+const config = require('../config.js');
+
+module.exports = (file) => {
+  if ('.github/workflows/test.yml' === file.name) {
+    const lastNodeLTSMajorPart = parseInt(config.lastNodeLTS.split('.')[0], 10);
+    const lastNodeMajorPart = parseInt(config.lastNode.split('.')[0], 10);
+    const versions = [];
+
+    for (let i = 0; i <= lastNodeMajorPart - lastNodeLTSMajorPart; i++) {
+      if (0 === i) {
+        versions.push(lastNodeLTSMajorPart);
+        continue;
+      }
+
+      const isANodeStableVersion = i % 2 === 0;
+
+      if (isANodeStableVersion) {
+        versions.push(lastNodeLTSMajorPart + i);
+      }
+    }
+    file.data = file.data.replace(
+      'node-version: []',
+      `node-version: [${versions.map((version) => version + '.x').join(', ')}]`
+    );
+  }
+
+  return file;
+};

package/src/ghactions/assets.test.js

@@ -0,0 +1,81 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const assert = require('assert');
+const assetsTransformer = require('./assets');
+
+describe('GHActions', () => {
+  describe('Assets transformer', () => {
+    it('should fill the manifest', () => {
+      expect(
+        assetsTransformer(
+          {
+            name: '.github/workflows/test.yml',
+            data: fs.readFileSync(
+              path.join(
+                __dirname,
+                'assets',
+                '_dot_github',
+                'workflows',
+                'test.yml'
+              ),
+
+              'utf-8'
+            ),
+          },
+
+          {}
+        )
+      ).toMatchInlineSnapshot(`
+        Object {
+          "data": "name: Node.js CI
+
+        on:
+          push:
+            branches: [master]
+          pull_request:
+            branches: [master]
+
+        jobs:
+          build:
+            runs-on: ubuntu-latest
+
+            strategy:
+              matrix:
+                node-version: [16.x, 18.x]
+
+            steps:
+              - uses: actions/checkout@v3
+              - name: Use Node.js \${{ matrix.node-version }}
+                uses: actions/setup-node@v3
+                with:
+                  node-version: \${{ matrix.node-version }}
+                  cache: \\"npm\\"
+              - name: Install dependencies
+                run: npm ci
+              - name: Run pre-commit tests
+                run: npm run precz
+        ",
+          "name": ".github/workflows/test.yml",
+        }
+      `);
+    });
+
+    it('should let pass other files', () => {
+      assert.deepEqual(
+        assetsTransformer(
+          {
+            name: 'YOLO',
+            data: 'Carpe diem\n',
+          },
+          {}
+        ),
+        {
+          name: 'YOLO',
+          data: 'Carpe diem\n',
+        }
+      );
+    });
+  });
+});

package/src/jest/package.js

@@ -40,13 +40,35 @@ module.exports = (packageConf) => {
           transform: {}.undef,
         }
       : {},
+    // Add ts esm necessary conf
+    configs.includes('tsesm')
+      ? {
+          preset: 'ts-jest',
+          testEnvironment: 'node',
+          transform: {
+            '\\.[jt]sx?$': 'ts-jest',
+          },
+          globals: {
+            'ts-jest': {
+              useESM: true,
+            },
+          },
+          moduleNameMapper: {
+            '(.+)\\.js': '$1',
+          },
+          extensionsToTreatAsEsm: ['.ts'],
+        }
+      : {},
 
     packageConf.jest
   );
   // Special configuration for TypeScript
-  if (configs.includes('typescript')) {
+  if (configs.includes('typescript') || configs.includes('tsesm')) {
     packageConf.devDependencies['@types/jest'] = '^27.0.2';
   }
+  if (configs.includes('tsesm')) {
+    packageConf.devDependencies['ts-jest'] = '^28.0.3';
+  }
 
   if (configs.includes('typescript')) {
     delete packageConf.devDependencies['ts-jest'];
@@ -61,7 +83,10 @@ module.exports = (packageConf) => {
             : []
           )
             .concat(['jest', 'coveralls'])
-            .filter((packageName) => packageName !== 'ts-jest')
+            .filter(
+              (packageName) =>
+                packageName !== 'ts-jest' || configs.includes('tsesm')
+            )
         ),
       ],
     };

package/src/jsarch/package.js

@@ -24,7 +24,10 @@ module.exports = (packageConf) => {
   }
 
   // Special configuration for TypeScript
-  if (configs.includes('typescript') && !packageConf.jsarch) {
+  if (
+    (configs.includes('typescript') || configs.includes('tsesm')) &&
+    !packageConf.jsarch
+  ) {
     packageConf.jsarch = {
       parserOptions: {
         plugins: ['typescript'],

package/src/jsdocs/package.js

@@ -13,7 +13,9 @@ module.exports = (packageConf) => {
   packageConf.scripts.doc = data.rootPackage
     ? 'lerna run doc'
     : `echo "# API" > ${apiPath}; jsdoc2md ${
-        configs.includes('typescript') ? data.distFiles : data.files
+        configs.includes('typescript') || configs.includes('tsesm')
+          ? data.distFiles
+          : data.files
       } >> ${apiPath} && git add ${apiPath}`;
 
   if (!data.childPackage) {

package/src/main/__snapshots__/package.test.js.snap

@@ -9,7 +9,7 @@ Object {
   },
   "contributors": Array [],
   "engines": Object {
-    "node": ">=12.19.0",
+    "node": ">=16.15.0",
   },
   "files": Array [
     "src",
@@ -41,7 +41,7 @@ Object {
   },
   "contributors": Array [],
   "engines": Object {
-    "node": ">=12.19.0",
+    "node": ">=16.15.0",
   },
   "files": Array [
     "src",
@@ -83,7 +83,7 @@ Object {
     "cz-conventional-changelog": "^3.3.0",
   },
   "engines": Object {
-    "node": ">=12.19.0",
+    "node": ">=16.15.0",
   },
   "files": Array [
     "src",
@@ -136,7 +136,7 @@ Object {
     "cz-conventional-changelog": "^3.3.0",
   },
   "engines": Object {
-    "node": ">=12.19.0",
+    "node": ">=16.15.0",
   },
   "files": Array [
     "src",

package/src/travis/__snapshots__/assets.test.js.snap

@@ -8,10 +8,10 @@ Object {
 
 language: node_js
 node_js:
-  - 12
-  - 12.19.0
-  - 13
-  - 14
+  - 16
+  - 16.15.0
+  - 17
+  - 18
 ",
   "name": ".travis.yml",
 }

package/src/tsesm/assets/_dot_vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

package/src/tsesm/assets/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "module": "Node16",
+    "moduleResolution": "Node16",
+    "target": "es2022",
+    "noImplicitAny": false,
+    "removeComments": false,
+    "preserveConstEnums": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "declaration": true,
+    "outDir": "dist",
+    "sourceMap": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules"]
+}

package/src/tsesm/assets.js

@@ -0,0 +1,25 @@
+'use strict';
+
+const { getMetapakInfos } = require('../lib.js');
+
+module.exports = (file, packageConf) => {
+  const { data } = getMetapakInfos(packageConf);
+
+  // Set types in ts config
+  if ('tsconfig.json' === file.name) {
+    let contents = JSON.parse(file.data);
+
+    if (data.typesFiles) {
+      contents = Object.assign({}, contents, {
+        include: [data.typesFiles],
+      });
+    }
+    file.data = JSON.stringify(contents, null, 2);
+  }
+  if ('.vscode/settings.json' === file.name) {
+    if (data.childPackage) {
+      file.data = '';
+    }
+  }
+  return file;
+};

package/src/tsesm/package.js

@@ -0,0 +1,66 @@
+'use strict';
+
+const { ensureScript, getMetapakInfos } = require('../lib.js');
+const BUILD_COMMAND = 'npm run build';
+
+module.exports = (packageConf) => {
+  const { data } = getMetapakInfos(packageConf);
+
+  // Declare an ESM module
+  packageConf.type = 'module';
+  packageConf.main = 'dist/index.js';
+  packageConf.types = 'dist/index.d.ts';
+
+  // Add the dev dependencies
+  packageConf.devDependencies = packageConf.devDependencies || {};
+  packageConf.devDependencies.typescript = '^4.7.2';
+  packageConf.devDependencies.rimraf = '^3.0.2';
+
+  packageConf.scripts = packageConf.scripts || {};
+  packageConf.scripts.build = data.rootPackage
+    ? 'lerna run build'
+    : "rimraf -f 'dist' && tsc --outDir dist";
+
+  // Install mandatory scripts
+  if (!data.childPackage) {
+    packageConf.scripts.precz = ensureScript(
+      packageConf.scripts.precz,
+      BUILD_COMMAND
+    );
+    packageConf.scripts.preversion = ensureScript(
+      packageConf.scripts.preversion,
+      BUILD_COMMAND
+    );
+  }
+
+  // Remove eventual old dependencies
+  delete packageConf.devDependencies['babel-plugin-knifecycle'];
+  Object.keys(packageConf.devDependencies || {}).forEach((key) => {
+    if (key.startsWith('@babel')) {
+      delete packageConf.devDependencies[key];
+    }
+  });
+
+  // Remove eventual old configurations
+  delete packageConf.module;
+  delete packageConf.scripts.compile;
+  delete packageConf.scripts['compile:cjs'];
+  delete packageConf.scripts['compile:mjs'];
+  delete packageConf.scripts.types;
+
+  // Avoid GreenKeeper to update automatically added modules
+  if ('metapak-nfroidure' !== packageConf.name && !data.childPackage) {
+    packageConf.greenkeeper = {
+      ignore: [
+        ...new Set(
+          (packageConf.greenkeeper && packageConf.greenkeeper.ignore
+            ? packageConf.greenkeeper.ignore
+            : []
+          ).concat(['typescript', 'rimraf'])
+        ),
+      ],
+    };
+  }
+
+  return packageConf;
+};

package/src/tsesm/package.test.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const packageTransformer = require('./package');
+
+describe('private', () => {
+  describe('Package transformer', () => {
+    it('should work', () => {
+      expect(
+        packageTransformer({
+          metapak: {
+            data: {},
+          },
+        })
+      ).toMatchInlineSnapshot(`
+        Object {
+          "devDependencies": Object {
+            "rimraf": "^3.0.2",
+            "typescript": "^4.7.2",
+          },
+          "greenkeeper": Object {
+            "ignore": Array [
+              "typescript",
+              "rimraf",
+            ],
+          },
+          "main": "dist/index.js",
+          "metapak": Object {
+            "data": Object {},
+          },
+          "scripts": Object {
+            "build": "rimraf -f 'dist' && tsc --outDir dist",
+            "precz": "npm run build",
+            "preversion": "npm run build",
+          },
+          "type": "module",
+          "types": "dist/index.d.ts",
+        }
+      `);
+    });
+  });
+});