Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rollup/rollup-plugin-replace
This module has moved and is now available at @rollup/plugin-replace / https://github.com/rollup/plugins/blob/master/packages/replace
https://github.com/rollup/rollup-plugin-replace
Last synced: 16 days ago
JSON representation
This module has moved and is now available at @rollup/plugin-replace / https://github.com/rollup/plugins/blob/master/packages/replace
- Host: GitHub
- URL: https://github.com/rollup/rollup-plugin-replace
- Owner: rollup
- Archived: true
- Created: 2015-10-24T03:18:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-08-04T16:28:19.000Z (over 3 years ago)
- Last Synced: 2024-09-06T18:09:28.584Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 212 KB
- Stars: 162
- Watchers: 19
- Forks: 23
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Moved
This module has moved and is now available at [@rollup/plugin-replace](https://github.com/rollup/plugins). Please update your dependencies. This repository is no longer maintained.
# rollup-plugin-replace
[](https://www.npmjs.com/package/rollup-plugin-replace)
Replace strings in files while bundling them.
## Installation
```bash
npm install --save-dev rollup-plugin-replace
```
## Usage
Generally, you need to ensure that rollup-plugin-replace goes _before_ other things (like rollup-plugin-commonjs) in your `plugins` array, so that those plugins can apply any optimisations such as dead code removal.
```js
// rollup.config.js
import replace from 'rollup-plugin-replace';
export default {
// ...
plugins: [
replace({
ENVIRONMENT: JSON.stringify('production')
})
]
};
```
## Options
```js
{
// a minimatch pattern, or array of patterns, of files that
// should be processed by this plugin (if omitted, all files
// are included by default)...
include: 'config.js',
// ...and those that shouldn't, if `include` is otherwise
// too permissive
exclude: 'node_modules/**',
// To replace every occurrence of `<@foo@>` instead of every
// occurrence of `foo`, supply delimiters
delimiters: ['<@', '@>'],
// All other options are treated as `string: replacement`
// replacers...
VERSION: '1.0.0',
ENVIRONMENT: JSON.stringify('development'),
// or `string: (id) => replacement` functions...
__dirname: (id) => `'${path.dirname(id)}'`,
// ...unless you want to be careful about separating
// values from other options, in which case you can:
values: {
VERSION: '1.0.0',
ENVIRONMENT: JSON.stringify('development')
}
}
```
## Word boundaries
By default, values will only match if they are surrounded by _word boundaries_ — i.e. with options like this...
```js
{
changed: 'replaced';
}
```
...and code like this...
```js
console.log('changed');
console.log('unchanged');
```
...the result will be this:
```js
console.log('replaced');
console.log('unchanged');
```
If that's not what you want, specify empty strings as delimiters:
```js
{
changed: 'replaced',
delimiters: ['', '']
}
```
## License
MIT