yingye/rollup-plugin-banner

README

rollup-plugin-banner

Introduction

Rollup plugin to append content before js bundle.

The difference between this plugin and the output.banner parameter provided by the rollup is that the banner will not be cleaned up. For example, your project uses the rollup-plugin-uglify plugin, the output file will not contain the output.banner parameter you set. So you need rollup-plugin-banner to solve this problem.

Usage

Install the plugin with NPM:

npm install --save-dev rollup-plugin-banner

Add it to your rollup configuration:

import banner from 'rollup-plugin-banner'

export default {
  plugins: [
    banner('rollup-plugin-banner v<%= pkg.version %> by<%= pkg.author %>')
  ]
}

API

banner(options)

options

Type: String / Object

String

Input:

banner('rollup-plugin-banner v<%= pkg.version %> by <%= pkg.author %>')

Output:

// rollup-plugin-banner v0.1.0 by yingye

The pkg is the content of the project package.json.

If your text is multi-line, you can use '\n'.

banner('rollup-plugin-banner\nv<%= pkg.version %>\nby <%= pkg.author %>')

output:

/**
* rollup-plugin-banner
* v0.1.0
* by yingye
*/

Object

banner({
  file: path.join(__dirname, 'banner.txt')，
  encoding: 'utf-8' // default is utf-8
})