grunt-remove
Version:
Remove directory and files
58 lines (40 loc) • 1.4 kB
Markdown
# grunt-remove
> GruntJS plugin for remove directory and 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-remove --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-remove');
```
## The "remove" task
### Overview
In your project's Gruntfile, add a section named `remove` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
...
remove: {
options: {
trace: true
},
fileList: ['path_to_file_1.extension', 'path_to_file_2.extension'],
dirList: ['path_to_dir_1', 'path_to_dir2/']
},
...
})
```
### Options
#### options.trace
Type: `Boolean`
Default value: `undefined`
A boolean value that is used to trace work operations
## Release History
**v0.1.0:**
date: 2013-07-08
changes:
- Initial release of 0.1.0.
**Copyright (c) 2013 nvoinov**
**Licensed under the MIT license.**