grunt-contrib-rename

Rename files.

npm install grunt-contrib-rename
47 downloads in the last day
1 127 downloads in the last week
4 709 downloads in the last month

grunt-contrib-rename (unofficial grunt plugin)

A convenient plugin but not necessary because you can just use 'copy' and 'delete' tasks in Grunt. Built this more to fiddle around with Grunt and to gain some knowledge HowTo build a plugin for Grunt.

Build Status

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-contrib-rename

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-contrib-rename');

*This plugin was designed to work with Grunt 0.4.x. If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command

Rename task

Run this task with the grunt rename command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Due to the destructive nature of this task, always be cautious of the files you rename.

Options

No Options available yet as of 0.0.2

Extra Info

Behind the scenes as of 0.0.2 use fs.renameSync

Usage Examples

Yes, rename can be used as move as well when the destination path is different from the source path

Primary Usage

rename: {
  main: {
    files: [
          {src: ['path/to/[file or folder]'], dest: 'path/to/[file-renamed or folder-renamed]'},
        ]
  }
}

TODO

  • Add in Options (may not be necessary)

Release History

  • 2013-04-03   v0.0.2   Add support for folder renaming
  • 2013-03-19   v0.0.1   First release for grunt-contrib-rename 0.0.1
npm loves you