Merge pull request #30 from userfrosting/feature/decoupled-file-resolution

Decoupled file resolution

Author: Silic0nS0ldier

.github/FUNDING.yml

@@ -0,0 +1 @@
+open_collective: userfrosting

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
         strategy:
             matrix:
                 platform: [ ubuntu-latest, macos-latest, windows-latest ]
-                node-version: [ 8.x, 10.x, 12.x, 13.x ]
+                node-version: [ 10.x, 12.x, 13.x ]
         runs-on: ${{ matrix.platform }}
         steps:
         - uses: actions/checkout@v1

.npmignore

@@ -6,6 +6,7 @@
 **/*.test.d.ts
 **/*.test.js
 **/*.test.js.map
+**/test-util.js
 api-extractor.json
 dist/index.d.ts
 src/

.vscode/launch.json

@@ -0,0 +1,26 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Debug AVA test file",
+            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/ava",
+            "runtimeArgs": [
+                "debug",
+                "--break",
+                "--serial",
+                "dist/**/${fileBasenameNoExtension}.js"
+            ],
+            "port": 9229,
+            "outputCapture": "std",
+            "skipFiles": [
+                "<node_internals>/**/*.js"
+            ]
+        }
+
+    ]
+}

CHANGELOG.md

@@ -7,11 +7,30 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-Maintenance release.
-- Bumped dependency versions
-- Applied fix for type validation in unit tests
-- Transferred CI onto GitHub Actions from Travis
-- Added API Documentation
+## [4.0.0-alpha.3] - 2020-02-20
+
+Test coverage improvements.
+
+## [4.0.0-alpha.2] - 2020-02-03
+
+### Added
+- Custom cwd support
+
+## [4.0.0-alpha.1] - 2020-01-23
+
+This release focuses on improving performance and maintainability. These have been achieved by separating virtual path logic into a separate package.
+
+### Added
+- API docs.
+
+### Changed
+- Logging interface, now uses [`ts-log`](https://www.npmjs.com/package/ts-log).
+
+### Removed
+- Virtual path logic in favour of [`@userfrosting/vinly-fs-vpath`](https://github.com/userfrosting/vinyl-fs-vpath).
+
+### Fixed
+- Flaw in results API surface, results are now correctly separated according to their type (script/style).
 
 ## [3.0.2] - 2019-07-14
 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 - 2019 David Jordan Myles Mele
+Copyright (c) 2018 - 2020 David Jordan Myles Mele
 
 Copyright (c) 2015 Dow Jones & Company
 

README.md

@@ -5,21 +5,19 @@
 | master | [![Continuous Integration](https://github.com/userfrosting/gulp-uf-bundle-assets/workflows/Continuous%20Integration/badge.svg?branch=master)](https://github.com/userfrosting/gulp-uf-bundle-assets/actions) [![codecov](https://codecov.io/gh/userfrosting/gulp-uf-bundle-assets/branch/master/graph/badge.svg)](https://codecov.io/gh/userfrosting/gulp-uf-bundle-assets/branch/master) |
 | develop | [![Continuous Integration](https://github.com/userfrosting/gulp-uf-bundle-assets/workflows/Continuous%20Integration/badge.svg?branch=develop)](https://github.com/userfrosting/gulp-uf-bundle-assets/actions) [![codecov](https://codecov.io/gh/userfrosting/gulp-uf-bundle-assets/branch/develop/graph/badge.svg)](https://codecov.io/gh/userfrosting/gulp-uf-bundle-assets/branch/develop) |
 
-Orchastrates JS and CSS bundle creation in a highly efficient and configurable manner.
-
-**CAUTION** The implementation currently produces a great deal backpressure. This can result in signficiant RAM usage. Projects dealing with a significant number resources are better off not using this tool until the custom stream source is implemented in v4.
+Orchastrates JS and CSS bundle creation in an efficient and configurable manner.
 
 ## Install
 
 ```bash
-npm install @userfrosting/gulp-bundle-assets --save-dev
+npm i -D  @userfrosting/gulp-bundle-assets
 ```
 
 ## Usage
 
 ```js
 // gulpfile.esm.js
-import assetBundler from "@userfrosting/gulp-bundle-assets";
+import AssetBundler from "@userfrosting/gulp-bundle-assets";
 import { src, dest } from "gulp";
 import cleanCss from "gulp-clean-css";
 import concatCss from "gulp-concat-css";
@@ -57,7 +55,7 @@ export function bundle() {
     };
 
     return src("src/**")
-        .pipe(assetBundler(config, joiner))
+        .pipe(new AssetBundler(config, joiner))
         .pipe(dest("public/assets/"));
 }
 ```
@@ -85,6 +83,8 @@ It has since been entirely reworked to better suit the requirements of the UserF
 
 This package was previously published under `gulp-uf-bundle-assets` and as of v3 is published under `@userfrosting/gulp-bundle-assets` to assist in longterm project management.
 
+As of v4 virtual path logic was extracted into a separate package [@userfrosting/vinyl-fs-vpath](https://github.com/userfrosting/vinyl-fs-vpath). This change enabled a significant simplification of core logic along with a significantly faster and more efficient way to support virtual path mappings.
+
 ## Release process
 
 Generally speaking, all releases should first traverse through `alpha`, `beta`, and `rc` (release candidate) to catch missed bugs and gather feedback as appropriate. Aside from this however, there are a few steps that **MUST** always be done.

api-extractor.json

@@ -10,5 +10,12 @@
     },
     "docModel": {
         "enabled": true
+    },
+    "messages": {
+        "tsdocMessageReporting": {
+            "tsdoc-undefined-tag": {
+                "logLevel": "none"
+            }
+        }
     }
 }

…p-bundle-assets.bundler._constructor_.md …sets.bundleorchastrator._constructor_.mddocs/api/gulp-bundle-assets.bundler._constructor_.md renamed to docs/api/gulp-bundle-assets.bundleorchastrator._constructor_.md docs/api/gulp-bundle-assets.bundler._constructor_.md renamed to docs/api/gulp-bundle-assets.bundleorchastrator._constructor_.md

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [Bundler](./gulp-bundle-assets.bundler.md) &gt; [(constructor)](./gulp-bundle-assets.bundler._constructor_.md)
+[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [BundleOrchastrator](./gulp-bundle-assets.bundleorchastrator.md) &gt; [(constructor)](./gulp-bundle-assets.bundleorchastrator._constructor_.md)
 
-## Bundler.(constructor)
+## BundleOrchastrator.(constructor)
 
-Constructs a new instance of the `Bundler` class
+Constructs a new instance of the `BundleOrchastrator` class
 
 <b>Signature:</b>
 
 ```typescript
-constructor(config: Config, joiner: Bundlers, bundleResultsCallback?: (results: Map<string, Vinyl[]>) => void);
+constructor(config: Config, joiner: Bundlers, resultsCallback?: ResultsCallback);
 ```
 
 ## Parameters
@@ -18,5 +18,5 @@ constructor(config: Config, joiner: Bundlers, bundleResultsCallback?: (results:
 |  --- | --- | --- |
 |  config | <code>Config</code> | Raw (but valid) configuration file used for bundle resolution. |
 |  joiner | <code>Bundlers</code> | Object capable of generating the Transform streams needed for generation of final bundles. |
-|  bundleResultsCallback | <code>(results: Map&lt;string, Vinyl[]&gt;) =&gt; void</code> |  |
+|  resultsCallback | <code>ResultsCallback</code> | Callback invoked once all bundles generated. |
 

…api/gulp-bundle-assets.bundler._flush.md …ndle-assets.bundleorchastrator._flush.mddocs/api/gulp-bundle-assets.bundler._flush.md renamed to docs/api/gulp-bundle-assets.bundleorchastrator._flush.md docs/api/gulp-bundle-assets.bundler._flush.md renamed to docs/api/gulp-bundle-assets.bundleorchastrator._flush.md

@@ -1,10 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [Bundler](./gulp-bundle-assets.bundler.md) &gt; [\_flush](./gulp-bundle-assets.bundler._flush.md)
+[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [BundleOrchastrator](./gulp-bundle-assets.bundleorchastrator.md) &gt; [\_flush](./gulp-bundle-assets.bundleorchastrator._flush.md)
 
-## Bundler.\_flush() method
-
-Does bundling and pushes resulting files into stream.
+## BundleOrchastrator.\_flush() method
 
 <b>Signature:</b>
 
@@ -16,7 +14,7 @@ _flush(callback: TransformCallback): Promise<void>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  callback | <code>TransformCallback</code> | Callback to indicate processing is completed. |
+|  callback | <code>TransformCallback</code> |  |
 
 <b>Returns:</b>