gulp-file-assets
v3.1.5
Published
A gulp plugin to extract file assets.
Downloads
483
Readme
gulp-file-assets
A gulp plugin to extract file assets.
Attention: Version 2.0.0+ is not compatible with 1.0.0+.
Usage
First, install gulp-file-assets as a development dependency:
npm install --save-dev gulp-file-assetsThen, add it to your gulpfile.js:
var gulp = require('gulp');
var fileAssets = require('gulp-file-assets');
gulp.task('default', function(){
return gulp
.src('index.html')
.pipe(fileAssets())
.pipe(gulp.dest('dist'));
});Notice: If your source files are in a folder, please set the base option of gulp.src(options) to a right path.
Example
index.html
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>gulp-file-assets</title>
<link rel="stylesheet" href="css/style.css">
</head>
<body>
<a href="sample.html">Link</a>
</body>
</html>style.css
#logo {
background: url(../img/logo.png);
}gulpfile.js
var gulp = require('gulp');
var fileAssets = require('gulp-file-assets');
gulp.task('default', function() {
return gulp
.src('index.html')
.pipe(fileAssets({
excludes: ['html']
}))
.pipe(gulp.dest('dist'));
});
// => ['dist/index.html', 'dist/css/style.css', 'dist/img/logo.png']API
fileAssets(options)
options
Type: Object
options.exts
File extensions to be extracted.
Type: Array
Default:
[
'js', 'css', 'html', 'tpl',
'jpg', 'jpeg', 'png', 'gif', 'svg', 'webp',
'ttf', 'eot', 'otf', 'woff'
]options.excludes
File extensions to be excluded.
Type: Array
Default: []
options.includeSrc
Whether to put the source files to the pipeline.
Type: Boolean
Default: true
options.depth
The depth of files to extract.
Type: Number
Default: null
options.ignores
A file path/RegExp list to be ignored.
Type: Array
Default: []