gulp-simple-rename

A simpler approach to renaming files in gulp.

Usage

var gulp = require('gulp');
var rename = require('gulp-simple-rename');
var today = new Date().toISOString().substr(0, 10); // e.g. "2014-11-18"


// Having a file "src/log for (today).txt",
gulp.src('src/*')
    .pipe(rename(function (path) {
        return path.replace(/(today)/, today);
        }))
    .pipe(gulp.dest('dist'))
    ;
// …we get it copied over to "dest/log for 2014-11-18.txt".

API

simpleRename(renamingFunction)

{Function} renamingFunction(relativePath, originalFile)

The argument to simpleRename should be a simple function. Fed with the relative path of a file, it should return the new relative path.

arguments

The renaming function is passed the following arguments:

• {String} relativePath – The path of the streamed file, relative to the base directory. It is the first directory found by a glob – the package glob-stream, used by gulp, can tell you more about that.

• {File} originalFile – This argument gives access to the raw Vinyl file object being processed by gulp. In most situations you should be fine without it.

return value

The renaming function should return the new relative path for the file, as a {String}.

Why use it

“Hey, we have gulp-rename – what's wrong with it?”

gulp-rename is a great tool. It introduces abstractions which make it easy and idiomatic to rename files. I often use it myself.

But sometimes we need robust simplicity (read: flexibility) rather than idiomatic abstractions.

License

This software is released under the terms of the MIT License.