Skip to content

Commit 6e55e6e

Browse files
Silic0nS0ldierSilic0nS0ldier
authored
Merge pull request #37 from userfrosting/develop
Gap in error logging, spelling fixes
2 parents 2dbfdce + 721fe0d commit 6e55e6e

19 files changed

Lines changed: 204 additions & 71 deletions

‎.github/workflows/ci.yml‎

Lines changed: 84 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,84 @@
1-
name: Continuous Integration
2-
on:
3-
# Every push
4-
push:
5-
schedule:
6-
# Every Monday and Thursday at 12PM UTC
7-
- cron: '0 12 * * 1,4'
8-
9-
jobs:
10-
test:
11-
strategy:
12-
matrix:
13-
os: [ ubuntu-latest, macos-latest, windows-latest ]
14-
node-version: [ 10.x, 12.x, 13.x ]
15-
runs-on: ${{ matrix.os }}
16-
steps:
17-
- uses: actions/checkout@v1
18-
- uses: actions/setup-node@v1
19-
with:
20-
node-version: ${{ matrix.node-version }}
21-
- run: npm ci
22-
- run: ./node_modules/.bin/nyc --reporter=lcovonly npm test
23-
- uses: codecov/codecov-action@v1
24-
with:
25-
token: ${{ secrets.CODECOV_UPLOAD_TOKEN }}
1+
{
2+
"name": "Continuous Integration",
3+
"on": {
4+
# Every push
5+
"push": {},
6+
"schedule": [
7+
{
8+
# Every Monday and Thursday at 12PM UTC
9+
"cron": "0 12 * * 1,4"
10+
}
11+
]
12+
},
13+
"jobs": {
14+
"test": {
15+
"strategy": {
16+
"matrix": {
17+
"os": [
18+
"ubuntu-latest",
19+
"macos-latest",
20+
"windows-latest"
21+
],
22+
"node-version": [
23+
"10.x",
24+
"12.x",
25+
"13.x"
26+
]
27+
}
28+
},
29+
"runs-on": "${{ matrix.os }}",
30+
"steps": [
31+
{
32+
"name": "Checkout",
33+
"uses": "actions/checkout@v1"
34+
},
35+
{
36+
"name": "Setup node",
37+
"uses": "actions/setup-node@v1",
38+
"with": {
39+
"node-version": "${{ matrix.node-version }}"
40+
}
41+
},
42+
{
43+
"name": "Install dependencies",
44+
"run": "npm ci"
45+
},
46+
{
47+
"name": "Run tests",
48+
"run": "./node_modules/.bin/nyc --reporter=lcovonly npm test"
49+
},
50+
{
51+
"name": "Push coverage to Codecov",
52+
"uses": "codecov/codecov-action@v1",
53+
"with": {
54+
"token": "${{ secrets.CODECOV_UPLOAD_TOKEN }}"
55+
}
56+
}
57+
]
58+
},
59+
"release-readiness": {
60+
"runs-on": "ubuntu-latest",
61+
"steps": [
62+
{
63+
"name": "Checkout",
64+
"uses": "actions/checkout@v1"
65+
},
66+
{
67+
"name": "Setup node",
68+
"uses": "actions/setup-node@v1",
69+
"with": {
70+
"node-version": "13.x"
71+
}
72+
},
73+
{
74+
"name": "Install cspell",
75+
"run": "npm i -g cspell"
76+
},
77+
{
78+
"name": "Check spelling",
79+
"run": "cspell '**'"
80+
}
81+
]
82+
}
83+
}
84+
}

‎CHANGELOG.md‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
77

88
## [Unreleased]
99

