broccoli-clean

Broccoli Clean

Given an input node, the Broccoli Clean plugin clean a specified node. You can specify multiple folders as an array.

Documentation

clean(inputNode, options)

inputNode {Single node | Nodes array}

A Broccoli node (formerly: "tree"). A node in Broccoli can be either a string that references a directory in your project, or array of string of directories, or a node object returned from running another Broccoli plugin.

If your project has the following file structure:

.
├── Brocfile.js
├── dist/
└── temp/

You can select a subsection of the tree via Clean:

const clean = require('broccoli-clean');
const cleanDir = clean('dist');

or

const clean = require('broccoli-clean');
const cleanDirs = clean(['dist', 'temp']);

Export node for Broccoli

module.exports = cleanDir;

Options

annotation {String}

Tests

Running the tests:

npm install
npm test

License

This project a distributed under the MIT license.