Merge pull request #126 from microsoft/esm_tests

Orta Therox · web-flow · commit 65edb9837c57 · 2020-10-06T11:07:16.000-04:00
Adds es modules support and tests
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -0,0 +1,57 @@
+name: CI
+
+on: pull_request
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use node version ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Setup Testing Infra
+        run: |
+          cd test
+          npm install
+
+      - name: "CommonJS Test"
+        run: |
+          cd test/cjs
+          npm run test
+
+      - name: "ES Modules Test"
+        run: |
+          cd test/esm-node-native
+          npm run test
+        if: ${{ matrix.node-version == '14.x' }}
+
+      - name: "Validate ES Modules == CommonJS"
+        run: |
+          cd test/validateModuleExportsMatchCommonJS
+          npm run test
+        if: ${{ matrix.node-version == '14.x' }}
+
+      - name: "Rollup Tree-shaking Test"
+        run: |
+          cd test/rollup-modules
+          npm run test
+
+      - name: "Webpack Tree-shaking Test"
+        run: |
+          cd test/webpack-modules
+          npm run test
+
+      - name: "Snowpack Tree-shaking Test"
+        run: |
+          cd test/snowpack-modules
+          npm run test
+        if: ${{ matrix.node-version == '14.x' }}
diff --git a/.npmignore b/.npmignore
@@ -2,3 +2,5 @@
 .github
 bower.json
 docs
+test
+.npmrc
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/modules/index.js b/modules/index.js
@@ -0,0 +1,51 @@
+import tslib from '../tslib.js';
+const {
+    __extends,
+    __assign,
+    __rest,
+    __decorate,
+    __param,
+    __metadata,
+    __awaiter,
+    __generator,
+    __exportStar,
+    __createBinding,
+    __values,
+    __read,
+    __spread,
+    __spreadArrays,
+    __await,
+    __asyncGenerator,
+    __asyncDelegator,
+    __asyncValues,
+    __makeTemplateObject,
+    __importStar,
+    __importDefault,
+    __classPrivateFieldGet,
+    __classPrivateFieldSet,
+} = tslib;
+export {
+    __extends,
+    __assign,
+    __rest,
+    __decorate,
+    __param,
+    __metadata,
+    __awaiter,
+    __generator,
+    __exportStar,
+    __createBinding,
+    __values,
+    __read,
+    __spread,
+    __spreadArrays,
+    __await,
+    __asyncGenerator,
+    __asyncDelegator,
+    __asyncValues,
+    __makeTemplateObject,
+    __importStar,
+    __importDefault,
+    __classPrivateFieldGet,
+    __classPrivateFieldSet,
+};
diff --git a/modules/package.json b/modules/package.json
@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}
diff --git a/package.json b/package.json
@@ -25,5 +25,12 @@
     "module": "tslib.es6.js",
     "jsnext:main": "tslib.es6.js",
     "typings": "tslib.d.ts",
-    "sideEffects": false
+    "sideEffects": false,
+    "exports": {
+        ".": {
+            "import": "./modules/index.js",
+            "default": "./tslib.js"
+        },
+        "./": "./"
+    }
 }
