From ed514b59593c48af4efc3c6354d4b987bf9427b2 Mon Sep 17 00:00:00 2001 From: Jordan Mele Date: Wed, 10 Feb 2021 09:08:10 +1100 Subject: [PATCH] 5.0.0 --- CHANGELOG.md | 2 ++ docs/api/gulp-bundle-assets.bundle.md | 6 +++--- ...p-bundle-assets.bundleorchestrator._constructor_.md | 6 +++--- .../gulp-bundle-assets.bundleorchestrator._flush.md | 4 ++-- ...gulp-bundle-assets.bundleorchestrator._transform.md | 10 +++++----- docs/api/gulp-bundle-assets.bundleorchestrator.md | 1 + docs/api/gulp-bundle-assets.bundlers.md | 4 ++-- docs/api/gulp-bundle-assets.config.logger.md | 2 +- docs/api/gulp-bundle-assets.config.md | 6 +++--- docs/api/gulp-bundle-assets.mergerawconfigs.md | 6 +++--- docs/api/gulp-bundle-assets.options.md | 2 +- docs/api/gulp-bundle-assets.results.md | 4 ++-- docs/api/gulp-bundle-assets.sprinkleoptions.md | 2 +- docs/api/gulp-bundle-assets.validaterawconfig.md | 6 +++--- package-lock.json | 2 +- package.json | 2 +- 16 files changed, 34 insertions(+), 31 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cd223dc3..c3e855f9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +## [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. diff --git a/docs/api/gulp-bundle-assets.bundle.md b/docs/api/gulp-bundle-assets.bundle.md index 3ad42151..0dac1311 100644 --- a/docs/api/gulp-bundle-assets.bundle.md +++ b/docs/api/gulp-bundle-assets.bundle.md @@ -16,7 +16,7 @@ export interface Bundle | Property | Type | Description | | --- | --- | --- | -| [options](./gulp-bundle-assets.bundle.options.md) | Options | | -| [scripts](./gulp-bundle-assets.bundle.scripts.md) | string[] | | -| [styles](./gulp-bundle-assets.bundle.styles.md) | string[] | | +| [options?](./gulp-bundle-assets.bundle.options.md) | [Options](./gulp-bundle-assets.options.md) | (Optional) | +| [scripts?](./gulp-bundle-assets.bundle.scripts.md) | string\[\] | (Optional) | +| [styles?](./gulp-bundle-assets.bundle.styles.md) | string\[\] | (Optional) | diff --git a/docs/api/gulp-bundle-assets.bundleorchestrator._constructor_.md b/docs/api/gulp-bundle-assets.bundleorchestrator._constructor_.md index e67366d0..04ecd520 100644 --- a/docs/api/gulp-bundle-assets.bundleorchestrator._constructor_.md +++ b/docs/api/gulp-bundle-assets.bundleorchestrator._constructor_.md @@ -16,7 +16,7 @@ constructor(config: Config, joiner: Bundlers, resultsCallback?: ResultsCallback) | Parameter | Type | Description | | --- | --- | --- | -| config | Config | Raw (but valid) configuration file used for bundle resolution. | -| joiner | Bundlers | Object capable of generating the Transform streams needed for generation of final bundles. | -| resultsCallback | ResultsCallback | Callback invoked once all bundles generated. | +| config | [Config](./gulp-bundle-assets.config.md) | Raw (but valid) configuration file used for bundle resolution. | +| joiner | [Bundlers](./gulp-bundle-assets.bundlers.md) | Object capable of generating the Transform streams needed for generation of final bundles. | +| resultsCallback | [ResultsCallback](./gulp-bundle-assets.resultscallback.md) | Callback invoked once all bundles generated. | diff --git a/docs/api/gulp-bundle-assets.bundleorchestrator._flush.md b/docs/api/gulp-bundle-assets.bundleorchestrator._flush.md index 604c9f8a..db3d933d 100644 --- a/docs/api/gulp-bundle-assets.bundleorchestrator._flush.md +++ b/docs/api/gulp-bundle-assets.bundleorchestrator._flush.md @@ -14,9 +14,9 @@ _flush(callback: TransformCallback): Promise; | Parameter | Type | Description | | --- | --- | --- | -| callback | TransformCallback | | +| callback | TransformCallback | | Returns: -`Promise` +Promise<void> diff --git a/docs/api/gulp-bundle-assets.bundleorchestrator._transform.md b/docs/api/gulp-bundle-assets.bundleorchestrator._transform.md index 80b33e3e..8f382fd7 100644 --- a/docs/api/gulp-bundle-assets.bundleorchestrator._transform.md +++ b/docs/api/gulp-bundle-assets.bundleorchestrator._transform.md @@ -9,18 +9,18 @@ Collects copies of applicable files to later bundle. Signature: ```typescript -_transform(chunk: any, encoding: string, callback: TransformCallback): Promise; +_transform(chunk: any, encoding: BufferEncoding, callback: TransformCallback): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| chunk | any | Stream chunk, may be a Vinyl object. | -| encoding | string | Encoding of chunk, if applicable. | -| callback | TransformCallback | Callback to indicate processing is completed. | +| chunk | any | Stream chunk, may be a Vinyl object. | +| encoding | BufferEncoding | Encoding of chunk, if applicable. | +| callback | TransformCallback | Callback to indicate processing is completed. | Returns: -`Promise` +Promise<void> diff --git a/docs/api/gulp-bundle-assets.bundleorchestrator.md b/docs/api/gulp-bundle-assets.bundleorchestrator.md index 054dc98f..07208d85 100644 --- a/docs/api/gulp-bundle-assets.bundleorchestrator.md +++ b/docs/api/gulp-bundle-assets.bundleorchestrator.md @@ -11,6 +11,7 @@ Orchestrates bundling. ```typescript export declare class BundleOrchestrator extends Transform ``` +Extends: Transform ## Constructors diff --git a/docs/api/gulp-bundle-assets.bundlers.md b/docs/api/gulp-bundle-assets.bundlers.md index 634d440a..9f756f06 100644 --- a/docs/api/gulp-bundle-assets.bundlers.md +++ b/docs/api/gulp-bundle-assets.bundlers.md @@ -16,6 +16,6 @@ export interface Bundlers | Property | Type | Description | | --- | --- | --- | -| [Scripts](./gulp-bundle-assets.bundlers.scripts.md) | BundleStreamFactory | Returns a Transform that will handle bundling of script resources. | -| [Styles](./gulp-bundle-assets.bundlers.styles.md) | BundleStreamFactory | Returns a Transform that will handle bundling of style resources. | +| [Scripts](./gulp-bundle-assets.bundlers.scripts.md) | [BundleStreamFactory](./gulp-bundle-assets.bundlestreamfactory.md) | Returns a Transform that will handle bundling of script resources. | +| [Styles](./gulp-bundle-assets.bundlers.styles.md) | [BundleStreamFactory](./gulp-bundle-assets.bundlestreamfactory.md) | Returns a Transform that will handle bundling of style resources. | diff --git a/docs/api/gulp-bundle-assets.config.logger.md b/docs/api/gulp-bundle-assets.config.logger.md index 4258441f..eab2730f 100644 --- a/docs/api/gulp-bundle-assets.config.logger.md +++ b/docs/api/gulp-bundle-assets.config.logger.md @@ -9,5 +9,5 @@ Optional logger that will be used throughout bundling process. Signature: ```typescript -Logger?: Logger; +Logger?: TsLog.Logger; ``` diff --git a/docs/api/gulp-bundle-assets.config.md b/docs/api/gulp-bundle-assets.config.md index 0888e72a..2eedaea5 100644 --- a/docs/api/gulp-bundle-assets.config.md +++ b/docs/api/gulp-bundle-assets.config.md @@ -16,7 +16,7 @@ export interface Config | Property | Type | Description | | --- | --- | --- | -| [bundle](./gulp-bundle-assets.config.bundle.md) | Bundles | Bundle definitions. | -| [cwd](./gulp-bundle-assets.config.cwd.md) | string | Current working directory to use when resolving the full paths of bundle dependencies. Defaults to process.cwd(). | -| [Logger](./gulp-bundle-assets.config.logger.md) | Logger | Optional logger that will be used throughout bundling process. | +| [bundle?](./gulp-bundle-assets.config.bundle.md) | [Bundles](./gulp-bundle-assets.bundles.md) | (Optional) Bundle definitions. | +| [cwd?](./gulp-bundle-assets.config.cwd.md) | string | (Optional) Current working directory to use when resolving the full paths of bundle dependencies. Defaults to process.cwd(). | +| [Logger?](./gulp-bundle-assets.config.logger.md) | TsLog.Logger | (Optional) Optional logger that will be used throughout bundling process. | diff --git a/docs/api/gulp-bundle-assets.mergerawconfigs.md b/docs/api/gulp-bundle-assets.mergerawconfigs.md index af254827..cfafd436 100644 --- a/docs/api/gulp-bundle-assets.mergerawconfigs.md +++ b/docs/api/gulp-bundle-assets.mergerawconfigs.md @@ -11,16 +11,16 @@ Merges a collection of configurations. No validation is conducted, it is expecte Signature: ```typescript -export default function MergeConfigs(rawConfigs: Config[]): Config; +export declare function MergeConfigs(rawConfigs: Config[]): Config; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| rawConfigs | Config[] | Raw (untransformed) configurations to merge. | +| rawConfigs | [Config](./gulp-bundle-assets.config.md)\[\] | Raw (untransformed) configurations to merge. | Returns: -`Config` +[Config](./gulp-bundle-assets.config.md) diff --git a/docs/api/gulp-bundle-assets.options.md b/docs/api/gulp-bundle-assets.options.md index 345c4731..6e1110b2 100644 --- a/docs/api/gulp-bundle-assets.options.md +++ b/docs/api/gulp-bundle-assets.options.md @@ -16,5 +16,5 @@ export interface Options | Property | Type | Description | | --- | --- | --- | -| [sprinkle](./gulp-bundle-assets.options.sprinkle.md) | SprinkleOptions | | +| [sprinkle?](./gulp-bundle-assets.options.sprinkle.md) | [SprinkleOptions](./gulp-bundle-assets.sprinkleoptions.md) | (Optional) | diff --git a/docs/api/gulp-bundle-assets.results.md b/docs/api/gulp-bundle-assets.results.md index 9cc29477..01d9c61d 100644 --- a/docs/api/gulp-bundle-assets.results.md +++ b/docs/api/gulp-bundle-assets.results.md @@ -16,6 +16,6 @@ export interface Results | Property | Type | Description | | --- | --- | --- | -| [scripts](./gulp-bundle-assets.results.scripts.md) | Map<string, Vinyl[]> | | -| [styles](./gulp-bundle-assets.results.styles.md) | Map<string, Vinyl[]> | | +| [scripts](./gulp-bundle-assets.results.scripts.md) | Map<string, Vinyl\[\]> | | +| [styles](./gulp-bundle-assets.results.styles.md) | Map<string, Vinyl\[\]> | | diff --git a/docs/api/gulp-bundle-assets.sprinkleoptions.md b/docs/api/gulp-bundle-assets.sprinkleoptions.md index 8e57f691..dd315d92 100644 --- a/docs/api/gulp-bundle-assets.sprinkleoptions.md +++ b/docs/api/gulp-bundle-assets.sprinkleoptions.md @@ -16,5 +16,5 @@ export interface SprinkleOptions | Property | Type | Description | | --- | --- | --- | -| [onCollision](./gulp-bundle-assets.sprinkleoptions.oncollision.md) | keyof typeof CollisionReactions | How a bundle collision should be handled when bundles are being merged. | +| [onCollision?](./gulp-bundle-assets.sprinkleoptions.oncollision.md) | keyof typeof [CollisionReactions](./gulp-bundle-assets.collisionreactions.md) | (Optional) How a bundle collision should be handled when bundles are being merged. | diff --git a/docs/api/gulp-bundle-assets.validaterawconfig.md b/docs/api/gulp-bundle-assets.validaterawconfig.md index 8b8e9d57..c98c1628 100644 --- a/docs/api/gulp-bundle-assets.validaterawconfig.md +++ b/docs/api/gulp-bundle-assets.validaterawconfig.md @@ -9,16 +9,16 @@ Throws an exception if the provided raw config contains invalid data. Signature: ```typescript -export default function ValidateConfig(config: Config): void; +export declare function ValidateConfig(config: Config): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| config | Config | Raw configuration to validate. | +| config | [Config](./gulp-bundle-assets.config.md) | Raw configuration to validate. | Returns: -`void` +void diff --git a/package-lock.json b/package-lock.json index 65e066d5..c1f8aed9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@userfrosting/gulp-bundle-assets", - "version": "4.0.1", + "version": "5.0.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 51fd56f7..907da6e3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@userfrosting/gulp-bundle-assets", - "version": "4.0.1", + "version": "5.0.0", "description": "Orchestrates JS and CSS bundle creation in an efficient and configurable manner.", "funding": "https://opencollective.com/userfrosting", "type": "module",