# rollup-plugin-assets-replace

> Rollup plugin which replaces assets

Latest version **0.2.1** (published 2021-07-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install rollup-plugin-assets-replace
pnpm add rollup-plugin-assets-replace
yarn add rollup-plugin-assets-replace
bun add rollup-plugin-assets-replace
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2021-07-15 |
| First published | 2021-07-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | sugarshin |
| Maintainers | sugarshin |
| Keywords | rollup, plugin, rollup-plugin, assets, replace |

## Links

- npm: https://www.npmjs.com/package/rollup-plugin-assets-replace
- Repository: https://github.com/sugarshin/rollup-plugin-assets-replace
- Homepage: https://github.com/sugarshin/rollup-plugin-assets-replace#readme
- Issues: https://github.com/sugarshin/rollup-plugin-assets-replace/issues
- npm.io page: https://npm.io/package/rollup-plugin-assets-replace

## Dependencies (1)

- [@rollup/pluginutils](https://npm.io/package/@rollup/pluginutils.md) ^4.1.0

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2021-07-15
- 0.2.0 — 2021-07-15

## README

# rollup-plugin-assets-replace

[![CircleCI](https://circleci.com/gh/sugarshin/rollup-plugin-assets-replace/tree/main.svg?style=svg)](https://circleci.com/gh/sugarshin/rollup-plugin-assets-replace/tree/main)

> Rollup plugin which replaces assets

## Description

A [Rollup](https://rollupjs.org/guide/en/) plugin that replaces assets.

## Install

```sh
npm i -D rollup-plugin-assets-replace
```

### Peer Dependencies

rollup-plugin-assets-replace depends on rollup, you need to manually install as development dependencies as well.

## Usage

```js
// rollup.config.js
import { assetsReplace } from 'rollup-plugin-assets-replace';

export default {
  // ...
  plugins: [
    assetsReplace({
      include: [],
      exclude: [],
      map: (assetName, asset) => asset,
    }),
  ],
}
```

### Example

For example, replace module name in TypeScript declaration files.

```js
// rollup.config.js
import typescript from '@rollup/plugin-typescript';
import { assetsReplace } from 'rollup-plugin-assets-replace';

export default {
  input: 'src/index.ts',
  output: {
    file: 'lib/index.js',
    format: 'cjs',
  },
  plugins: [
    typescript(),
    assetsReplace({
      include: [/\.d\.ts$/],
      map(name, asset) {
        asset.source = asset.source.replace(
          /('|"|`)@rollup\/([^/'"`])/g,
          (_, p1, p2) => `${p1}rollup-${p2}`,
        );
        return asset;
      },
    }),
  ],
};
```

### Type Declarations

```ts
import type { OutputAsset, Plugin } from 'rollup';
import type { FilterPattern } from '@rollup/pluginutils';
export declare type Options = {
    include?: FilterPattern;
    exclude?: FilterPattern;
    map(fileName: string, asset: OutputAsset): OutputAsset;
};
export declare function assetsReplace(options: Options): Plugin;
```

## License

[MIT](https://sugarshin.mit-license.org/)

© sugarshin

---
_Source: https://npm.io/package/rollup-plugin-assets-replace · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._