diff --git a/test/.gitignore b/test/.gitignore
@@ -0,0 +1,2 @@
+package-lock.json
+*/build
diff --git a/test/README.md b/test/README.md
@@ -0,0 +1,4 @@
+### Tests
+
+Each folder has a `test` script which imports `tslib` via node_modules. 
+In order to run these tests, you first need to run `npm install` in this folder.
diff --git a/test/cjs/index.js b/test/cjs/index.js
@@ -0,0 +1,2 @@
+const tslib = require("tslib");
+if (typeof tslib.__awaiter !== "function") throw new Error("Missing expected helper __awaiter");
diff --git a/test/cjs/package.json b/test/cjs/package.json
@@ -0,0 +1,6 @@
+{
+  "private": true,
+  "scripts": {
+    "test": "node index.js"
+  }
+}
diff --git a/test/esm-node-native/index.js b/test/esm-node-native/index.js
@@ -0,0 +1,2 @@
+import { __awaiter } from "tslib";
+if (typeof __awaiter !== "function") throw new Error("Missing expected helper __awaiter");
diff --git a/test/esm-node-native/package.json b/test/esm-node-native/package.json
@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "scripts": {
+    "test": "node index.js"
+  }
+}
diff --git a/test/package.json b/test/package.json
@@ -0,0 +1,10 @@
+{
+  "dependencies": {
+    "tslib": "file:..",
+    "rollup": "2.28.2",
+    "@rollup/plugin-node-resolve": "9.0.0",
+    "webpack": "4.44.2",
+    "webpack-cli": "3.3.12",
+    "snowpack": "^2.12.1"
+  }
+}
diff --git a/test/rollup-modules/index.js b/test/rollup-modules/index.js
@@ -0,0 +1,2 @@
+import { __awaiter } from "tslib";
+if (typeof __awaiter !== "function") throw new Error("Missing expected helper __awaiter");
diff --git a/test/rollup-modules/package.json b/test/rollup-modules/package.json
@@ -0,0 +1,5 @@
+{
+  "scripts": {
+    "test": "../node_modules/.bin/rollup -c rollup.config.js && node build/index.js"
+  }
+}
diff --git a/test/rollup-modules/rollup.config.js b/test/rollup-modules/rollup.config.js
@@ -0,0 +1,10 @@
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+
+export default {
+  input: 'index.js',
+  output: {
+    dir: 'build',
+    format: 'cjs'
+  },
+  plugins: [nodeResolve()]
+};
diff --git a/test/snowpack-modules/index.js b/test/snowpack-modules/index.js
@@ -0,0 +1,2 @@
+import { __awaiter } from "tslib";
+if (typeof __awaiter !== "function") throw new Error("Missing expected helper __awaiter");
diff --git a/test/snowpack-modules/package.json b/test/snowpack-modules/package.json
@@ -0,0 +1,7 @@
+{
+  "type": "module",
+
+  "scripts": {
+    "test": "../node_modules/.bin/snowpack build; node build/index.js"
+  }
+}
diff --git a/test/validateModuleExportsMatchCommonJS/index.js b/test/validateModuleExportsMatchCommonJS/index.js
@@ -0,0 +1,23 @@
+// When on node 14, it validates that all of the commonjs exports
+// are correctly re-exported for es modules importers.
+
+const nodeMajor = Number(process.version.split(".")[0].slice(1))
+if (nodeMajor < 14) {
+  console.log("Skipping because node does not support module exports.")
+  process.exit(0)
+}
+
+// ES Modules import via the ./modules folder
+import * as esTSLib from "../../modules/index.js"
+
+// Force a commonjs resolve
+import { createRequire } from "module";
+const commonJSTSLib = createRequire(import.meta.url)("../../tslib.js");
+
+for (const key in commonJSTSLib) {
+  if (commonJSTSLib.hasOwnProperty(key)) {
+    if(!esTSLib[key]) throw new Error(`ESModules is missing ${key} - it needs to be re-exported in  ./modules/index.js`)
+  }
+}
+
+console.log("All exports in commonjs are available for es module consumers.")
diff --git a/test/validateModuleExportsMatchCommonJS/package.json b/test/validateModuleExportsMatchCommonJS/package.json
@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "scripts": {
+    "test": "node index.js"
+  }
+}
diff --git a/test/webpack-modules/index.js b/test/webpack-modules/index.js
@@ -0,0 +1,2 @@
+import { __awaiter } from "tslib";
+if (typeof __awaiter !== "function") throw new Error("Missing expected helper __awaiter");
diff --git a/test/webpack-modules/package.json b/test/webpack-modules/package.json
@@ -0,0 +1,5 @@
+{
+  "scripts": {
+    "test": "../node_modules/.bin/webpack && node build/main.js"
+  }
+}
diff --git a/test/webpack-modules/webpack.config.js b/test/webpack-modules/webpack.config.js
@@ -0,0 +1,12 @@
+const path = require('path');
+
+/** @type {import("webpack").Configuration} */
+const config = {
+  mode: "production", 
+  entry: "./index",
+  output: {
+    path: path.join(process.cwd(), 'build')
+  } 
+}
+
+module.exports = config

-Original file line number
+Diff line change
 .github
 bower.json
 docs
 +test
 +.npmrc
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+const tslib = require("tslib");`
	`2`	`+if (typeof tslib.__awaiter !== "function") throw new Error("Missing expected helper __awaiter");`