Improve CJS code generation + generate tests (#41)

Instead of generating a single bundle for CJS compat the file layout of the
original ESM tree is preserved. Tests are also transpiled with rollup and
then run separately.

Author: MylesBorins

.github/workflows/nodejs.yml

@@ -6,7 +6,7 @@ jobs:
   run-tests:
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [14.x, 12.x, 10.x]
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     runs-on: ${{ matrix.os }}
@@ -20,10 +20,12 @@ jobs:
         node-version: ${{ matrix.node-version }}
 
     - name: Get npm cache directory
+      if: matrix.os != 'windows-latest'
       id: npm-cache
       run: |
         echo "::set-output name=dir::$(npm config get cache)"
     - uses: actions/cache@v1
+      if: matrix.os != 'windows-latest'
       with:
         path: ${{ steps.npm-cache.outputs.dir }}
         key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -35,8 +37,8 @@ jobs:
 
     - name: Test-Legacy
       if: matrix.node-version == '10.x'
-      run: npm run test-legacy
+      run: npm run test:legacy
 
     - name: Test
       if: matrix.node-version != '10.x'
-      run: npm run test-ci
+      run: npm run test

package.json

@@ -4,8 +4,18 @@
   "version": "5.1.0",
   "main": "./dist/bundle.js",
   "exports": {
-    "require": "./dist/bundle.js",
-    "default": "./lib/index.mjs"
+    ".": {
+      "require": "./dist/lib/index.js",
+      "default": "./lib/index.mjs"
+    },
+    "./decode": {
+      "require": "./dist/lib/decode.js",
+      "default": "./lib/decode.mjs"
+    },
+    "./types": {
+      "require": "./dist/lib/types.js",
+      "default": "./lib/types.mjs"
+    }
   },
   "author": {
     "name": "Myles Borins",
@@ -18,11 +28,11 @@
   "scripts": {
     "build": "rollup --config rollup.config.mjs",
     "prepublishOnly": "npm run build",
-    "test-ci": "npm run lint && npm run build && npm run tap -- -j1 test/test-*{.js,.mjs}",
-    "test-legacy": "npm run lint && npm run build && npm run tap -- -j1 test/test-*.js",
-    "test": "npm run lint && npm run build && npm run tap -- -j4 test/test-*{.js,.mjs}",
-    "tap": "c8 tap --no-coverage --no-esm --node-arg=--experimental-modules",
-    "lint": "eslint lib/* test/* examples/*"
+    "lint": "eslint lib/* test/* examples/*",
+    "test": "npm run lint && npm run build && npm run test:esm && npm run test:cjs",
+    "test:esm": "c8 tap --no-coverage --no-esm -j1 test/test-*.mjs",
+    "test:cjs": "tap --no-esm -j1 dist/test/test-*.js",
+    "test:legacy": "npm run lint && npm run build && node scripts/rewrite-exports.js && tap --no-esm -j1 dist/test/test-*.js"
   },
   "contributors": [
     "Hans Hübner <hans.huebner@gmail.com>",

rollup.config.mjs

@@ -1,13 +1,48 @@
-export default {
-  input: 'lib/index.mjs',
-  output: {
-    file: 'dist/bundle.js',
-    format: 'cjs'
-  },
-  external: [
-    'dgram',
-    'events',
-    'osc-min',
-    'jspack'
-  ]
-};
+import { readdirSync } from 'fs';
+
+const files = readdirSync(new URL('./lib', import.meta.url));
+
+const config = [];
+
+files.forEach(file => {
+  config.push({
+    input: `lib/${file}`,
+    output: {
+      entryFileNames: '[name].js',
+      dir: 'dist/lib',
+      format: 'cjs',
+      exports: 'auto'
+    },
+    preserveModules: true,
+    external: [
+      'dgram',
+      'events',
+      'osc-min',
+      'jspack'
+    ]
+  });
+});
+
+
+const tests = readdirSync(new URL('./test', import.meta.url));
+
+tests.forEach(test => {
+  config.push({
+    input: `test/${test}`,
+    output: {
+      entryFileNames: '[name].js',
+      dir: 'dist/test',
+      format: 'cjs',
+    },
+    preserveModules: true,
+    external: [
+      'get-port',
+      'node-osc',
+      'node-osc/decode',
+      'node-osc/types',
+      'tap'
+    ]
+  })
+});
+
+export default config;

scripts/rewrite-exports.js

@@ -0,0 +1,40 @@
+const {
+  readdirSync,
+  readFileSync,
+  writeFileSync
+} = require('fs');
+
+const { join } = require('path');
+
+const root = join(__dirname, '..', 'dist', 'test');
+const tests = readdirSync(root);
+
+console.log('reading files');
+
+const files = tests.map(test => {
+  const testPath = `${root}/${test}`;
+  return {
+    path: testPath,
+    src: readFileSync(testPath, 'utf-8')
+  };
+});
+
+console.log('processing files');
+
+const processedFiles = files.map(file => {
+  return {
+    path: file.path,
+    src: file.src
+      .replace('\'node-osc\'', '\'../lib/index.js\'')
+      .replace('\'node-osc\/types\'', '\'../lib/types.js\'')
+      .replace('\'node-osc\/decode\'', '\'../lib/decode.js\'')
+  }
+})
+
+console.log('writing files');
+
+processedFiles.forEach(file => {
+  writeFileSync(file.path, file.src);
+});
+
+console.log('all done!');

test/test-cjs.js

@@ -1,7 +1,7 @@
-import { Server, Client } from 'node-osc';
-
 import { beforeEach, tap, test } from './util.mjs';
 
+import { Server, Client } from 'node-osc';
+
 tap.beforeEach(beforeEach);
 
 test('client: with array', (t) => {

test/test-client.mjs

@@ -1,6 +1,6 @@
 import { test } from './util.mjs';
 
-import decode from '../lib/decode.mjs';
+import decode from 'node-osc/decode';
 
 test('decode: empty', (t) => {
   const buf = Buffer.from('/test\0');

test/test-decode.mjs

@@ -1,10 +1,21 @@
-import { Server, Client } from 'node-osc';
-
 import { beforeEach, tap, test } from './util.mjs';
 
+import { Server, Client } from 'node-osc';
+
 tap.beforeEach(beforeEach);
 
+function flaky() {
+  return process.release.lts === 'Dubnium' && process.platform === 'win32';
+}
+
+function skip(t) {
+  t.skip(`flaky ~ ${t.name}`);
+  t.done();
+}
+
 test('osc: argument message no callback', (t) => {
+  if (flaky()) return skip(t);
+
   const oscServer = new Server(t.context.port, '0.0.0.0');
   const client = new Client('0.0.0.0', t.context.port);
 
@@ -20,6 +31,8 @@ test('osc: argument message no callback', (t) => {
 });
 
 test('osc: client with callback and message as arguments', (t) => {
+  if (flaky()) return skip(t);
+
   const oscServer = new Server(t.context.port, '0.0.0.0');
   const client = new Client('0.0.0.0', t.context.port);
 
@@ -35,5 +48,3 @@ test('osc: client with callback and message as arguments', (t) => {
     client.close();
   });
 });
-
-

test/test-e2e.mjs

@@ -1,7 +1,7 @@
-import { Server, Client, Message } from 'node-osc';
-
 import { beforeEach, tap, test } from './util.mjs';
 
+import { Server, Client, Message } from 'node-osc';
+
 tap.beforeEach(beforeEach);
 
 test('message: basic usage', (t) => {

test/test-message.mjs

@@ -1,7 +1,7 @@
-import { Server, Client } from 'node-osc';
-
 import { beforeEach, tap, test } from './util.mjs';
 
+import { Server, Client } from 'node-osc';
+
 tap.beforeEach(beforeEach);
 
 test('server: create and close', (t) => {

test/test-server.mjs

@@ -9,7 +9,7 @@ import {
   TDouble,
   TTrue,
   TFalse
-} from '../lib/types.mjs';
+} from 'node-osc/types';
 
 test('Type: string', async (t) => {
   const str = new TString('come on fhqwhgads');