# @ilabdev/clean

> Gulp tasks for cleaning files & directories

Latest version **1.0.0** (published 2023-10-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ilabdev/clean
pnpm add @ilabdev/clean
yarn add @ilabdev/clean
bun add @ilabdev/clean
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-10-04 |
| First published | 2023-10-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Innovation Lab |
| Maintainers | apalfrey |
| Keywords | gulp, compiler, clean, cleaning |

## Links

- npm: https://www.npmjs.com/package/@ilabdev/clean
- Repository: https://github.com/ilabproduction/compiler
- Homepage: https://github.com/ilabproduction/compiler#readme
- Issues: https://github.com/ilabproduction/compiler/issues
- npm.io page: https://npm.io/package/@ilabdev/clean

## Dependencies (2)

- [rimraf](https://npm.io/package/rimraf.md) ^5.0.5
- [@ilabdev/utils](https://npm.io/package/@ilabdev/utils.md) ^1.0.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-10-04

## README

# `@ilabdev/clean`

> Gulp tasks for cleaning files & directories

## Installation & set up

Install `@ilabdev/clean`

```shell
npm install @ilabdev/clean --save-dev

-- OR --

yarn add @ilabdev/clean --dev
```

Include `@ilabdev/clean` in your `gulpfile.js`

**NOTE:** Make sure you pass `gulp` through to the package as shown below. The package sets up gulp tasks and will need it passed through to work.

```js
require( '@ilabdev/clean' )( gulp )
```

Add the content from `config.sample.js` to your `.gulpconfig.js` and adjust as appropriate

```js
module.exports = {
    // Other configs here...
    clean: {
        process: true,
        logColor: 'red',
        paths: [
            './dist',
        ],
        pipes: {
            rimraf: {
                glob: true,
            },
        },
    },
    // Other configs here...
}
```

Run `gulp clean` to run the task, or add the task as a script and run that with `npm` or `yarn`

## Config

### `process`

Type: `boolean`

Whether to clean files & directories or not

### `loggerColor`

Type: `string`

The logger color to use for any output text. See https://github.com/stgdp/fancy-logger#available-modifiers for colors that can be used

### `paths`

Type: `string[]|string`

The paths to remove. Passed through to `gulp.src`, items can be globs

### `pipes`

Type: `object`

Options to be passed through to the pipes

### `pipes.rimraf`

Type: `object`

Options to be passed through to the `rimraf` pipe. See https://www.npmjs.com/package/rimraf#rimraff-opts---promise for more information

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