10+
[//]: # (spell-checker:disable)
11+
12+
### Fixed
13+
- Missing bundles and files not being logged when stream completes without providing all required files.
14+
15+
### Changed
16+
- Name of bundle class, existing symbol name preserved to maintain compatibility.
17+
- Deprecated export `BundleOrchastrator` in favour of `BundleOrchestrator`.
18+
19+
[//]: # (spell-checker:enable)
20+
1021
## [4.0.0] - 2020-03-14
1122

1223
## [4.0.0-rc.1] - 2020-02-22
@@ -36,7 +47,7 @@ This release focuses on improving performance and maintainability. These have be
3647
- Logging interface, now uses [`ts-log`](https://www.npmjs.com/package/ts-log).
3748

3849
### Removed
39-
- Virtual path logic in favour of [`@userfrosting/vinly-fs-vpath`](https://github.com/userfrosting/vinyl-fs-vpath).
50+
- Virtual path logic in favour of [`@userfrosting/vinyl-fs-vpath`](https://github.com/userfrosting/vinyl-fs-vpath).
4051

4152
### Fixed
4253
- Flaw in results API surface, results are now correctly separated according to their type (script/style).
@@ -63,7 +74,7 @@ This release focuses on simplifying the package for UserFrosting 4 to improve ma
6374
### Added
6475
- Raw configuration validation.
6576
- Raw configuration merging with collision logic (ported from UserFrosting `gulpfile`).
66-
- Path transformation with support for file replacement based on rule order (later rules superseed earlier ones).
77+
- Path transformation with support for file replacement based on rule order (later rules supersede earlier ones).
6778
- Ability to specify base path for resolution of bundle resources and path transformations.
6879
- Support for comprehensive logging through a passed logger function.
6980

@@ -73,7 +84,7 @@ This release focuses on simplifying the package for UserFrosting 4 to improve ma
7384
- As an internal `gulp` pipeline is no longer responsible for bundle generation, custom `Transform` streams (e.g. `gulp-concat-css`) must be provided.
7485
- 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.
7586
- Bundle results are now retrieved via a callback which is given a collection of `Vinyl` `NullFiles` to retain as much useful information as possible.
76-
- Moved package under `@userfrosting` organisation in NPM and removed superfluous `uf` from package name.
87+
- Moved package under `@userfrosting` organization in NPM and removed superfluous `uf` from package name.
7788

7889
### Removed
7990
- Support for CSS sourcemaps (broken since 2.27.2).
@@ -85,7 +96,7 @@ This release focuses on simplifying the package for UserFrosting 4 to improve ma
8596
- Automatic HTML tag generation for results file (use results callback to implement this manually).
8697
- File copy support (use `gulp.dest` or an equivalent).
8798
- Result file support (replaced by callback).
88-
- Removed dependency on `gulp` as per best practises.
99+
- Removed dependency on `gulp` as per best practices.
89100

90101
## [2.28.2] - 2018-02-10
91102

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
| 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?query=branch:master+workflow:"Continuous+Integration") [![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) |
66
| 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?query=branch:develop+workflow:"Continuous+Integration") [![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) |
77

8-
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.
99

1010
## Install
1111

@@ -68,7 +68,7 @@ $ gulp bundle
6868

6969
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.
7070

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).
7272

7373
## API
7474

@@ -79,9 +79,9 @@ The results reside in [docs/api](./docs/api/index.md).
7979

8080
This plugin was originally forked from [gulp-bundle-assets](https://github.com/dowjones/gulp-bundle-assets) to fix a CSS import bug.
8181

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

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

8686
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.
8787

‎cspell.json‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/v5.0.1-alpha.3/cspell.schema.json",
3+
"version": "0.1",
4+
"language": "en-US",
5+
"words": [
6+
"narthollis",
7+
"Zaleski",
8+
"gregorymaertens",
9+
"Mele",
10+
"Sherland",
11+
"Soares",
12+
"jcarrivick",
13+
"bytecode",
14+
"backported"
15+
],
16+
"ignoreWords": [
17+
"userfrosting",
18+
"errlop",
19+
"preversion",
20+
"postversion",
21+
"codecov",
22+
"vpath",
23+
"gulpplugin",
24+
"gulpfile"
25+
],
26+
"ignorePaths": [
27+
"cspell.json",
28+
"package-lock.json",
29+
"api-extractor.json",
30+
"docs/api/",
31+
"dist/",
32+
"temp/"
33+
]
34+
}

docs/api/gulp-bundle-assets.bundleorchastrator._constructor_.md renamed to docs/api/gulp-bundle-assets.bundleorchestrator._constructor_.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[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)
3+
[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [BundleOrchestrator](./gulp-bundle-assets.bundleorchestrator.md) &gt; [(constructor)](./gulp-bundle-assets.bundleorchestrator._constructor_.md)
44

5-
## BundleOrchastrator.(constructor)
5+
## BundleOrchestrator.(constructor)
66

7-
Constructs a new instance of the `BundleOrchastrator` class
7+
Constructs a new instance of the `BundleOrchestrator` class
88

99
<b>Signature:</b>
1010

docs/api/gulp-bundle-assets.bundleorchastrator._flush.md renamed to docs/api/gulp-bundle-assets.bundleorchestrator._flush.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[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)
3+
[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [BundleOrchestrator](./gulp-bundle-assets.bundleorchestrator.md) &gt; [\_flush](./gulp-bundle-assets.bundleorchestrator._flush.md)
44

5-
## BundleOrchastrator.\_flush() method
5+
## BundleOrchestrator.\_flush() method
66

77
<b>Signature:</b>
88

docs/api/gulp-bundle-assets.bundleorchastrator._transform.md renamed to docs/api/gulp-bundle-assets.bundleorchestrator._transform.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [BundleOrchastrator](./gulp-bundle-assets.bundleorchastrator.md) &gt; [\_transform](./gulp-bundle-assets.bundleorchastrator._transform.md)
3+
[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [BundleOrchestrator](./gulp-bundle-assets.bundleorchestrator.md) &gt; [\_transform](./gulp-bundle-assets.bundleorchestrator._transform.md)
44

5-
## BundleOrchastrator.\_transform() method
5+
## BundleOrchestrator.\_transform() method
66

77
Collects copies of applicable files to later bundle.
88

docs/api/gulp-bundle-assets.bundleorchastrator.md renamed to docs/api/gulp-bundle-assets.bundleorchestrator.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [BundleOrchastrator](./gulp-bundle-assets.bundleorchastrator.md)
3+
[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [BundleOrchestrator](./gulp-bundle-assets.bundleorchestrator.md)
44

5-
## BundleOrchastrator class
5+
## BundleOrchestrator class
66

7-
Orchastrates bundling.
7+
Orchestrates bundling.
88

99
<b>Signature:</b>
1010

1111
```typescript
12-
export declare class BundleOrchastrator extends Transform
12+
export declare class BundleOrchestrator extends Transform
1313
```
1414
1515
## Constructors
1616
1717
| Constructor | Modifiers | Description |
1818
| --- | --- | --- |
19-
| [(constructor)(config, joiner, resultsCallback)](./gulp-bundle-assets.bundleorchastrator._constructor_.md) | | Constructs a new instance of the <code>BundleOrchastrator</code> class |
19+
| [(constructor)(config, joiner, resultsCallback)](./gulp-bundle-assets.bundleorchestrator._constructor_.md) | | Constructs a new instance of the <code>BundleOrchestrator</code> class |
2020
2121
## Methods
2222
2323
| Method | Modifiers | Description |
2424
| --- | --- | --- |
25-
| [\_flush(callback)](./gulp-bundle-assets.bundleorchastrator._flush.md) | | |
26-
| [\_transform(chunk, encoding, callback)](./gulp-bundle-assets.bundleorchastrator._transform.md) | | Collects copies of applicable files to later bundle. |
25+
| [\_flush(callback)](./gulp-bundle-assets.bundleorchestrator._flush.md) | | |
26+
| [\_transform(chunk, encoding, callback)](./gulp-bundle-assets.bundleorchestrator._transform.md) | | Collects copies of applicable files to later bundle. |
2727

‎docs/api/gulp-bundle-assets.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
| Class | Description |
1010
| --- | --- |
11-
| [BundleOrchastrator](./gulp-bundle-assets.bundleorchastrator.md) | Orchastrates bundling. |
11+
| [BundleOrchestrator](./gulp-bundle-assets.bundleorchestrator.md) | Orchestrates bundling. |
1212

1313
## Enumerations
1414

‎package.json‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@userfrosting/gulp-bundle-assets",
33
"version": "4.0.0",
4-
"description": "Orchastrates JS and CSS bundle creation in an efficient and configurable manner.",
4+
"description": "Orchestrates JS and CSS bundle creation in an efficient and configurable manner.",
55
"funding": "https://opencollective.com/userfrosting",
66
"type": "commonjs",
77
"main": "./dist/index.js",
@@ -72,7 +72,6 @@
7272
"engines": {
7373
"node": ">=10.0.0"
7474
},
75-
"engineStrict": true,
7675
"ava": {
7776
"files": [
7877
"dist/**/*.test.js"

0 commit comments

Comments
 (0)