grunt-name-changer

Batch rename files

Usage no npm install needed!

<script type="module">
  import gruntNameChanger from 'https://cdn.skypack.dev/grunt-name-changer';
</script>

README

Grunt Name Changer

npm version Build Status

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 as well as install and use grunt plugins. Once you're familiar with that process, install this plugin with this command:

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:

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

Tip: the load-grunt-tasks module makes it easier to load multiple grunt tasks.

Documentation

See the Gruntfile in this repo for a full example.

Example config

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.2.0: Update peerDependencies
  • 0.1.9: Update peerDependencies
  • 0.1.8: Support Node.js 4.0.
  • 0.1.7: Add git ignore file.
  • 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