You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,10 +7,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
7
7
8
8
## [Unreleased]
9
9
10
+
[//]: #(spell-checker:disable)
11
+
10
12
### Changed
11
13
- Name of bundle class, existing symbol name preserved to maintain compatibility.
12
14
- Deprecated export `BundleOrchastrator` in favour of `BundleOrchestrator`
13
15
16
+
[//]: #(spell-checker:enable)
17
+
14
18
## [4.0.0] - 2020-03-14
15
19
16
20
## [4.0.0-rc.1] - 2020-02-22
@@ -40,7 +44,7 @@ This release focuses on improving performance and maintainability. These have be
40
44
- Logging interface, now uses [`ts-log`](https://www.npmjs.com/package/ts-log).
41
45
42
46
### Removed
43
-
- Virtual path logic in favour of [`@userfrosting/vinly-fs-vpath`](https://github.com/userfrosting/vinyl-fs-vpath).
47
+
- Virtual path logic in favour of [`@userfrosting/vinyl-fs-vpath`](https://github.com/userfrosting/vinyl-fs-vpath).
44
48
45
49
### Fixed
46
50
- Flaw in results API surface, results are now correctly separated according to their type (script/style).
@@ -67,7 +71,7 @@ This release focuses on simplifying the package for UserFrosting 4 to improve ma
67
71
### Added
68
72
- Raw configuration validation.
69
73
- Raw configuration merging with collision logic (ported from UserFrosting `gulpfile`).
70
-
- Path transformation with support for file replacement based on rule order (later rules superseed earlier ones).
74
+
- Path transformation with support for file replacement based on rule order (later rules supersede earlier ones).
71
75
- Ability to specify base path for resolution of bundle resources and path transformations.
72
76
- Support for comprehensive logging through a passed logger function.
73
77
@@ -77,7 +81,7 @@ This release focuses on simplifying the package for UserFrosting 4 to improve ma
77
81
- As an internal `gulp` pipeline is no longer responsible for bundle generation, custom `Transform` streams (e.g. `gulp-concat-css`) must be provided.
78
82
- Path transformations will no longer be applied to files due to complexity around how paths are managed in `gulp`. Instead this feature will be used for override logic alone.
79
83
- Bundle results are now retrieved via a callback which is given a collection of `Vinyl``NullFiles` to retain as much useful information as possible.
80
-
- Moved package under `@userfrosting`organisation in NPM and removed superfluous `uf` from package name.
84
+
- Moved package under `@userfrosting`organization in NPM and removed superfluous `uf` from package name.
81
85
82
86
### Removed
83
87
- Support for CSS sourcemaps (broken since 2.27.2).
@@ -89,7 +93,7 @@ This release focuses on simplifying the package for UserFrosting 4 to improve ma
89
93
- Automatic HTML tag generation for results file (use results callback to implement this manually).
90
94
- File copy support (use `gulp.dest` or an equivalent).
91
95
- Result file support (replaced by callback).
92
-
- Removed dependency on `gulp` as per best practises.
96
+
- Removed dependency on `gulp` as per best practices.
Orchastrates JS and CSS bundle creation in an efficient and configurable manner.
8
+
Orchestrates JS and CSS bundle creation in an efficient and configurable manner.
9
9
10
10
## Install
11
11
@@ -68,7 +68,7 @@ $ gulp bundle
68
68
69
69
The `Bundler` class exposes a `ResultsMap` property containing a Map where the key is the bundle name and value the full path of the generated file. If any transform stream after `Bundler` that changes path names then the results map will no longer be accurate, so use the built in path transforms if possible.
70
70
71
-
This approach was decided on as it provides the most efficient means to integrate bundles with any system. No need to touch the file system until its absolutely necessary, and less work to optimise the output (e.g. make a `php` file out of it to reduce IO in production by maximising use of bytecode caching).
71
+
This approach was decided on as it provides the most efficient means to integrate bundles with any system. No need to touch the file system until its absolutely necessary, and less work to optimise the output (e.g. make a `php` file out of it to reduce IO in production by maximizing use of bytecode caching).
72
72
73
73
## API
74
74
@@ -79,9 +79,9 @@ The results reside in [docs/api](./docs/api/index.md).
79
79
80
80
This plugin was originally forked from [gulp-bundle-assets](https://github.com/dowjones/gulp-bundle-assets) to fix a CSS import bug.
81
81
82
-
It has since been entirely reworked to better suit the requirements of the UserFrosting's Sprinkle system and follow the Gulp plugin guidelines (namely not unncessarily depending on it). Though TypeScript is now the preferred language the output targetted to ES2015 and uses ES Modules (via the `esm` package) to ensure source it can be easily debugged if issues are observed in the wild.
82
+
It has since been entirely reworked to better suit the requirements of the UserFrosting's Sprinkle system and follow the Gulp plugin guidelines (namely not unnecessarily depending on it). Though TypeScript is now the preferred language the output targeted to ES2015 and uses ES Modules (via the `esm` package) to ensure source it can be easily debugged if issues are observed in the wild.
83
83
84
-
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.
84
+
This package was previously published under `gulp-uf-bundle-assets` and as of v3 is published under `@userfrosting/gulp-bundle-assets` to assist in long-term project management.
85
85
86
86
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.
0 commit comments