You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Jack Lukic 67397a0cf4 fixes commenting 11 years ago
..
tasks Adds clean module, adds dir cleaning on rebuild 11 years ago
test Adds clean module, adds dir cleaning on rebuild 11 years ago
.jshintrc Adds clean module, adds dir cleaning on rebuild 11 years ago
.npmignore Adds clean module, adds dir cleaning on rebuild 11 years ago
.travis.yml Adds clean module, adds dir cleaning on rebuild 11 years ago
AUTHORS Adds clean module, adds dir cleaning on rebuild 11 years ago
CHANGELOG Adds clean module, adds dir cleaning on rebuild 11 years ago
CONTRIBUTING.md Adds clean module, adds dir cleaning on rebuild 11 years ago
Gruntfile.js Adds clean module, adds dir cleaning on rebuild 11 years ago
LICENSE-MIT Adds clean module, adds dir cleaning on rebuild 11 years ago
README.md Adds clean module, adds dir cleaning on rebuild 11 years ago
package.json Adds clean module, adds dir cleaning on rebuild 11 years ago

README.md

grunt-contrib-clean Build Status

Clean files and folders.

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-clean --save-dev

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

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

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.

Clean task

Run this task with the grunt clean 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 paths you clean.

Options

force

Type: Boolean
Default: false

This overrides grunt.file.delete from blocking deletion of folders outside current working dir (CWD). Use with caution.

Usage Examples

There are three formats you can use to run this task.

Short

clean: ["path/to/dir/one", "path/to/dir/two"]

Medium (specific targets with global options)

clean: {
  build: ["path/to/dir/one", "path/to/dir/two"],
  release: ["path/to/another/dir/one", "path/to/another/dir/two"]
},

Long (specific targets with per target options)

clean: {
  build: {
    src: ["path/to/dir/one", "path/to/dir/two"]
  }
}

Release History

  • 2013-04-16   v0.4.1   Check if file exists to avoid trying to delete a non-existent file.
  • 2013-02-15   v0.4.0   First official release for Grunt 0.4.0.
  • 2013-01-18   v0.4.0rc6   Updating grunt/gruntplugin dependencies to rc6. Changing in-development grunt/gruntplugin dependency versions from tilde version ranges to specific versions.
  • 2013-01-09   v0.4.0rc5   Updating to work with grunt v0.4.0rc5. Switching to this.filesSrc api.
  • 2012-12-07   v0.4.0a   Conversion to grunt v0.4 conventions. Remove node v0.6 and grunt v0.3 support. Add force option to bypass CWD check.
  • 2012-09-23   v0.3.0   Options no longer accepted from global config key.
  • 2012-09-10   v0.2.0   Refactored from grunt-contrib into individual repo.

Task submitted by Tim Branyen

This file was generated on Tue Apr 16 2013 13:28:15.