https://github.com/augbog/grunt-name-changer

A Grunt task for batch renaming files.
https://github.com/augbog/grunt-name-changer

Last synced: 3 days ago
JSON representation

A Grunt task for batch renaming files.

• Host: GitHub
• URL: https://github.com/augbog/grunt-name-changer
• Owner: augbog
• Created: 2015-01-23T00:30:37.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2014-12-08T02:18:35.000Z (about 10 years ago)
• Last Synced: 2024-11-02T01:05:06.818Z (about 2 months ago)
• Language: JavaScript
• Size: 152 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Grunt Name Changer

==================

A Grunt task for batch renaming files.

## Getting Started

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

```sh

npm install grunt-name-changer --save-dev

```

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

```js

grunt.loadNpmTasks('grunt-name-changer');

```

*Tip: the [load-grunt-tasks](https://github.com/sindresorhus/load-grunt-tasks) module makes it easier to load multiple grunt tasks.*

[grunt]: http://gruntjs.com

[Getting Started]: https://github.com/gruntjs/grunt/wiki/Getting-started

## Documentation

See the [Gruntfile](Gruntfile.js) in this repo for a full example.

### Example config

```js

grunt.initConfig({

  'name-changer': {

    options: {

      reference: 'img/',

      directory: ['**/*.png', '**/*.jpg', '**/*.gif'],

      lettercase: 'lowercase',

      spaces:'-'

    },

  }

});

grunt.loadNpmTasks('grunt-name-changer');

grunt.registerTask('default', ['name-changer']);

```

### Options

#### reference

Type: `String`

Default value: `img/`

A reference to the directory of files that are being checked if they are referenced in other project files.

#### filetype

Type: `String|Array`

Default value: `['**/*.png', '**/*.jpg', '**/*.gif']`

An array of filetypes in the reference directory.

#### lettercase

Type: `String`

Default value: `lowercase`

An option for changing the letter case of the file names.

#### prepend

Type: `String`

Default value: `null`

Prepend a string to the file name.

#### append

Type: `String`

Default value: `null`

#### remove

Type: `String`

Default value: `null`

Append a string to the file name.

## Release History

* 0.1.5: Small updates to documentation.

* 0.1.4: Small bug fix for append and prepend.

* 0.1.3: Ability to remove a string from file names.

* 0.1.2: Ability to append and prepend a string to file names.

* 0.1.1: Fix unecessary reference.

* 0.1.0: Initial release.

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

## License

MIT © [Ryan Burgess](http://ryanburgess.com)