gulp-revsolve

Resolves asset references to absolute paths. Revisioned assets processed by gulp-rev can be replaced as well.

This plugin is based on awesome gulp-revplace by Andrey Yamanov. It removes dependency on mmmagic which caused problems with installation. In contrast to gulp-revplace this plugin provides more grained control over assets with additional options.

Note: Use {read: false} option with gulp.src for files that don't require content processing.

Installation

npm install --save-dev gulp-revsolve

Usage

var gulp = require('gulp');
var base = 'somedir';

gulp.task('default', function () {
  var
    revsolve = require('gulp-revsolve'),
    es = require('event-stream');

  return es.merge(
    gulp
      .src([base + '/index.html'], { base: base }),
    gulp
      .src([base + '/*/**/*.*'], { base: base })
      .pipe(rev())
  )
    .pipe(revsolve())
    .pipe(gulp.dest('somedir'));
});

Check gulp-revplace documentation for additional info.

Options

revsolve(options)

regex

Type: RegExp

Usage: Sets a custom regex to match on your files.

Default: /(?:url\(["']?(.*?)['"]?\)|src=["'](.*?)['"]|src=([^\s\>]+)(?:\>|\s)|href=["'](.*?)['"]|href=([^\s\>]+)(?:\>|\s))/g

cwd

Type: String

Usage: Current working directory. This should match project root directory.

Default: '.'

base

Type: String

Usage: Set this to override asset base paths. This is useful when dealing with sources which have different base paths.

Default: path.resolve(file.base)

patterns

Type: Array

Usage: Glob patterns which will be used to perform additional matching. Patterns are prepended to source paths.

Default: []

addSrcPrefix

Type: String

Usage: Add prefix to source urls.

Default: ''

addDestPrefix

Type: String

Usage: Add prefix to replaced urls.

Default: '/'

stripSrcPrefix

Type: String

Usage: Strip prefix from source urls.

Default: null

stripDestPrefix

Type: String

Usage: Strip prefix from replaced urls.

Default: null

filterExtensions

Type: Array

Usage: Process only contents of text files with specified extensions.

Default: []

skipExtensions

Type: Array

Usage: Skip processing contents of text files with specified extensions.

Default: []

skipUnmentioned

Type: Boolean

Usage: If true only assets that are mentioned in source files will be passed through stream. Source files are always passed.

Default: false

resolveNonRev

Type: Boolean

Usage: If false only revised assets will be replaced.

Default: true

debug

Type: Integer

Usage: Activate debug mode by specifying verbosity.

Default: 0

Verbosity levels:

• 0: disabled
• 1: log resolved assets
• 2: log unresolved assets
• 3: log all

License

The MIT License (MIT)

Copyright (c) 2014 Jure Žvelc

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.