neutrino-dev/docs/middleware/neutrino-middleware-banner

Neutrino Banner Middleware

neutrino-middleware-banner is Neutrino middleware for injecting string content into source code files.

Requirements

• Node.js v6.9+
• Yarn or npm client
• Neutrino v5

Installation

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

Yarn

❯ yarn add neutrino-middleware-banner

npm

❯ npm install --save neutrino-middleware-banner

Usage

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

const banner = require('neutrino-middleware-banner');

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

// Also accepts options for Webpack's BannerPlugin
// https://webpack.js.org/plugins/banner-plugin/

// Usage shows the default values of this middleware:
neutrino.use(banner, {
  banner: `require('source-map-support').install();`,
  raw: true,
  entryOnly: true
});

Customization

neutrino-middleware-banner 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:

• banner: Injects string content into application source code.

Contributing

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