Skip to content

Latest commit

 

History

History
314 lines (201 loc) · 9.53 KB

CHANGELOG.md

File metadata and controls

314 lines (201 loc) · 9.53 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

Changed

  • Raised minimum NodeJS version from 12.17.0 to 18.
  • Default export removed. Use named export BundleOrchestrator.
  • Export MergeRawConfigs renamed to mergeConfigs.
  • Export ValidateRawConfig renamed to validateConfig.
  • Error.cause is now used, some thrown errors may be of a different type or have a simpler message.
  • Return type of BundleStreamFactory changed from Stream to Readable.

[5.0.3] - 2022-03-16

Changed

  • All caught and forwarded errors will now be an instance of Error, if they were not already.
  • Error message emitted when non-Vinyl chunk is encountered has changed to fix a typo.

[5.0.2] - 2021-07-10

Changed

  • Internal dependency into-stream bumped to ^7.0.0.

[5.0.1] - 2021-04-03

Fixed

  • Development aid being invoked by postinstall hook which was never intended to run outside of development workflows.
  • Results callback arguments being potentially modified by later pipeline activities.

Changed

  • Results callback will no longer include a reference to file data.

[5.0.0] - 2021-02-09

Changed

  • Updated interface of BundleOrchestrator._transform reflecting tighter constraints in @types/node v14. No modification to runtime logic, method only used by NodeJS streams.
  • 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.

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.

Changed

  • Name of bundle class, existing symbol name preserved to maintain compatibility.
  • Deprecated export BundleOrchastrator in favour of BundleOrchestrator.

[4.0.0] - 2020-03-14

[4.0.0-rc.1] - 2020-02-22

Added

  • Including bundle type in logging.

[4.0.0-rc.0] - 2020-02-21

[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.

Removed

Fixed

  • Flaw in results API surface, results are now correctly separated according to their type (script/style).

[3.0.2] - 2019-07-14

Added

  • Increased test coverage (back to 100%).

Changed

  • Updated dependencies.
  • Consolidated file tracking type definition into single source of truth.
  • Updated Travis CI config.

[3.0.1] - 2019-06-02

Changed

  • Updated dependencies.

[3.0.0] - 2019-03-12

This release focuses on simplifying the package for UserFrosting 4 to improve maintainability. Features unsupported by UF4 are largely removed.

Added

  • Raw configuration validation.
  • Raw configuration merging with collision logic (ported from UserFrosting gulpfile).
  • Path transformation with support for file replacement based on rule order (later rules supersede earlier ones).
  • Ability to specify base path for resolution of bundle resources and path transformations.
  • Support for comprehensive logging through a passed logger function.

Changed

  • Functionality offered by results file has been replaced by ResultsMap property.
  • Reads stream chunks (Vinyl instances) instead of directly from file system.
  • As an internal gulp pipeline is no longer responsible for bundle generation, custom Transform streams (e.g. gulp-concat-css) must be provided.
  • 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.
  • Bundle results are now retrieved via a callback which is given a collection of Vinyl NullFiles to retain as much useful information as possible.
  • Moved package under @userfrosting organization in NPM and removed superfluous uf from package name.

Removed

  • Support for CSS sourcemaps (broken since 2.27.2).
  • Specification of pre-minified files (minSrc).
  • CoffeeScript, and LESS compilation (functionality can be implemented manually through provided Bundlers).
  • Glob paths.
  • Environment based build conditions (functionality can be implemented manually through provided Bundlers).
  • Incremental/watched builds.
  • Automatic HTML tag generation for results file (use results callback to implement this manually).
  • File copy support (use gulp.dest or an equivalent).
  • Result file support (replaced by callback).
  • Removed dependency on gulp as per best practices.

[2.28.2] - 2018-02-10

Changed

  • Removed some missed references to gulp-util.

[2.28.1] - 2018-02-09

Changed

  • Migrated from deprecated dependency gulp-util.

[2.28.0] - 2017-11-17

Added

  • Merged upstream 2.28.0 release.

Changed

  • Unlocked dependencies to allow backwards compatible feature updates. (^ vs. ~).

[2.27.2] - 2017-02-16

Changed

  • Using gulp-concat-css for CSS bundles.

Project Forked: Forked at 2.27.0, 2.28.0 release was backported.

2.28.0 - 2017-04-15 (backported)

Added

[2.27.1] - 2016-05-24

Changes unknown

[2.27.0] 2016-05-23

Added

[2.26.0] - 2016-05-06

Changed

  • Updated many deps including: gulp-less 3.1.0, gulp-coffee 2.3.2 and gulp-if 2.0.1.

[2.25.0] - 2016-05-06

Changed

  • Update to use gulp-clean-css 2.0.7 instead of deprecated gulp-minify-css module.

[2.24.0] - 2016-03-17

Changed

  • Updated to gulp-less 3.0.5 and gulp-uglify 1.5.3.

[v.23.0] - 2015-09-16

Added

[2.22.0] - 2015-07-17

Added

  • Config option for consistent file content ordering #25.

[2.21.0] - 2015-06-11

Changed

  • Updated all deps, including: gulp-rev 4.0.0, gulp-less 3.0.3, gulp-sourcemaps 1.5.2.

[2.20.0] - 2015-05-07

Added

  • pluginOptions config option #50.

[2.19.2] - 2015-05-07

Changed

  • Update to gulp-minify-css 1.1.1 (@ZaleskiR).

[2.19.1] - 2015-04-24

Fixed

[2.19.0] - 2015-03-01

Fixed

  • Error handling for bundle.watch #47.

[2.18.0] - 2015-02-08

Added

[2.17.5] - 2015-02-04

Changed

  • Updated examples.

[2.17.4] - 2015-02-04

Added

  • Logging for errors from custom transforms #41.

[2.17.3] - 2015-02-03

Changed

  • Updated examples.

[2.17.2] - 2015-02-03

Added

  • Logging of bundle config parse errors.

[2.17.1] - 2014-12-05

Fixed

  • Custom result file name during bundle.watch (@roberto).

[2.17.0] - 2014-12-05

Added

[2.16.1] - 2014-12-04

Fixed

  • Unit tests.

[2.16.0] - 2014-12-01

Changed

  • Updated deps, including: gulp-rev 2.0.1, gulp-sourcemaps 1.2.8, gulp-uglify 1.0.1.

[2.15.2] - 2014-10-21

Added

  • Support for both minCSS and minCss #34

[2.15.1] - 2014-10-10

Added

  • Example using 6to5 (aka babel).

[2.15.0] - 2014-09-29

Added

  • bundle.watch for copy files #33.

[2.14.0] - 2014-09-29

Added

  • Flag to disable logging #16.

[2.13.1] - 2014-09-25

Fixed

  • Issue where when bundleAllEnvironments: true, srcMin is always true #32.

[2.13.0] - 2014-09-23

Added

  • Allow different watch vs bundle targets #30.

[2.12.1] - 2014-09-23

Fixed

  • Only publish results during watch when opts defined.

[2.12.0] - 2014-09-23

Added

  • bundle.watch for bundles #26.