# @webscaffold/task-clean

> @webscaffold clean task

Latest version **0.1.0-alpha.13** (published 2020-06-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @webscaffold/task-clean
pnpm add @webscaffold/task-clean
yarn add @webscaffold/task-clean
bun add @webscaffold/task-clean
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0-alpha.13 |
| Published | 2020-06-04 |
| First published | 2019-06-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Radu Micu |
| Maintainers | radumza |

## Links

- npm: https://www.npmjs.com/package/@webscaffold/task-clean
- Repository: https://github.com/webscaffold/webscaffold/tree/master/packages/task-clean
- npm.io page: https://npm.io/package/@webscaffold/task-clean

## Recent versions

- 0.1.0-alpha.13 (latest) — 2020-06-04
- 0.1.0-alpha.12 — 2020-01-21
- 0.1.0-alpha.11 — 2019-12-30
- 0.1.0-alpha.10 — 2019-10-28
- 0.1.0-alpha.9 — 2019-09-02
- 0.1.0-alpha.8 — 2019-08-08
- 0.1.0-alpha.7 — 2019-07-10
- 0.1.0-alpha.6 — 2019-07-09
- 0.1.0-alpha.5 — 2019-07-08
- 0.1.0-alpha.4 — 2019-07-02
- 0.1.0-alpha.3 — 2019-06-20
- 0.1.0-alpha.2 — 2019-06-18
- 0.1.0-alpha.1 — 2019-06-18
- 0.1.0-alpha.0 — 2019-06-17

## README

<div align="center">
  <img src="media/bulldozer.svg" alt="Web Scaffold task-clean" height="200" />
</div>

# @web-scaffold/task-clean

> [`WEB Scaffold`](https://github.com/webscaffold/webscaffold) task for cleaning up folders and files.

## Install

```sh
$ npm install --save-dev @webscaffold/task-clean
```

## Usage

```js
const clean = require('@webscaffold/task-clean');

await clean(['path_to_folder/*'], options);
```

This will clean all files from the folder.

The module uses [rimraf](https://www.npmjs.com/package/rimraf) internally so for more info on how you can define the paths check the modules options.

## API

### clean(paths, [options])

Returns a Promise for the paths to be removed. It will also log to the console the steps it took to do it.

#### paths

Type: `array`

Array of paths to be removed using `rimraf` options.

#### options

Type: `object`

Options object that can be passed.

##### taskName

Type: `string`<br>
Default: `clean`

Task name that will be used by the logger to namespace the logs.

##### taskColor

Type: `string`<br>
Default: `#F3FFBD`

The color used by the logger to log to the console the task output.

## Licensing

MIT © Radu Micu

---
_Source: https://npm.io/package/@webscaffold/task-clean · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._