You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
68 lines
1.8 KiB
68 lines
1.8 KiB
8 years ago
|
# Neutrino Clean Middleware
|
||
|
|
[![NPM version][npm-image]][npm-url] [![NPM downloads][npm-downloads]][npm-url] [![Join Slack][slack-image]][slack-url]
|
||
|
|
|
||
|
|
`neutrino-middleware-clean` is Neutrino middleware for removing directories before building.
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
- Node.js v6.9+
|
||
|
|
- Yarn or npm client
|
||
|
|
- Neutrino v5
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
`neutrino-middleware-clean` can be installed via the Yarn or npm clients.
|
||
|
|
|
||
|
|
#### Yarn
|
||
|
|
|
||
|
|
```bash
|
||
|
|
❯ yarn add neutrino-middleware-clean
|
||
|
|
```
|
||
|
|
|
||
|
|
#### npm
|
||
|
|
|
||
|
|
```bash
|
||
|
|
❯ npm install --save neutrino-middleware-clean
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
`neutrino-middleware-clean` can be consumed from the Neutrino API, middleware, or presets. Require this package
|
||
|
|
and plug it into Neutrino:
|
||
|
|
|
||
|
|
```js
|
||
|
|
const clean = require('neutrino-middleware-clean');
|
||
|
|
|
||
|
|
// Use with default options
|
||
|
|
neutrino.use(clean);
|
||
|
|
|
||
|
|
// Usage shows the default values of this middleware:
|
||
|
|
neutrino.use(clean, {
|
||
|
|
paths: [],
|
||
|
|
root: neutrino.options.root
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
## Customization
|
||
|
|
|
||
|
|
`neutrino-middleware-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:
|
||
|
|
|
||
|
|
- `clean`: Removes directories before building.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
|
||
|
|
containing all resources for developing Neutrino and its core presets. Follow the
|
||
|
|
[contributing guide](https://neutrino.js.org/contributing) for details.
|
||
|
|
|
||
|
|
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-clean.svg
|
||
|
|
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-clean.svg
|
||
|
|
[npm-url]: https://npmjs.org/package/neutrino-middleware-clean
|
||
|
|
[slack-image]: https://neutrino-slack.herokuapp.com/badge.svg
|
||
|
|
[slack-url]: https://neutrino-slack.herokuapp.com/
|