webpack-content-replacer-plugin

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

webpack-content-replacer-plugin

★ 15 Open GitHub ↗

⭐️ Plugin that replace content in file in a webpack workflow

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">
<img src="https://raw.githubusercontent.com/iGitScor/webpack-content-replacer-plugin/master/logo.png" />
<br />
Webpack content replacer
</h1>

[![Build Status][build-badge]][build]
[![codecov][codecoverage-badge]][codecoverage]
![Node dependency][node-badge]
[![Dependencies][dependencyci-badge]][dependencyci]
[![dependencies Status][dependencies-badge]][dependencies]
[![devDependencies Status][devDependencies-badge]][devDependencies]
[![MIT License][license-badge]][LICENSE]

> Replace content in file in webpack workflow

Edit file by replacing content at different build step in a webpack workflow.

_For example, you can change text color, text content or also insert configuration values from environment variables._

## Installing

```shell
npm i webpack-content-replacer-plugin
```

### Getting started in webpack

**Require `webpack-content-replacer-plugin`**
```javascript
var ContentReplacerWebpackPlugin = require('webpack-content-replacer-plugin')
```

Add the plugin to your plugin list
```javascript
var config = {
  plugins: [
    new ContentReplacerWebpackPlugin({
      modifiedFile: './relative_path/file_to_be_modified.ext',
      modifications: [
        {
          regex: /%content_to_be_deleted%/g,
          modification: 'new_content',
        },
        {
          regex: /%content2_to_be_deleted%/g,
          modification: 'new_content2',
        },
      ],
    })
  ]
}
```

### Configuration

#### modifiedFile
- Type: `String`  
- Default: no default value
- Required: true

Specify the file which will be modified.

Example:
```javascript
var config = {
  plugins: [
    new ContentReplacerWebpackPlugin({
      modifiedFile: './build/index.html',
      ...
    })
  ]
}
```

#### modifications
- Type: `Array<Modification>`  
- Default: no default value
- Required: true

Specify the modifications to be applied to the file.

Example:
```javascript
var config = {
  plugins: [
    new ContentReplacerWebpackPlugin({
      modifiedFile: './build/index.html',
      [
        {
          regex: /text/g,
          modification: 'new text'
        }
      ],
      ...
    })
  ]
}
```

##### modification
- Type: `Object`
- Default: no default value
- Required: true

Example:
```javascript
{
  regex: /text/g,
  modification: 'new text'
}
```

#### buildTrigger
- Type: `String`
- Default: `after-emit`
- Allowed values: `after-emit`, `done`

Specify webpack build step (c.f [plugin documentation](https://webpack.github.io/docs/plugins.html)).

Example:
```javascript
var config = {
  plugins: [
    new ContentReplacerWebpackPlugin({
      modifiedFile: './build/index.html',
      [
        {
          regex: /text/g,
          modification: 'new text'
        }
      ],
      buildTrigger: 'done',
      ...
    })
  ]
}
```

#### logLevel
- Type: `String`
- Default: `strict`
- Allowed value: `strict`, `log`, `none`
  - `strict`: catch errors in an exception, **the webpack build crashes**
  - `log`: log errors in a log file (`warning.log`) and none behavior
  - `none`: show errors in console (when silent mode is off)

Specify behavior when the plugin fail.

#### silent
- Type: `Boolean`  
- Default: `false`

Display/hide info logs during the build.

Example:
```javascript
var config = {
  plugins: [
    new ContentReplacerWebpackPlugin({
      silent: true,
      modifiedFile: './build/index.html',
      [
        {
          regex: /text/g,
          modification: 'new text'
        }
      ],
      buildTrigger: 'done'
      ],
    })
  ]
}
```

## Developing

```shell
git clone https://github.com/{your fork}/webpack-content-replacer-plugin.git
cd webpack-content-replacer-plugin/
npm install
```

Replace `{your fork}` by your github username.

## Contributing

If you'd like to contribute, please fork the repository and use a feature
branch. All contributions are welcome. Please make a pull request and make sure things still pass after running `npm test`.
Ensure you've read the [contribution guidelines](CONTRIBUTING.md) for more information and respect the [code of conduct](CODE_OF_CONDUCT.md)

### Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

| [<img src="https://avatars3.githubusercontent.com/u/2276944?v=3" width="100px;"/><br /><sub>Sebastien Correaud</sub>](http://twitter.com/iTweetScor)<br />🚇 [💻](https://github.com/iGitScor/webpack-content-replacer-plugin/commits?author=iGitScor) [📖](https://github.com/iGitScor/webpack-content-replacer-plugin/commits?author=iGitScor) [⚠️](https://github.com/iGitScor/webpack-content-replacer-plugin/commits?author=iGitScor) 👀 | [<img src="https://avatars0.githubusercontent.com/u/14843447?v=3" width="100px;"/><br /><sub>YQBird</sub>](https://github.com/YQBird)<br />[📖](https://github.com/iGitScor/webpack-content-replacer-plugin/commits?author=YQBird) [⚠️](https://github.com/iGitScor/webpack-content-replacer-plugin/commits?author=YQBird) 👀 |
| :---: | :---: |

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

## Licensing

The code in this project is licensed under MIT license.

[build-badge]: https://img.shields.io/travis/iGitScor/webpack-content-replacer-plugin.svg?style=flat-square
[build]: https://travis-ci.org/iGitScor/webpack-content-replacer-plugin
[codecoverage-badge]: https://codecov.io/gh/iGitScor/webpack-content-replacer-plugin/branch/master/graph/badge.svg?style=flat-square
[codecoverage]: https://codecov.io/gh/iGitScor/webpack-content-replacer-plugin
[dependencyci-badge]: https://dependencyci.com/github/iGitScor/webpack-content-replacer-plugin/badge?style=flat-square
[dependencyci]: https://dependencyci.com/github/iGitScor/webpack-content-replacer-plugin
[dependencies-badge]: https://david-dm.org/iGitScor/webpack-content-replacer-plugin/status.svg?style=flat-square
[dependencies]: https://david-dm.org/iGitScor/webpack-content-replacer-plugin
[devDependencies-badge]: https://david-dm.org/iGitScor/webpack-content-replacer-plugin/dev-status.svg?style=flat-square
[devDependencies]: https://david-dm.org/iGitScor/webpack-content-replacer-plugin?type=dev
[node-badge]: https://img.shields.io/node/v/webpack-content-replacer-plugin.svg?style=flat-square
[license-badge]: https://img.shields.io/npm/l/webpack-content-replacer-plugin.svg?style=flat-square
[license]: https://github.com/iGitScor/webpack-content-replacer-plugin/blob/master/LICENSE

webpack-content-replacer-plugin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README