Socket
Socket
Sign inDemoInstall

@neutrinojs/banner

Package Overview
Dependencies
297
Maintainers
4
Versions
52
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @neutrinojs/banner

Neutrino middleware for injecting a banner into bundled files


Version published
Maintainers
4
Install size
20.2 kB
Created

Changelog

Source

v9.5.0

Readme

Source

Neutrino Banner Middleware

@neutrinojs/banner is Neutrino middleware for injecting string content into source code files.

NPM version NPM downloads

Requirements

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

Installation

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

Yarn
❯ yarn add --dev @neutrinojs/banner
npm
❯ npm install --save-dev @neutrinojs/banner

Usage

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

const banner = require('@neutrinojs/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();`,
    test: neutrino.regexFromExtensions(),
    raw: true,
    entryOnly: true,
    // Override pluginId to add an additional banner plugin instance
    pluginId: 'banner',
  }),
);
// Using in .neutrinorc.js
const banner = require('@neutrinojs/banner');

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

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

// Usage shows the default values of this middleware:
module.exports = {
  use: [
    banner({
      banner: `require('source-map-support').install();`,
      test: neutrino.regexFromExtensions(),
      raw: true,
      entryOnly: true,
      // Override pluginId to add an additional banner plugin instance
      pluginId: 'banner',
    }),
  ],
};

Customization

@neutrinojs/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:

NameDescriptionNODE_ENV
bannerInjects string content into application source code.all

Contributing

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

Keywords

FAQs

Last updated on 23 Dec 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc