# rollup-plugin-insert

**Repository Path**: mirrors_danielgindi/rollup-plugin-insert

## Basic Information

- **Project Name**: rollup-plugin-insert
- **Description**: string mutation plugin for rollup
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-05-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# rollup-plugin-insert

[![Greenkeeper badge](https://badges.greenkeeper.io/JounQin/rollup-plugin-insert.svg)](https://greenkeeper.io/)
[![Travis](https://img.shields.io/travis/JounQin/rollup-plugin-insert.svg)](https://travis-ci.org/JounQin/rollup-plugin-insert)
[![Codecov](https://img.shields.io/codecov/c/github/JounQin/rollup-plugin-insert.svg)](https://codecov.io/gh/JounQin/rollup-plugin-insert)
[![David](https://img.shields.io/david/JounQin/rollup-plugin-insert.svg)](https://david-dm.org/JounQin/rollup-plugin-insert)
[![David Dev](https://img.shields.io/david/dev/JounQin/rollup-plugin-insert.svg)](https://david-dm.org/JounQin/rollup-plugin-insert?type=dev)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

string mutation plugin for rollup

## Usage

```bash
# npm
npm install -D rollup-plugin-insert

# yarn
yarn add -D rollup-plugin-insert
```

```js
import * as insert from 'rollup-plugin-insert'
```

## Common Usage

All following methods has an optional last argument `options` which is an object and contains key `include` and `exclude`.

It can be used to filter files as you like. For example you can wrapper your html template as following:

```js
insert.transform(
  (code, id) =>
    `export default ${JSON.stringify(`<!--add some comments-->${code}`)}`,
  {
    include: '**/*.html',
  },
)
```

## Append

Appends a string onto the contents.

```js
insert.append('world') // Appends 'world' to the contents of every file
```

## Prepend

Prepends a string onto the contents.

```js
insert.prepend('Hello') // Prepends 'Hello' to the contents of every file
```

## Wrap

Wraps the contents with two strings.

```js
insert.wrap('Hello', 'World') // prepends 'hello' and appends 'world' to the contents
```

## Transform

Calls a function with the contents of the file.

```js
insert.transform((code, id) => code.toUpperCase())
```