Merge pull request #40 from huan/esm

refactor to publslih as esm

Author: huan

.eslintrc.js renamed to .eslintrc.cjs

@@ -1,4 +1,3 @@
-
 const rules = {
 }
 

.gitignore

@@ -40,4 +40,5 @@ jspm_packages
 /bundles/
 /package-lock.json
 /state-switch-*.*.*.tgz
-
+t.*
+t/

package.json

@@ -1,21 +1,27 @@
 {
   "name": "state-switch",
-  "version": "0.14.1",
+  "version": "0.15.4",
   "description": "State Switch is a Change Monitor/Guarder for Async Actions.",
-  "main": "bundles/state-switch.umd.js",
-  "types": "dist/src/mod.d.ts",
+  "main": "./dist/cjs/src/mod.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/src/mod.js",
+      "require": "./dist/cjs/src/mod.js"
+    }
+  },
+  "typings": "./dist/esm/src/mod.d.ts",
   "scripts": {
     "clean": "rm -fr dist/* bundles/*",
-    "dist": "npm run clean && npm run build && npm run rollup && npm run dist:es6to5",
-    "dist:es6to5": "tsc --out ./bundles/state-switch.umd.js --target es5 --allowJs bundles/state-switch.es6.umd.js --lib es6,dom",
-    "build": "tsc --module es6",
+    "dist": "npm run clean && npm run build && (cd dist/cjs; npm init -y > /dev/null)",
+    "build": "tsc && tsc -p tsconfig.cjs.json",
     "lint": "npm run lint:es && npm run lint:ts",
     "rollup": "rollup -c",
     "lint:ts": "tsc --noEmit",
     "demo": "ts-node example/demo",
     "test": "npm run lint && npm run test:ts",
     "test:pack": "bash -x scripts/npm-pack-testing.sh",
-    "test:ts": "blue-tape -r ts-node/register src/**/*.spec.ts tests/**/*.spec.ts",
+    "test:ts": "tap --node-arg=--loader=ts-node/esm src/**/*.spec.ts tests/**/*.spec.ts",
     "lint:es": "eslint --ignore-pattern fixtures/ 'src/**/*.ts' 'tests/**/*.ts'"
   },
   "repository": {
@@ -44,7 +50,7 @@
     "rollup-plugin-json": "^4.0.0",
     "rxjs": "^7.1.0",
     "tsd": "^0.16.0",
-    "tstest": "^0.4.10"
+    "tstest": "^0.5.16"
   },
   "files": [
     "LICENSE",

rollup.config.js

@@ -4,11 +4,12 @@ export default {
   input: 'dist/src/mod.js',
   output: {
     banner: '/* state-switch version ' + require('./package.json').version + ' */',
-    file: 'bundles/state-switch.es6.umd.js',
+    file: 'bundles/state-switch.es6.js',
     footer: '/* https://github.com/huan */',
-    format: 'umd',
+    format: 'es',
     name: 'window',
     sourcemap: true,
+    exports: 'named',
   },
   plugins: [
     json({

scripts/npm-pack-testing.sh

@@ -10,7 +10,11 @@ mv *-*.*.*.tgz "$TMPDIR"
 cp tests/fixtures/smoke-testing.ts "$TMPDIR"
 
 cd $TMPDIR
+
 npm init -y
+# https://stackoverflow.com/a/59203952/1123955
+echo "`jq '.type="module"' package.json`" > package.json
+
 npm install *-*.*.*.tgz \
   @types/node \
   typescript@latest
@@ -21,6 +25,9 @@ npm install *-*.*.*.tgz \
   --noEmitOnError \
   --noImplicitAny \
   --skipLibCheck \
+  --target es2020 \
+  --module es2020 \
+  --moduleResolution node \
   smoke-testing.ts
 
 node smoke-testing.js

src/mod.ts

@@ -1,6 +1,10 @@
-export {
+import {
   StateSwitch,
-  StateSwitch as default,
-}                           from './state-switch'
+}                   from './state-switch.js'
+import { VERSION }  from './version.js'
 
-export { VERSION } from './version'
+export {
+  StateSwitch,
+  VERSION,
+}
+export default StateSwitch

src/state-switch.spec.ts

@@ -1,10 +1,11 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env node --loader ts-node/esm
 
-// tslint:disable:no-shadowed-variable
-import test  from 'blue-tape'
-import sinon from 'sinon'
+import {
+  test,
+  sinon,
+}             from 'tstest'
 
-import { StateSwitch } from './state-switch'
+import { StateSwitch } from './state-switch.js'
 
 test('on()', async t => {
   const ss = new StateSwitch()
@@ -111,26 +112,26 @@ test('on/off events emitting', async t => {
   ss.addListener('on',  spyOn)
   ss.addListener('off', spyOff)
 
-  t.true(spyOn.notCalled, 'spyOn is not called')
-  t.true(spyOff.notCalled, 'spyOff is not called')
+  t.ok(spyOn.notCalled, 'spyOn is not called')
+  t.ok(spyOff.notCalled, 'spyOff is not called')
 
   ss.on('pending')
-  t.true(spyOn.calledOnce, 'spyOn is called once after on(pending)')
-  t.deepEqual(spyOn.args[0], ['pending'], 'spyOn should be called with `pending` arg')
-  t.true(spyOff.notCalled, 'spyOff is not called')
+  t.ok(spyOn.calledOnce, 'spyOn is called once after on(pending)')
+  t.same(spyOn.args[0], ['pending'], 'spyOn should be called with `pending` arg')
+  t.ok(spyOff.notCalled, 'spyOff is not called')
 
   ss.on(true)
-  t.true(spyOn.calledTwice, 'spyOn is called once after on(pending)')
-  t.deepEqual(spyOn.args[1], [true], 'spyOn should be called with `true` arg')
-  t.true(spyOff.notCalled, 'spyOff is not called')
+  t.ok(spyOn.calledTwice, 'spyOn is called once after on(pending)')
+  t.same(spyOn.args[1], [true], 'spyOn should be called with `true` arg')
+  t.ok(spyOff.notCalled, 'spyOff is not called')
 
   ss.off('pending')
-  t.true(spyOff.calledOnce, 'spyOff is called once after off(pending)')
-  t.deepEqual(spyOff.args[0], ['pending'], 'spyOff should be called with `pending` arg')
+  t.ok(spyOff.calledOnce, 'spyOff is called once after off(pending)')
+  t.same(spyOff.args[0], ['pending'], 'spyOff should be called with `pending` arg')
 
   ss.off(true)
-  t.true(spyOff.calledTwice, 'spyOff is called twice after off(true)')
-  t.deepEqual(spyOff.args[1], [true], 'spyOff should be called with `true` arg')
+  t.ok(spyOff.calledTwice, 'spyOff is called twice after off(true)')
+  t.same(spyOff.args[1], [true], 'spyOff should be called with `true` arg')
 
-  t.true(spyOn.calledTwice, 'spyOn called twice at last')
+  t.ok(spyOn.calledTwice, 'spyOn called twice at last')
 })

src/state-switch.ts

@@ -12,7 +12,7 @@ import { EventEmitter } from 'events'
 
 import NOP from 'nop'
 
-import { VERSION } from './version'
+import { VERSION } from './version.js'
 
 /**
  * Using Three Valued Logic for ON/OFF State

src/version.spec.ts

@@ -1,9 +1,8 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env node --loader ts-node/esm
 
-// tslint:disable:no-shadowed-variable
-import test  from 'tstest'
+import { test } from 'tstest'
 
-import { VERSION } from './version'
+import { VERSION } from './version.js'
 
 test('Make sure the VERSION is fresh in source code', async (t) => {
   t.equal(VERSION, '0.0.0', 'version should be 0.0.0 in source code, only updated before publish to NPM')

tests/fixtures/smoke-testing.ts

@@ -3,10 +3,6 @@ import Default, {
   VERSION,
 }               from 'state-switch'
 
-if (VERSION === '0.0.0') {
-  throw new Error('version should be set before publishing')
-}
-
 const ss = new StateSwitch()
 console.info(`StateSwitch v${ss.version()}`)
 
@@ -19,4 +15,8 @@ if (Default !== StateSwitch) {
   throw new Error('default export does not match the exported module!')
 }
 
+if (VERSION === '0.0.0') {
+  throw new Error('version should be set before publishing')
+}
+
 console.info('Smoke Testing PASSED!')

tests/from-event-type.spec.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env node --loader ts-node/esm
 
 import { test }  from 'tstest'
 import {
@@ -13,7 +13,7 @@ import {
 }                 from 'rxjs'
 import { HasEventTargetAddRemove } from 'rxjs/internal/observable/fromEvent'
 
-import { StateSwitch } from '../src/state-switch'
+import { StateSwitch } from '../src/state-switch.js'
 
 test('StateSwitch satisfy DOM EventTarget: HasEventTargetAddRemove', async t => {
   const state = new StateSwitch()

tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "CommonJS",
+    "outDir": "dist/cjs",
+  },
+}

tsconfig.json

@@ -1,9 +1,9 @@
 {
   "compilerOptions": {
-    "target": "es6",
-    "module": "commonjs",
+    "target": "es2020",
+    "module": "es2020",
     "moduleResolution": "node",
-    "outDir": "dist",
+    "outDir": "dist/esm",
     "declaration": true,
     "sourceMap": true,
     "noLib": false,