add support for esm named exports

Through an ESM wrapper and package.exports this change allows the
semver module to be both imported and required while still supporting
legacy versions of Node.js. An important advantage to this change is that
semver will now support named imports, which are unsupported in commonjs
modules.

One thing to note. This change introduces the package.exports field
which locks down what modules can be deeply imported.

Currently support is maintained to allow deep imports of all files
currently included in package.files to keep the change Semver Minor.
In the future this interface could be further locked down.

Author: MylesBorins

.travis.yml

@@ -2,6 +2,7 @@ language: node_js
 
 node_js:
   - node
+  - 14
   - 12
   - 10
 

esm-wrapper.mjs

@@ -0,0 +1,145 @@
+// just pre-load all the stuff that index.js lazily exports
+import {createRequire} from 'module';
+
+const require = createRequire(import.meta.url);
+
+const internalRe = require('./internal/re');
+
+const re = internalRe.re;
+const src = internalRe.src;
+const tokens = internalRe.t;
+const SEMVER_SPEC_VERSION = require('./internal/constants').SEMVER_SPEC_VERSION;
+const SemVer = require('./classes/semver');
+const compareIdentifiers = require('./internal/identifiers').compareIdentifiers;
+const rcompareIdentifiers = require('./internal/identifiers').rcompareIdentifiers;
+const parse = require('./functions/parse');
+const valid = require('./functions/valid');
+const clean = require('./functions/clean');
+const inc = require('./functions/inc');
+const diff = require('./functions/diff');
+const major = require('./functions/major');
+const minor = require('./functions/minor');
+const patch = require('./functions/patch');
+const prerelease = require('./functions/prerelease');
+const compare = require('./functions/compare');
+const rcompare = require('./functions/rcompare');
+const compareLoose = require('./functions/compare-loose');
+const compareBuild = require('./functions/compare-build');
+const sort = require('./functions/sort');
+const rsort = require('./functions/rsort');
+const gt = require('./functions/gt');
+const lt = require('./functions/lt');
+const eq = require('./functions/eq');
+const neq = require('./functions/neq');
+const gte = require('./functions/gte');
+const lte = require('./functions/lte');
+const cmp = require('./functions/cmp');
+const coerce = require('./functions/coerce');
+const Comparator = require('./classes/comparator');
+const Range = require('./classes/range');
+const satisfies = require('./functions/satisfies');
+const toComparators = require('./ranges/to-comparators');
+const maxSatisfying = require('./ranges/max-satisfying');
+const minSatisfying = require('./ranges/min-satisfying');
+const minVersion = require('./ranges/min-version');
+const validRange = require('./ranges/valid');
+const outside = require('./ranges/outside');
+const gtr = require('./ranges/gtr');
+const ltr = require('./ranges/ltr');
+const intersects = require('./ranges/intersects');
+const simplifyRange = require('./ranges/simplify');
+const subset = require('./ranges/subset');
+
+export default {
+  re,
+  src,
+  tokens,
+  SEMVER_SPEC_VERSION,
+  SemVer,
+  compareIdentifiers,
+  rcompareIdentifiers,
+  parse,
+  valid,
+  clean,
+  inc,
+  diff,
+  major,
+  minor,
+  patch,
+  prerelease,
+  compare,
+  rcompare,
+  compareLoose,
+  compareBuild,
+  sort,
+  rsort,
+  gt,
+  lt,
+  eq,
+  neq,
+  gte,
+  lte,
+  cmp,
+  coerce,
+  Comparator,
+  Range,
+  satisfies,
+  toComparators,
+  maxSatisfying,
+  minSatisfying,
+  minVersion,
+  validRange,
+  outside,
+  gtr,
+  ltr,
+  intersects,
+  simplifyRange,
+  subset
+};
+
+export {
+  re,
+  src,
+  tokens,
+  SEMVER_SPEC_VERSION,
+  SemVer,
+  compareIdentifiers,
+  rcompareIdentifiers,
+  parse,
+  valid,
+  clean,
+  inc,
+  diff,
+  major,
+  minor,
+  patch,
+  prerelease,
+  compare,
+  rcompare,
+  compareLoose,
+  compareBuild,
+  sort,
+  rsort,
+  gt,
+  lt,
+  eq,
+  neq,
+  gte,
+  lte,
+  cmp,
+  coerce,
+  Comparator,
+  Range,
+  satisfies,
+  toComparators,
+  maxSatisfying,
+  minSatisfying,
+  minVersion,
+  validRange,
+  outside,
+  gtr,
+  ltr,
+  intersects,
+  simplifyRange,
+  subset
+};

package.json

@@ -3,6 +3,24 @@
   "version": "7.3.2",
   "description": "The semantic version parser used by npm.",
   "main": "index.js",
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "import": "./esm-wrapper.mjs"
+    },
+    "./bin/": "./bin/",
+    "./range.bnf": "./range.bnf",
+    "./classes/": "./classes/",
+    "./functions/": "./functions/",
+    "./internal/": "./internal/",
+    "./ranges/": "./ranges/",
+    "./index.js": "./index.js",
+    "./index": "./index.js",
+    "./preload.js": "./preload.js",
+    "./preload": "./preload.js",
+    "./package.json": "./package.json",
+    "./package": "./package.json"
+  },
   "scripts": {
     "test": "tap",
     "snap": "tap",
@@ -30,7 +48,8 @@
   ],
   "tap": {
     "check-coverage": true,
-    "coverage-map": "map.js"
+    "coverage-map": "map.js",
+    "test-ignore": "/test/esm/"
   },
   "engines": {
     "node": ">=10"

test/esm/test-default.mjs

@@ -0,0 +1,15 @@
+import {createRequire} from 'module'
+import semver from '../../esm-wrapper.mjs'
+import t from 'tap'
+
+const require = createRequire(import.meta.url)
+
+const {SEMVER_SPEC_VERSION} = require('../../internal/constants')
+
+t.match(Object.getOwnPropertyDescriptor(semver, 'SEMVER_SPEC_VERSION'), {
+  get: undefined,
+  set: undefined,
+  value: SEMVER_SPEC_VERSION,
+  configurable: true,
+  enumerable: true
+}, 'just a normal value property')

test/esm/test-named.mjs

@@ -0,0 +1,14 @@
+import {clean, coerce, gt, lt, satisfies, valid} from '../../esm-wrapper.mjs'
+import t from 'tap'
+
+t.test('esm: test named exports', t => {
+  t.ok(valid('1.2.3'));
+  t.notOk(valid('a.b.c'))
+  t.equals(clean('  =v1.2.3   '), '1.2.3')
+  t.ok(satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3'))
+  t.notOk(gt('1.2.3', '9.8.7'))
+  t.ok(lt('1.2.3', '9.8.7'))
+  t.equals(valid(coerce('v2')), '2.0.0')
+  t.equals(valid(coerce('42.6.7.9.3-alpha')), '42.6.7')
+  t.end()
+});

test/test-esm.js

@@ -0,0 +1,17 @@
+const {resolve} = require('path');
+const {gt} = require('../');
+const tap = require('tap');
+
+if (gt(process.version, '14.0.0')) {
+  tap.test('test esm', async t => {
+    const defaultTest = resolve(__dirname, './esm/test-default.mjs');
+    const namedExportsTest = resolve(__dirname, './esm/test-named.mjs');
+    await t.spawn(process.execPath, defaultTest);
+    await t.spawn(process.execPath, namedExportsTest)
+    t.ok(true)
+    t.end();
+  });
+} else {
+  tap.ok(true, 'Skip ESM Test on unsupported Node.js');
+  tap.end();
+}