Neutrino Clean Middleware

NPM version NPM downloads Join Slack

neutrino-middleware-clean is Neutrino middleware for removing directories before building.

Requirements

  • Node.js v6.10+
  • Yarn or npm client
  • Neutrino v6

Installation

neutrino-middleware-clean can be installed via the Yarn or npm clients.

Yarn

❯ yarn add neutrino-middleware-clean

npm

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:

// Using function middleware format
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
});
// Using object or array middleware format

// Use with default options
module.exports = {
  use: ['neutrino-middleware-clean']
};

// Usage shows the default values of this middleware:
module.exports = {
  use: [
    ['neutrino-middleware-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:

Name Description Environments
clean Removes directories before building. all

Contributing

This middleware is part of the neutrino-dev repository, a monorepo containing all resources for developing Neutrino and its core presets and middleware. Follow the contributing guide for details.

results matching ""

    No results matching ""