# @neutrinojs/clean

> Neutrino middleware for cleaning bundle output directories

Latest version **9.5.0** (published 2020-12-23) · MPL-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 9.5.0 |
| Published | 2020-12-23 |
| First published | 2017-12-07 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 20.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3905 |
| Author | Eli Perelman |
| Maintainers | edmorley, helfi92, timkelty, eliperelman |
| Keywords | neutrino, neutrino-middleware, clean |

## Links

- npm: https://www.npmjs.com/package/@neutrinojs/clean
- Repository: https://github.com/neutrinojs/neutrino
- Homepage: https://neutrinojs.org
- Issues: https://github.com/neutrinojs/neutrino/issues
- npm.io page: https://npm.io/package/@neutrinojs/clean

## Dependencies (1)

- [clean-webpack-plugin](https://npm.io/package/clean-webpack-plugin.md) ^3.0.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 9.5.0 (latest) — 2020-12-23
- 9.4.0 — 2020-08-28
- 9.3.0 — 2020-07-16
- 9.2.0 — 2020-06-07
- 9.1.0 — 2020-01-28
- 9.0.0 — 2019-12-13
- 9.0.0-rc.5 — 2019-11-13
- 9.0.0-rc.4 — 2019-10-06
- 9.0.0-rc.3 — 2019-05-08
- 9.0.0-rc.2 — 2019-05-08
- 9.0.0-rc.1 — 2019-04-16
- 9.0.0-rc.0 — 2018-11-26
- 9.0.0-beta.1 — 2018-10-23
- 9.0.0-beta.0 — 2018-09-20
- 8.3.0 — 2018-06-27
- … 37 more at https://npm.io/package/@neutrinojs/clean/versions

## README

# Neutrino Clean Middleware

`@neutrinojs/clean` is Neutrino middleware for removing or cleaning build
directories.

[![NPM version][npm-image]][npm-url] [![NPM downloads][npm-downloads]][npm-url]

By default, this plugin will remove all files inside webpack's `output.path`
directory, as well as all unused webpack assets after every successful rebuild.

## Requirements

- Node.js 10+
- Yarn v1.2.1+, or npm v5.4+
- Neutrino 9
- webpack 4

## Installation

`@neutrinojs/clean` can be installed via the Yarn or npm clients.

#### Yarn

```bash
❯ yarn add --dev @neutrinojs/clean
```

#### npm

```bash
❯ npm install --save-dev @neutrinojs/clean
```

## Usage

`@neutrinojs/clean` can be consumed from the Neutrino API, middleware, or
presets. Require this package and plug it into Neutrino:

```js
const clean = require('@neutrinojs/clean');

// Use with default options
neutrino.use(clean());

// Usage shows the default values of this middleware:
neutrino.use(
  clean({
    verbose: neutrino.options.debug,
    // Override pluginId to add an additional clean plugin instance
    pluginId: 'clean',
  }),
);
```

```js
// Using in .neutrinorc.js
const clean = require('@neutrinojs/clean');

// Use with default options
module.exports = {
  use: [clean()],
};

// Usage shows the default values of this middleware:
module.exports = {
  use: [
    clean({
      verbose: neutrino.options.debug,
      // Override pluginId to add an additional banner plugin instance
      pluginId: 'clean',
    }),
  ],
};
```

Additional options can be specified to control the behavior of the underlying
`clean-webpack-plugin`. See
[`CleanWebpackPlugin`'s documentation](https://github.com/johnagan/clean-webpack-plugin)
for available options.

## Clean external directories

Pass the `dangerouslyAllowCleanPatternsOutsideProject: true` option to remove
directories outside of the project root. This is disabled by default to prevent
deletion of unintended directories.

```js
module.exports = {
  use: [
    clean({
      dangerouslyAllowCleanPatternsOutsideProject: true,
    }),
  ],
};
```

## Customization

`@neutrinojs/clean` creates some conventions to make overriding the
configuration easier once you are ready to make changes.

### Plugins

The following is a list of plugins and their identifiers which can be
overridden:

| Name    | Description                          | NODE_ENV |
| ------- | ------------------------------------ | -------- |
| `clean` | Removes directories before building. | all      |

## Contributing

This middleware is part of the
[neutrino](https://github.com/neutrinojs/neutrino) repository, a monorepo
containing all resources for developing Neutrino and its core presets and
middleware. Follow the
[contributing guide](https://neutrinojs.org/contributing/) for details.

[npm-image]: https://img.shields.io/npm/v/@neutrinojs/clean.svg
[npm-downloads]: https://img.shields.io/npm/dt/@neutrinojs/clean.svg
[npm-url]: https://www.npmjs.com/package/@neutrinojs/clean

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