Merge pull request #80 from userfrosting/feature-native-esm

Switch to plain ESM

Author: Silic0nS0ldier

.github/workflows/ci.yml

@@ -1,96 +1,40 @@
-{
-    "name": "Continuous Integration",
-    "on": {
-        # Every push
-        "push": {},
-        "schedule": [
-            {
-                # Every Monday and Thursday at 12PM UTC
-                "cron": "0 12 * * 1,4"
-            }
-        ]
-    },
-    "jobs": {
-        "test": {
-            "strategy": {
-                "matrix": {
-                    "os": [
-                        "ubuntu-latest",
-                        "macos-latest",
-                        "windows-latest"
-                    ],
-                    "node-version": [
-                        "10.x",
-                        "12.x",
-                        "13.x"
-                    ]
-                }
-            },
-            "runs-on": "${{ matrix.os }}",
-            "steps": [
-                {
-                    "name": "Checkout",
-                    "uses": "actions/checkout@v1"
-                },
-                {
-                    "name": "Setup node",
-                    "uses": "actions/setup-node@v1",
-                    "with": {
-                        "node-version": "${{ matrix.node-version }}"
-                    }
-                },
-                {
-                    "name": "Install dependencies",
-                    "run": "npm ci"
-                },
-                {
-                    "name": "Run tests",
-                    "run": "./node_modules/.bin/nyc --reporter=lcovonly npm test"
-                },
-                {
-                    "name": "Push coverage to Codecov",
-                    "uses": "codecov/codecov-action@v1",
-                    "with": {
-                        "token": "${{ secrets.CODECOV_UPLOAD_TOKEN }}"
-                    }
-                }
-            ]
-        },
-        "release-readiness": {
-            "runs-on": "ubuntu-latest",
-            "steps": [
-                {
-                    "name": "Checkout",
-                    "uses": "actions/checkout@v1"
-                },
-                {
-                    "name": "Setup node",
-                    "uses": "actions/setup-node@v1",
-                    "with": {
-                        "node-version": "13.x"
-                    }
-                },
-                {
-                    "name": "Install cspell",
-                    "run": "npm i -g cspell"
-                },
-                {
-                    "name": "Check spelling",
-                    "run": "cspell '**'"
-                },
-                {
-                    "name": "Install package dependencies",
-                    "run": "npm ci"
-                },
-                {
-                    "name": "Build",
-                    "run": "./node_modules/.bin/tsc"
-                },
-                {
-                    "name": "Check for unconfirmed API changes",
-                    "run": "./node_modules/.bin/api-extractor run"
-                }
-            ]
-        }
-    }
-}
+name: Continuous Integration
+on:
+    # Every push
+    push:
+    schedule:
+        # Every Monday and Thursday at 12PM UTC
+        - cron: '0 12 * * 1,4'
+
+jobs:
+    test:
+        strategy:
+            matrix:
+                platform: [ ubuntu-latest, macos-latest, windows-latest ]
+                node-version: [ ^12.17.0, ^13.0.0, ^14.0.0 ]
+        runs-on: ${{ matrix.platform }}
+        steps:
+        - uses: actions/checkout@v2
+        - uses: actions/setup-node@v1
+          with:
+            node-version: ${{ matrix.node-version }}
+        - run: npm ci
+        - run: ./node_modules/.bin/c8 --reporter=lcovonly npm test
+        - uses: codecov/codecov-action@v1
+          with:
+            token: ${{ secrets.CODECOV_UPLOAD_TOKEN }}
+    release-readines:
+        runs-on: ubuntu-latest
+        steps:
+        - uses: actions/checkout@v2
+        - uses: actions/setup-node@v1
+          with:
+            node-version: ^14.0.0
+        - name: Install cspell
+          run: npm i -g cspell
+        - name: Check spelling
+          run: cspell '**'
+        - run: npm ci
+        - run: ./node_modules/.bin/tsc
+        - name: Check for unconfirmed API changes
+          run: ./node_modules/.bin/api-extractor run

.gitignore

@@ -4,3 +4,4 @@ dist/
 .nyc_output
 coverage
 temp
+pnpm-lock.yaml

.npmignore

@@ -1,7 +1,7 @@
 !dist/
 .editorconfig
 .gitattributes
-.nyc_output/
+coverage/
 .travis.yml
 **/*.test.d.ts
 **/*.test.js
