gulp-rename

gulp-rename is a gulp plugin to rename files easily.

Usage

gulp-rename provides simple file renaming methods.

1var rename = require("gulp-rename");
2
3// rename to a fixed value
4gulp.src("./src/main/text/hello.txt")
5  .pipe(rename("main/text/ciao/goodbye.md"))
6  .pipe(gulp.dest("./dist")); // ./dist/main/text/ciao/goodbye.md
7
8// rename via mutating function
9gulp.src("./src/**/hello.txt")
10  .pipe(rename(function (path) {
11    // Updates the object in-place
12    path.dirname += "/ciao";
13    path.basename += "-goodbye";
14    path.extname = ".md";
15  }))
16  .pipe(gulp.dest("./dist")); // ./dist/main/text/ciao/hello-goodbye.md
17
18// rename via a map function
19gulp.src("./src/**/hello.txt")
20  .pipe(rename(function (path) {
21    // Returns a completely new object, make sure you return all keys needed!
22    return {
23      dirname: path.dirname + "/ciao",
24      basename: path.basename + "-goodbye",
25      extname: ".md"
26    };
27  }))
28  .pipe(gulp.dest("./dist")); // ./dist/main/text/ciao/hello-goodbye.md
29
30// rename via a fixed object
31gulp.src("./src/main/text/hello.txt", { base: process.cwd() })
32  .pipe(rename({
33    dirname: "main/text/ciao",
34    basename: "aloha",
35    prefix: "bonjour-",
36    suffix: "-hola",
37    extname: ".md"
38  }))
39  .pipe(gulp.dest("./dist")); // ./dist/main/text/ciao/bonjour-aloha-hola.md

See test/rename.spec.js for more examples and test/path-parsing.spec.js for hairy details.

Notes

• dirname is the relative path from the base directory set by gulp.src to the filename.
  • gulp.src() uses glob-stream which sets the base to the parent of the first directory glob (*, **, [], or extglob). dirname is the remaining directories or ./ if none. glob-stream versions >= 3.1.0 (used by gulp >= 3.2.2) accept a base option, which can be used to explicitly set the base.
  • gulp.dest() renames the directories between process.cwd() and dirname (i.e. the base relative to CWD). Use dirname to rename the directories matched by the glob or descendents of the base of option.
• basename is the filename without the extension like path.basename(filename, path.extname(filename)).
• extname is the file extension including the . like path.extname(filename).
• when using a function, a second file argument is provided with the whole context and original file value.
• when using a function, if no Object is returned then the passed parameter object (along with any modifications) is re-used.

License

MIT License