mirror of
https://github.com/analyticsjs/vue-baidu-analytics.git
synced 2025-04-06 03:58:00 +08:00
82 lines
1.7 KiB
Markdown
82 lines
1.7 KiB
Markdown
# rollup-plugin-banner
|
||
|
||
[](https://travis-ci.org/yingye/rollup-plugin-banner)
|
||
[](https://badge.fury.io/js/rollup-plugin-banner)
|
||
[](https://github.com/yingye/rollup-plugin-banner/blob/master/CHANGELOG.md)
|
||
|
||
## 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:
|
||
|
||
```js
|
||
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
|
||
})
|
||
```
|