Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vanjacosic/gulp-asset-manifest
gulp plugin for adding generated assets to a manifest file
https://github.com/vanjacosic/gulp-asset-manifest
Last synced: 27 days ago
JSON representation
gulp plugin for adding generated assets to a manifest file
- Host: GitHub
- URL: https://github.com/vanjacosic/gulp-asset-manifest
- Owner: vanjacosic
- License: mit
- Created: 2014-01-15T19:11:05.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-06-24T19:01:36.000Z (over 9 years ago)
- Last Synced: 2024-09-27T16:40:57.048Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 233 KB
- Stars: 7
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [gulp](https://github.com/wearefractal/gulp)-asset-manifest
> gulp plugin for adding generated assets to a manifest file
We needed to make hashed asset filenames available in a common format that a webserver (Django) could load into the templates.
This plugin can easily be modified to suit your own purposes.
It works great with [gulp-rev](https://github.com/sindresorhus/gulp-rev) by Sindre Sorhus.
`gulp-rev` adds hashes to the filename, `gulp-asset-manifest` adds the hashed filenames to the manifest.
## How it works
The plugin takes generated or processed asset files (CSS, JS, whatever) and adds them to a JSON manifest file.
It separates the files by bundles, so you can have one for CSS, one for JS and your other needs.
These bundles can then be read from the manifest file into your templates.
## Install
Install with npm:
```bash
npm install gulp-asset-manifest --save
```
See examples below on how to add it to your gulpfile.
## Examples
### Simple usage
```js
var gulp = require('gulp');
var assetManifest = require('gulp-asset-manifest');
gulp.task('default', function () {
gulp.src('src/*.js')
.pipe(assetManifest({bundleName: 'app_scripts'}))
.pipe(gulp.dest('dist'));
});
```
### Default usage (with gulp-rev)
The use of gulp-rev is completely optional, but recommended for cache-busting etc.
```js
var gulp = require('gulp');
var assetManifest = require('gulp-asset-manifest');
var rev = require('gulp-rev'); // Optional
gulp.task('default', function () {
gulp.src('src/*.js')
.pipe(rev()) // Optional
.pipe(assetManifest({bundleName: 'app_scripts', log: true}))
.pipe(gulp.dest('dist'));
});
```
### Usage with multiple bundles
To have multiple bundles in the same manifest, add different `bundleName` parameters to the tasks.
```js
var gulp = require('gulp');
var assetManifest = require('gulp-asset-manifest');
gulp.task('scripts', function () {
gulp.src('src/*.js')
.pipe(uglify())
.pipe(assetManifest({bundleName: 'app_scripts'}))
.pipe(gulp.dest('dist'));
});
gulp.task('styles', function () {
gulp.src('src/scss/app.scss')
.pipe(sass())
.pipe(assetManifest({bundleName: 'app_styles'}))
.pipe(gulp.dest('dist'));
});
```
### Usage with Django
We haven't gotten around to open sourcing our implementation of the Django manifest loader.
But [@Xowap](https://github.com/Xowap) has created his own version which can be found here: https://gist.github.com/Xowap/f01dad68418dbb8ab110
## API
### assetManifest(options)
#### options.bundleName
Type: `String`
Required: Yes
Name of the bundle for this task.
E.g. if the tasks handles JS libraries, the bundle name could be 'js_libs'.
If the gulp task processes all Sass files, it could be 'main_css'.
#### options.manifestFile
Type: `String`
Default: `asset_manifest.json`
Required: No
Path of the manifest file which plugin reads from and writes to.
#### options.pathPrepend
Type: `String`
Default: None
Required: No
Prepend a path to the filename. Eg. 'assets/build/'.
#### options.includeRelativePath
Type: `Boolean`
Default: `false`
Required: No
Will include the relative path of the file(s).
#### options.pathSeparator
Type: `String`
Default: *The default path separator for the current environment*
Required: No
Override the environment's default path separator. Can be used to convert MSDOS paths (`\`) to *nix paths ('/').
#### options.log
Type: `Boolean`
Default: `false`
Required: No
If true, the plugin will output filenames to the console.
## License
MIT © Vanja Cosic