add AssertEqual & enable ESM

Author: huan

.eslintrc.js .eslintrc.cjs

@@ -11,15 +11,16 @@ jobs:
           - ubuntu-latest
           # - macos-latest
           # - windows-latest
-        # node: [10, 11, 12, 13, 14, 15, 16]
-        node: [16]
+        node-version:
+          - 16
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node }}
         uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
+          cache: npm
           cache-dependency-path: package.json
 
       - name: Install Dependencies
@@ -44,6 +45,7 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
+          cache: npm
           cache-dependency-path: package.json
 
       - name: Install Dependencies
@@ -66,6 +68,7 @@ jobs:
         with:
           node-version: 16
           registry-url: https://registry.npmjs.org/
+          cache: npm
           cache-dependency-path: package.json
 
       - name: Install Dependencies

.github/workflows/npm.yml

@@ -67,6 +67,8 @@ This module is highly inspired by [pytest](https://pytest.org/)
 
 1. Upgrade to [tap](https://github.com/tapjs/node-tap) to replace [blue-tape](https://github.com/spion/blue-tape) ([wechayt/wechaty#2223](https://github.com/wechaty/wechaty/pull/2223))
 1. Remove `sinon-test`
+1. Enable ES Modules
+1. Add `AssertEqual` for typing tests
 
 ### v0.4 June 07, 2019
 

README.md

@@ -1,19 +1,29 @@
 {
   "name": "tstest",
-  "version": "0.5.16",
+  "version": "0.7.0",
   "description": "Testing Utilities for Helping You to Write Better TypeScript Programs",
-  "main": "dist/src/mod.js",
-  "typings": "dist/src/mod.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/src/mod.js",
+      "require": "./dist/cjs/src/mod.js"
+    }
+  },
+  "typings": "./dist/esm/src/mod.d.ts",
+  "engines": {
+    "node": ">=16",
+    "npm": ">=7"
+  },
   "scripts": {
-    "build": "tsc",
     "clean": "shx rm -fr dist/*",
-    "dist": "npm run clean && npm run build",
-    "pack": "npm pack",
-    "lint": "npm run lint:es && npm run lint:ts",
+    "dist": "npm-run-all clean build dist:commonjs",
+    "build": "tsc && tsc -p tsconfig.cjs.json",
+    "dist:commonjs": "jq -n \"{ type: \\\"commonjs\\\" }\" > dist/cjs/package.json",
+    "lint": "npm-run-all lint:es lint:ts",
     "lint:es": "eslint --ignore-pattern tests/fixtures/ '{bin,examples,scripts,src,tests}/**/*.ts'",
-    "lint:ts": "tsc --noEmit",
+    "lint:ts": "tsc --isolatedModules --noEmit",
     "test:pack": "bash -x scripts/npm-pack-testing.sh",
-    "test": "tap --node-arg=--require=ts-node/register \"src/**/*.spec.ts\" \"src/*.spec.ts\" \"tests/*.spec.ts\" \"tests/**/*.spec.ts\""
+    "test": "cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" tap \"src/**/*.spec.ts\" \"tests/**/*.spec.ts\""
   },
   "repository": {
     "type": "git",
@@ -32,10 +42,12 @@
   },
   "homepage": "https://github.com/huan/tstest#readme",
   "devDependencies": {
-    "@chatie/eslint-config": "^0.12.4",
+    "@chatie/eslint-config": "^0.14.1",
     "@chatie/git-scripts": "^0.6.2",
     "@chatie/semver": "^0.4.7",
-    "@chatie/tsconfig": "^0.16.2",
+    "@chatie/tsconfig": "^0.20.2",
+    "cross-env": "^7.0.3",
+    "npm-run-all": "^4.1.5",
     "read-pkg-up": "^7",
     "shx": "^0.3.3"
   },
@@ -51,6 +63,10 @@
       "pre-push": "npx git-scripts-pre-push"
     }
   },
+  "files": [
+    "dist",
+    "src"
+  ],
   "publishConfig": {
     "tag": "next"
   }

package.json