@@ -14,3 +14,4 @@ temp/
 test-data/
 tsconfig.json
 .github
+.dependabot

CHANGELOG.md

@@ -9,11 +9,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Changed
 - Updated interface of `BundleOrchestrator._transform` reflecting tighter constraints in `@types/node` v14. No modification to runtime logic, method only used by NodeJS streams.
-
-## [4.0.1] - 2020-04-18
+- Removed `esm` loader in favour of native ESM support.
+- Raised minimum NodeJS version from 10 to 12.17.0.
+- Changed exception type thrown when a configuration merge fails, consequence of changing error wrapper from `errlop` to `@jsdevtools/ono`.
 
 [//]: # (spell-checker:disable)
 
+### Removed
+- Removed deprecated export `BundleOrchastrator`.
+
+## [4.0.1] - 2020-04-18
+
 ### Fixed
 - Missing bundles and files not being logged when stream completes without providing all required files.
 

README.md

@@ -14,10 +14,14 @@ npm i -D  @userfrosting/gulp-bundle-assets
 
 ## Usage
 
+> **IMPORTANT**<br/>
+> This is an ES module package targeting NodeJS `^12.17.0 || >=13.2.0`, refer to the [NodeJS ESM docs](https://nodejs.org/api/esm.html) regarding how to correctly import.
+> ESM loaders like `@babel/loader` or `esm` likely won't work as expected. Using native ESM support in Gulp is recommended (once it lands [gulpjs/gulp-cli#214](https://github.com/gulpjs/gulp-cli/pull/214), [gulpjs/interpret#65](https://github.com/gulpjs/interpret/issues/65))
+
 ```js
-// gulpfile.esm.js
+// gulpfile.mjs
 import AssetBundler from "@userfrosting/gulp-bundle-assets";
-import { src, dest } from "gulp";
+import Gulp from "gulp";
 import cleanCss from "gulp-clean-css";
 import concatCss from "gulp-concat-css";
 import uglify from "gulp-uglify";
@@ -53,9 +57,9 @@ export function bundle() {
         }
     };
 
-    return src("src/**")
+    return Gulp.src("src/**")
         .pipe(new AssetBundler(config, joiner))
-        .pipe(dest("public/assets/"));
+        .pipe(Gulp.dest("public/assets/"));
 }
 ```
 

cspell.json

@@ -1,29 +1,32 @@
 {
-    "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/v5.0.1-alpha.3/cspell.schema.json",
     "version": "0.1",
+    "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/v5.0.1-alpha.3/cspell.schema.json",
     "language": "en-US",
     "words": [
-        "narthollis",
-        "Zaleski",
+        "backported",
+        "bytecode",
         "gregorymaertens",
+        "jcarrivick",
+        "jsdevtools",
+        "lockfiles",
         "Mele",
+        "narthollis",
         "Sherland",
         "Soares",
-        "jcarrivick",
-        "bytecode",
-        "backported",
-        "lockfiles"
+        "Zaleski"
     ],
     "ignoreWords": [
-        "userfrosting",
-        "errlop",
-        "preversion",
-        "postversion",
+        "automerged",
         "codecov",
-        "vpath",
-        "gulpplugin",
+        "errlop",
         "gulpfile",
-        "automerged"
+        "gulpjs",
+        "gulpplugin",
+        "lcovonly",
+        "postversion",
+        "preversion",
+        "userfrosting",
+        "vpath"
     ],
     "ignorePaths": [
         "cspell.json",

docs/api-extractor/api-report.md

@@ -4,11 +4,11 @@
 
 ```ts
 
-import { Logger } from 'ts-log';
 import { Readable } from 'stream';
 import { Stream } from 'stream';
 import { Transform } from 'stream';
 import { TransformCallback } from 'stream';
+import TsLog from 'ts-log';
 import Vinyl from 'vinyl';
 
 // @public
@@ -29,8 +29,6 @@ class BundleOrchestrator extends Transform {
     _transform(chunk: any, encoding: BufferEncoding, callback: TransformCallback): Promise<void>;
 }
 
-export { BundleOrchestrator as BundleOrchastrator }
-
 export { BundleOrchestrator }
 
 export default BundleOrchestrator;
@@ -65,7 +63,7 @@ export enum CollisionReactions {
 export interface Config {
     bundle?: Bundles;
     cwd?: string;
-    Logger?: Logger;
+    Logger?: TsLog.Logger;
 }
 
 // @public