feat: hybrid CommonJS & ECMAScript modules build

BREAKING CHANGE: Convert code base to ECMAScript Modules (ESM) and
release CommonJS build for node and ESM build for browser bundlers.

Author: broofa

.babelrc.js

@@ -0,0 +1,19 @@
+module.exports = {
+  presets: [],
+  plugins: [],
+  env: {
+    commonjs: {
+      plugins: [
+        'babel-plugin-add-module-exports',
+      ],
+      presets: [
+        ['@babel/preset-env', {targets: {node: '8'}, modules: 'commonjs'}],
+      ],
+    },
+    esm: {
+      presets: [
+        ['@babel/preset-env', {modules: false}],
+      ],
+    },
+  },
+};

.eslintignore

@@ -0,0 +1 @@
+!.babelrc.js

.eslintrc.json

@@ -3,13 +3,15 @@
   "env": {
     "browser": true,
     "commonjs": true,
+    "es6": true,
     "mocha": true,
     "node": true
   },
   "extends": ["eslint:recommended"],
   "globals": {
     "msCrypto": true
   },
+  "parser": "babel-eslint",
   "rules": {
     "array-bracket-spacing": ["warn", "never"],
     "arrow-body-style": ["warn", "as-needed"],

.gitignore

@@ -2,3 +2,5 @@
 .idea/**
 .DS_Store
 node_modules
+tmp
+dist/

README_js.md

@@ -1,7 +1,7 @@
 ```javascript --hide
 runmd.onRequire = path => {
   if (path == 'rng') return fun
-  return path.replace(/^uuid/, './');
+  return path.replace(/^uuid/, './dist/');
 }
 
 // Shim Date and crypto so generated ids are consistent across doc revisions

index.js

@@ -16,27 +16,32 @@
   "bin": {
     "uuid": "./bin/uuid"
   },
+  "sideEffects": false,
+  "main": "index.js",
+  "module": "esm-browser/index.js",
   "devDependencies": {
+    "@babel/cli": "~7.6.0",
+    "@babel/core": "~7.6.0",
+    "@babel/preset-env": "~7.6.3",
     "@commitlint/cli": "~8.2.0",
     "@commitlint/config-conventional": "~8.2.0",
+    "babel-eslint": "~10.0.3",
+    "babel-plugin-add-module-exports": "~1.0.2",
     "eslint": "~6.4.0",
+    "esm": "~3.2.25",
     "husky": "~3.0.5",
     "mocha": "6.2.0",
     "runmd": "1.2.1",
     "standard-version": "7.0.0"
   },
   "scripts": {
-    "lint": "eslint .",
-    "test": "npm run lint && mocha test/test.js",
+    "lint": "eslint src/ test/ *.js",
+    "test": "npm run lint && mocha --require esm --reporter spec --check-leaks test/test.js",
     "md": "runmd --watch --output=README.md README_js.md",
+    "package": "./scripts/package.sh",
     "release": "standard-version",
     "prepare": "runmd --output=README.md README_js.md"
   },
-  "browser": {
-    "./lib/rng.js": "./lib/rng-browser.js",
-    "./lib/sha1.js": "./lib/sha1-browser.js",
-    "./lib/md5.js": "./lib/md5-browser.js"
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/kelektiv/node-uuid.git"

lib/rng.js

@@ -0,0 +1,46 @@
+#!/bin/bash -eu
+
+# Mostly taken from:
+# https://github.com/date-fns/date-fns/blob/master/scripts/build/package.sh
+# and
+# https://medium.com/@iamstan/tips-for-writing-es-modules-in-node-js-96ec688615a4
+
+# cd to the root dir
+ROOT="$(pwd)/$(dirname "$0")/.."
+cd "$ROOT" || exit 1
+
+PATH="$(npm bin):$PATH"
+# XXX: $PACKAGE_OUTPUT_PATH must be an absolute path!
+DIR=${PACKAGE_OUTPUT_PATH:-"$ROOT/dist"}
+
+# Clean up output dir
+rm -rf "$DIR"
+mkdir -p "$DIR"
+
+# Transpile CommonJS versions of files
+babel --env-name commonjs src --source-root src --out-dir "$DIR" --copy-files --quiet
+
+# Transpile ESM versions of files for the browser
+babel --env-name esm src --source-root src --out-dir "$DIR/esm-browser" --copy-files --quiet
+
+# No need to have the CLI files in the esm build
+rm -rf "$DIR/esm-browser/bin"
+rm -rf "$DIR/esm-browser/uuid-bin.js"
+
+for FILE in "$DIR"/esm-browser/*-browser.js
+do
+    echo "Replacing node-specific file for esm-browser: $FILE"
+    mv "$FILE" "${FILE/-browser.js/.js}"
+done
+
+echo "Removing browser-specific files from esm-node"
+rm -f "$DIR"/*-browser.js
+
+# Copy basic files
+for PATTERN in package.json \
+  CHANGELOG.md \
+  LICENSE.md \
+  README.md
+do
+  cp -r "$PATTERN" "$DIR"
+done

package-lock.json

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../uuid-bin');

package.json

@@ -23,4 +23,4 @@ function bytesToUuid(buf, offset) {
   ]).join('');
 }
 
-module.exports = bytesToUuid;
+export default bytesToUuid;

scripts/package.sh

@@ -0,0 +1,4 @@
+export {default as v1} from './v1.js';
+export {default as v3} from './v3.js';
+export {default as v4} from './v4.js';
+export {default as v5} from './v5.js';

src/bin/uuid

@@ -18,9 +18,6 @@
  * Distributed under the BSD License
  * See http://pajhome.org.uk/crypt/md5 for more info.
  */
-
-'use strict';
-
 function md5(bytes) {
   if (typeof(bytes) == 'string') {
     var msg = unescape(encodeURIComponent(bytes)); // UTF8 escape
@@ -213,4 +210,4 @@ function md5ii(a, b, c, d, x, s, t) {
   return md5cmn(c ^ (b | (~d)), a, b, x, s, t);
 }
 
-module.exports = md5;
+export default md5;

lib/bytesToUuid.js src/bytesToUuid.js

@@ -1,6 +1,4 @@
-'use strict';
-
-var crypto = require('crypto');
+import crypto from 'crypto';
 
 function md5(bytes) {
   if (typeof Buffer.from === 'function') {
@@ -22,4 +20,4 @@ function md5(bytes) {
   return crypto.createHash('md5').update(bytes).digest();
 }
 
-module.exports = md5;
+export default md5;

src/index.js

@@ -8,11 +8,13 @@
 var getRandomValues = (typeof(crypto) != 'undefined' && crypto.getRandomValues && crypto.getRandomValues.bind(crypto)) ||
                       (typeof(msCrypto) != 'undefined' && typeof window.msCrypto.getRandomValues == 'function' && msCrypto.getRandomValues.bind(msCrypto));
 
+let rng;
+
 if (getRandomValues) {
   // WHATWG crypto RNG - http://wiki.whatwg.org/wiki/Crypto
   var rnds8 = new Uint8Array(16); // eslint-disable-line no-undef
 
-  module.exports = function whatwgRNG() {
+  rng = function whatwgRNG() {
     getRandomValues(rnds8);
     return rnds8;
   };
@@ -23,7 +25,7 @@ if (getRandomValues) {
   // quality.
   var rnds = new Array(16);
 
-  module.exports = function mathRNG() {
+  rng = function mathRNG() {
     for (var i = 0, r; i < 16; i++) {
       if ((i & 0x03) === 0) r = Math.random() * 0x100000000;
       rnds[i] = r >>> ((i & 0x03) << 3) & 0xff;
@@ -32,3 +34,5 @@ if (getRandomValues) {
     return rnds;
   };
 }
+
+export default rng;

lib/md5-browser.js src/md5-browser.js

@@ -0,0 +1,5 @@
+import crypto from 'crypto';
+
+export default function nodeRNG() {
+  return crypto.randomBytes(16);
+}

lib/md5.js src/md5.js

@@ -1,7 +1,5 @@
 // Adapted from Chris Veness' SHA1 code at
 // http://www.movable-type.co.uk/scripts/sha1.html
-'use strict';
-
 function f(s, x, y, z) {
   switch (s) {
     case 0: return (x & y) ^ (~x & z);
@@ -86,4 +84,4 @@ function sha1(bytes) {
   ];
 }
 
-module.exports = sha1;
+export default sha1;

lib/rng-browser.js src/rng-browser.js

@@ -1,6 +1,4 @@
-'use strict';
-
-var crypto = require('crypto');
+import crypto from 'crypto';
 
 function sha1(bytes) {
   if (typeof Buffer.from === 'function') {
@@ -22,4 +20,4 @@ function sha1(bytes) {
   return crypto.createHash('sha1').update(bytes).digest();
 }
 
-module.exports = sha1;
+export default sha1;

src/rng.js

@@ -1,5 +1,9 @@
-#!/usr/bin/env node
-var assert = require('assert');
+import assert from 'assert';
+
+import v1 from './v1.js';
+import v3 from './v3.js';
+import v4 from './v4.js';
+import v5 from './v5.js';
 
 function usage() {
   console.log('Usage:');
@@ -22,41 +26,35 @@ var version = args.shift() || 'v4';
 
 switch (version) {
   case 'v1':
-    var uuidV1 = require('../v1');
-    console.log(uuidV1());
+    console.log(v1());
     break;
 
   case 'v3':
-    var uuidV3 = require('../v3');
-
     var name = args.shift();
     var namespace = args.shift();
     assert(name != null, 'v3 name not specified');
     assert(namespace != null, 'v3 namespace not specified');
 
-    if (namespace == 'URL') namespace = uuidV3.URL;
-    if (namespace == 'DNS') namespace = uuidV3.DNS;
+    if (namespace === 'URL') namespace = v3.URL;
+    if (namespace === 'DNS') namespace = v3.DNS;
 
-    console.log(uuidV3(name, namespace));
+    console.log(v3(name, namespace));
     break;
 
   case 'v4':
-    var uuidV4 = require('../v4');
-    console.log(uuidV4());
+    console.log(v4());
     break;
 
   case 'v5':
-    var uuidV5 = require('../v5');
-
     var name = args.shift();
     var namespace = args.shift();
     assert(name != null, 'v5 name not specified');
     assert(namespace != null, 'v5 namespace not specified');
 
-    if (namespace == 'URL') namespace = uuidV5.URL;
-    if (namespace == 'DNS') namespace = uuidV5.DNS;
+    if (namespace === 'URL') namespace = v5.URL;
+    if (namespace === 'DNS') namespace = v5.DNS;
 
-    console.log(uuidV5(name, namespace));
+    console.log(v5(name, namespace));
     break;
 
   default:

lib/sha1-browser.js src/sha1-browser.js

@@ -1,5 +1,5 @@
-var rng = require('./lib/rng');
-var bytesToUuid = require('./lib/bytesToUuid');
+import rng from './rng.js';
+import bytesToUuid from './bytesToUuid.js';
 
 // **`v1()` - Generate time-based UUID**
 //
@@ -106,4 +106,4 @@ function v1(options, buf, offset) {
   return buf ? buf : bytesToUuid(b);
 }
 
-module.exports = v1;
+export default v1;

lib/sha1.js src/sha1.js

@@ -0,0 +1,5 @@
+import v35 from './v35.js';
+import md5 from './md5.js';
+
+const v3 = v35('v3', 0x30, md5);
+export default v3;

bin/uuid src/uuid-bin.js

@@ -1,4 +1,4 @@
-var bytesToUuid = require('./bytesToUuid');
+import bytesToUuid from './bytesToUuid.js';
 
 function uuidToBytes(uuid) {
   // Note: We assume we're being passed a valid uuid string
@@ -19,7 +19,10 @@ function stringToBytes(str) {
   return bytes;
 }
 
-module.exports = function(name, version, hashfunc) {
+export const DNS = '6ba7b810-9dad-11d1-80b4-00c04fd430c8';
+export const URL = '6ba7b811-9dad-11d1-80b4-00c04fd430c8';
+
+export default function(name, version, hashfunc) {
   var generateUUID = function(value, namespace, buf, offset) {
     var off = buf && offset || 0;
 
@@ -49,9 +52,9 @@ module.exports = function(name, version, hashfunc) {
   } catch (err) {
   }
 
-  // Pre-defined namespaces, per Appendix C
-  generateUUID.DNS = '6ba7b810-9dad-11d1-80b4-00c04fd430c8';
-  generateUUID.URL = '6ba7b811-9dad-11d1-80b4-00c04fd430c8';
+  // For CommonJS default export support
+  generateUUID.DNS = DNS;
+  generateUUID.URL = URL;
 
   return generateUUID;
-};
+}

v1.js src/v1.js

@@ -1,5 +1,5 @@
-var rng = require('./lib/rng');
-var bytesToUuid = require('./lib/bytesToUuid');
+import rng from './rng.js';
+import bytesToUuid from './bytesToUuid.js';
 
 function v4(options, buf, offset) {
   var i = buf && offset || 0;
@@ -26,4 +26,4 @@ function v4(options, buf, offset) {
   return buf || bytesToUuid(rnds);
 }
 
-module.exports = v4;
+export default v4;

src/v3.js

@@ -0,0 +1,5 @@
+import v35 from './v35.js';
+import sha1 from './sha1.js';
+
+const v5 = v35('v5', 0x50, sha1);
+export default v5;