https://github.com/jdavis/grunt-rename

DEPRECATED: A Grunt plugin for moving/renaming files.
https://github.com/jdavis/grunt-rename

Last synced: about 2 months ago
JSON representation

DEPRECATED: A Grunt plugin for moving/renaming files.

• Host: GitHub
• URL: https://github.com/jdavis/grunt-rename
• Owner: jdavis
• License: mit
• Created: 2013-03-28T15:39:37.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2016-02-21T19:39:30.000Z (almost 9 years ago)
• Last Synced: 2024-04-30T21:07:12.621Z (8 months ago)
• Language: JavaScript
• Homepage: https://npmjs.org/package/grunt-rename
• Size: 200 KB
• Stars: 14
• Watchers: 3
• Forks: 10
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
# Deprecated

As of Feb 2015, I am no longer maintaining this Grunt task.

## grunt-rename

[![Build Status](https://travis-ci.org/jdavis/grunt-rename.png)](https://travis-ci.org/jdavis/grunt-rename) [![NPM version](https://badge.fury.io/js/grunt-rename.png)](http://badge.fury.io/js/grunt-rename) [![Dependency Status](https://david-dm.org/jdavis/grunt-rename.png)](https://david-dm.org/jdavis/grunt-rename)

> Move and/or rename files.

## Getting Started

This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell

npm install grunt-rename --save-dev

```

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

```js

grunt.loadNpmTasks('grunt-rename');

```

## The "rename" task

### Overview

In your project's Gruntfile, add a section named `rename` to the data object passed into `grunt.initConfig()`.

```js

grunt.initConfig({

    rename: {

        moveThis: {

            src: 'test/this',

            dest: 'output/'

        },

        // Any number of targets here...

        moveThat: {

            src: 'test/that',

            dest: 'output/that'

        }

    }

})

```

### Options

#### options.ignore

Type: `Boolean`

Default value: `false`

Ignore if the source file doesn't exist.

## Contributing

Feel free to fork it and add as you please. If you add a particularly nice

feature, send me a pull request. I'd love to improve it.