@@ -2,29 +2,59 @@
 set -e
 
 npm run dist
-npm run pack
+npm pack
 
 TMPDIR="/tmp/npm-pack-testing.$$"
 mkdir "$TMPDIR"
 mv *-*.*.*.tgz "$TMPDIR"
 cp tests/fixtures/smoke-testing.ts "$TMPDIR"
 
 cd $TMPDIR
+
 npm init -y
-npm install --production \
-  *-*.*.*.tgz \
+npm install *-*.*.*.tgz \
   @types/node \
   is-pr \
-  typescript
+  typescript@latest
 
+#
+# CommonJS
+#
 ./node_modules/.bin/tsc \
+  --esModuleInterop \
   --lib esnext \
-  --strict \
+  --noEmitOnError \
+  --noImplicitAny \
+  --skipLibCheck \
+  --target es5 \
+  --module CommonJS \
+  --moduleResolution node \
+  smoke-testing.ts
+
+echo
+echo "CommonJS: pack testing..."
+node smoke-testing.js
+
+#
+# ES Modules
+#
+
+# https://stackoverflow.com/a/59203952/1123955
+echo "`jq '.type="module"' package.json`" > package.json
+
+./node_modules/.bin/tsc \
   --esModuleInterop \
+  --lib esnext \
   --noEmitOnError \
   --noImplicitAny \
   --skipLibCheck \
+  --target es2020 \
+  --module es2020 \
+  --moduleResolution node \
   smoke-testing.ts
 
+echo
+echo "ES Module: pack testing..."
 node smoke-testing.js
+
 # (for i in {1..3}; do node smoke-testing.js && break || sleep 1; done)

scripts/npm-pack-testing.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import { test } from './mod.js'
+
+import type { AssertEqual } from './assert-equal.js'
+
+test('AssertEqual smoke testing', async (t) => {
+  type T = string
+  type EXPECTED_TYPE = string
+  const typeTest: AssertEqual<T, EXPECTED_TYPE> = true
+
+  t.ok(typeTest, 'should pass the typing test')
+})

src/assert-equal.spec.ts

@@ -0,0 +1,15 @@
+/**
+ * Huan(202109): #18 - `dts` package conflict node_modules/.bin/tsc version
+ *  https://github.com/huan/sidecar/issues/18
+ *
+ *  Testing static types in TypeScript
+ *    https://2ality.com/2019/07/testing-static-types.html
+ */
+type AssertEqual<T, Expected> =
+  T extends Expected
+    ? (Expected extends T ? true : never)
+    : never
+
+export type {
+  AssertEqual,
+}

src/assert-equal.ts

@@ -1,9 +1,13 @@
 import sinon from 'sinon'
 
-import { test }     from './tap'
-import { TsTest }   from './tstest'
-import { VERSION }  from './version'
+import { test }     from './tap.js'
+import { TsTest }   from './tstest.js'
+import { VERSION }  from './version.js'
+import type { AssertEqual } from './assert-equal.js'
 
+export type {
+  AssertEqual,
+}
 export {
   sinon,
   test,

src/mod.ts

@@ -1,6 +1,6 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
 
-import { test } from './tap'
+import { test } from './tap.js'
 
 test('test smoke testing', async t => {
   t.ok('test is ok')

src/tap.spec.ts

@@ -1,8 +1,8 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
 
-import { test } from './mod'
+import { test } from './mod.js'
 
-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')

src/version.spec.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
 
 import {
   test,

tests/fixtures/smoke-testing.ts

@@ -1,11 +1,11 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
 
 import {
   test,
   VERSION,
   TsTest,
   // sinon,
-}               from '../src/mod'
+}               from '../src/mod.js'
 
 test('test', async t => {
   t.ok(VERSION, 'ok')

tests/integration.spec.ts

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

tsconfig.cjs.json

@@ -1,7 +1,7 @@
 {
   "extends": "@chatie/tsconfig",
   "compilerOptions": {
-    "outDir": "dist",
+    "outDir": "dist/esm",
   },
   "exclude": [
     "node_modules/",