Neutrino Copy Middleware

NPM version NPM downloads Join Slack

neutrino-middleware-copy is Neutrino middleware for copying files during building.

Requirements

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

Installation

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

Yarn

❯ yarn add neutrino-middleware-copy

npm

npm install --save neutrino-middleware-copy

Usage

neutrino-middleware-copy can be consumed from the Neutrino API, middleware, or presets. Require this package and plug it into Neutrino:

// Using function middleware format
const copy = require('neutrino-middleware-copy');

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

// Usage shows the default values of this middleware:
neutrino.use(copy, {
  patterns: [],
  options: {}
});
// Using object or array middleware format

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

// Usage shows the default values of this middleware:
module.exports = {
  use: [
    ['neutrino-middleware-copy', {
      patterns: [],
      options: {}
    }]
  ]
};

The patterns and options are defined from the CopyWebpackPlugin. See their docs for details on valid values to specify.

  • patterns: An array of patterns specifying copy operations.
  • options: An object specifying copy options.

Customization

neutrino-middleware-copy 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
copy Copy files during 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 ""