https://github.com/welldone-software/gulp-file-bundle
Creates a simple bundle file that reference other css/js resources
https://github.com/welldone-software/gulp-file-bundle
Last synced: about 1 month ago
JSON representation
Creates a simple bundle file that reference other css/js resources
- Host: GitHub
- URL: https://github.com/welldone-software/gulp-file-bundle
- Owner: welldone-software
- License: mit
- Created: 2015-09-29T07:15:47.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-10-27T17:10:24.000Z (over 10 years ago)
- Last Synced: 2025-11-23T23:29:42.265Z (7 months ago)
- Language: JavaScript
- Size: 145 KB
- Stars: 0
- Watchers: 16
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-file-bundle
> A [Gulp](http://gulpjs.com/) plugin for bundling js and css resources as an external reference.
## Overview
The plugin is minimalistic and simple. It generates the bundle file on the fly and adds it to the stream of files passing through it.
For example, the following folder structure:
```
+ src
- file1.js
+ fldr
- file1.js
- file2.js
```
And gulp task:
```js
gulp.task('bundle.js', function() {
return gulp.src('src/**/*.js')
.pipe(bundle('bundle.js', {
type: 'js', //can be ommited, it is the default
base: 'src'
}))
.pipe(gulp.dest('dst'));
});
```
Results in a directory like so:
```
+ dst
- bundle.js
- file1.js
+ fldr
- file1.js
- file2.js
```
And a bundle.js content like so:
```js
document.write('');
document.write('');
document.write('');
```
A css bundling task is similar and looks like this:
```js
gulp.task('bundle.css', function() {
return gulp.src('src/**/*.css')
.pipe(bundle('bundle.css', {
type: 'css',
base: 'src'
}))
.pipe(gulp.dest('dst'));
});
```
The content of the bundle.css is the following:
```css
@import url(file1.css);
@import url(fldr/file1.css);
@import url(fldr/file2.css);
```
## Parameters
`bundle(bundleName, options)`
### bundleName
Type: `String`
The name of the bundle file.
This file is added to the stream of files passing through the plugin. It is a gulp only file, and must be saved using `gulp.dest` or a similar facility to be available in the file system.
### options
#### options.emitInputFiles
Type: `Boolean`
Default value: `true`
By default, the plugin emits all input files before it emits the bundle file, so it add one file to the stream of files. Setting this option to `false`, will cause the plugin to filter out all input files and only emit the bundle file.
#### options.type
Type: `String`
Default value: `'js'`
Either 'js' or 'css'. Determine the type of the bundle file i.e wether it uses `` or `<link rel="">` tag to reference the external files.
#### options.base
Type: `String`
The base to use for the bundle file and the input file. Determines the relative path used for the href and src attributes.
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Gulp](http://gulpjs.com/).
## Release History
- 1.0.0 - Basic features.
- 1.0.1 - Minor fix for strict mode.
-
## License
[MIT](https://github.com/welldone-software/gulp-file-bundle/blob/master/LICENSE)