gulp-usemin

Replaces references to non-optimized scripts or stylesheets into a set of HTML files (or any templates/views).

This task is designed for gulp 3.

Attention: v0.2.0 does not minify the files by default.

Usage

First, install gulp-usemin as a development dependency:

1npm install --save-dev gulp-usemin

Then, add it to your gulpfile.js:

1var usemin = require('gulp-usemin');
2var uglify = require('gulp-uglify');
3var minifyHtml = require('gulp-minify-html');
4var minifyCss = require('gulp-minify-css');
5
6gulp.task('usemin', function() {
7  gulp.src('./*.html')
8    .pipe(usemin({
9      cssmin: minifyCss(),
10      htmlmin: minifyHtml(),
11      jsmin: uglify()
12    }))
13    .pipe(gulp.dest('build/'));
14});

API

Blocks

Blocks are expressed as:

1<!-- build:<type>(alternate search path) <path> -->
2... HTML Markup, list of script / link tags.
3<!-- endbuild -->

• type: either js or css
• alternate search path: (optional) By default the input files are relative to the treated file. Alternate search path allows one to change that
• path: the file path of the optimized file, the target output

An example of this in completed form can be seen below:

1<!-- build:css style.css -->
2<link rel="stylesheet" href="css/clear.css"/>
3<link rel="stylesheet" href="css/main.css"/>
4<!-- endbuild -->
5
6<!-- build:js js/app.js -->
7<script src="js/app.js"></script>
8<script src="js/controllers/thing-controller.js"></script>
9<script src="js/models/thing-model.js"></script>
10<script src="js/views/thing-view.js"></script>
11<!-- endbuild -->

Options

cssmin

Type: Object

Plugin for minify output css.

htmlmin

Type: Object

Plugin for minify output html.

jsmin

Type: Object

Plugin for minify output js.

assetsDir

Type: String

Alternate root path for assets. New concated js and css files will be written to the path specified in the build block, relative to this path. Currently asset files are also returned in the stream.

rev

Type: Boolean Default: false

If true use gulp-rev to revision and rename the asset files. The new asset file names will automatically be used in the html tags.

Use case

|
+- app
|   +- index.html
|   +- assets
|       +- js
|          +- foo.js
|          +- bar.js
|   +- css
|       +- clear.css
|       +- main.css
+- dist

We want to optimize foo.js and bar.js into optimized.js, referenced using relative path. index.html should contain the following block:

    <!-- build:css style.css -->
    <link rel="stylesheet" href="css/clear.css"/>
    <link rel="stylesheet" href="css/main.css"/>
    <!-- endbuild -->

    <!-- build:js js/optimized.js -->
    <script src="assets/js/foo.js"></script>
    <script src="assets/js/bar.js"></script>
    <!-- endbuild -->

We want our files to be generated in the dist directory. gulpfile.js should contain the following block:

1gulp.task('usemin', function(){
2  gulp.src('./app/index.html')
3    .pipe(usemin({jsmin: uglify()}))
4    .pipe(gulp.dest('dist/'));
5});

This will generate the following output:

|
+- app
|   +- index.html
|   +- assets
|       +- js
|          +- foo.js
|          +- bar.js
+- dist
|   +- index.html
|   +- js
|       +- optimized.js
|   +- style.css

index.html output:

    <link rel="stylesheet" href="style.css"/>

    <script src="js/optimized.js"></script>

Changelog

#####0.2.2

• allow gulp-usemin to work with minified source HTML (by CWSpear)
• fixed alternate path bug (by CWSpear)
• add assetDir option (by pursual)
• add rev option (by pursual)

#####0.2.1

• fixed subfolders bug

#####0.2.0

• no minification by default. New options API

#####0.1.4

• add alternate search path support

#####0.1.3

• add support for absolute URLs (by vasa-chi)

#####0.1.1

• fixed aggressive replace comments

#####0.1.0

• fixed some bugs. Add tests.

#####0.0.2

• add minification by default

#####0.0.1

• initial release