2.0.0 • Published 5 years ago

gulp-rename v2.0.0

Weekly downloads
771,566
License
MIT
Repository
github
Last release
5 years ago

gulp-rename

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

NPM

build status devDependency Status

Usage

gulp-rename provides simple file renaming methods.

var rename = require("gulp-rename");

// rename to a fixed value
gulp.src("./src/main/text/hello.txt")
  .pipe(rename("main/text/ciao/goodbye.md"))
  .pipe(gulp.dest("./dist")); // ./dist/main/text/ciao/goodbye.md

// rename via mutating function
gulp.src("./src/**/hello.txt")
  .pipe(rename(function (path) {
    // Updates the object in-place
    path.dirname += "/ciao";
    path.basename += "-goodbye";
    path.extname = ".md";
  }))
  .pipe(gulp.dest("./dist")); // ./dist/main/text/ciao/hello-goodbye.md

// rename via a map function
gulp.src("./src/**/hello.txt")
  .pipe(rename(function (path) {
    // Returns a completely new object, make sure you return all keys needed!
    return {
      dirname: path.dirname + "/ciao",
      basename: path.basename + "-goodbye",
      extname: ".md"
    };
  }))
  .pipe(gulp.dest("./dist")); // ./dist/main/text/ciao/hello-goodbye.md

// rename via a fixed object
gulp.src("./src/main/text/hello.txt", { base: process.cwd() })
  .pipe(rename({
    dirname: "main/text/ciao",
    basename: "aloha",
    prefix: "bonjour-",
    suffix: "-hola",
    extname: ".md"
  }))
  .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

@tyz-wallet/tyz-wallet-core-build@violetx/buildab-pdf-reader-exampleab-gulpabwa-gulpdesign-system-of-a-down@webx/gulp@jadex/webx-gulplpbt@aymlab/mortarsquareboylab3akibardinlab3kibardin@animalus/gulp-dev-toolsldu-gulpfunctionsaccucode-wp-starternodewebx-build@monzy/pip@monzy/wordomizermarigold-buildgulpproject-v1nlisgo-pattern-libraryrockywu-uixx-lrzvia-websites@moda/generator-portal-packagesw-plugin-devcli-blocksblkcliadgile-devngvcalendartooled@mycolorway/vest@rock-kit/ui-icons-buildng-horo@crivas/ute-uibbt-editorlkutsenok-web-lab3magnovue-lsui1vue-lsuiabsass-sdfddabc-jdjdjjd@phparkle/semantic-uipraos-briefcase@wwwoda/gulp-tasks@angrymonkeycloud/cloudmateprotocol-theme-teststartydindelavanta-elixirbitcore-build-polisbedrock-shadowsbedrock-tabsbedrock-alertsbedrock-brandbedrock-buttonsbedrock-cardsbedrock-corebedrock-dropdownsbedrock-formsbedrock-frameworkbedrock-gridbedrock-layouts@siiron/sds-iconssblog@johnnywang/data-boxabota-builduni-app-hybrid-packdialer-reportsnotiontheory-basic-buildhandful-toolkittempaw-toolsdev-agnitio-clijquery-file-explorercert-requestslush-hughes-wp-starterslush-accucode-wp-starterslush-slush-accucode-wp-startervtex-boilerplate@acanto/workflow-laravel-frontendslush-vtex-boilerplate@mygooder/semanticauction_lab3_bykov_andrewosfe-builderuino-thinguino-thing.ammouino-thing.campusuino-thing.dom@satche/workflowpicturesauctionjs-utils-libs@alotool/bloggerpackgrch-scriptsvinus3vinus4@somoscuatro/gulp-wordpress-themesamurai-clidas-buildslush-aws-samslush-phonegap
2.0.0

5 years ago

1.4.0

6 years ago

1.3.0

6 years ago

1.2.3

6 years ago

1.2.2

10 years ago

1.2.0

11 years ago

1.1.0

11 years ago

1.0.0

11 years ago

0.2.2

11 years ago

0.2.1

11 years ago

0.1.0

11 years ago