# autogit-plugin-replace

> A plugin for performing string replacements.

Latest version **1.0.2** (published 2018-12-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install autogit-plugin-replace
pnpm add autogit-plugin-replace
yarn add autogit-plugin-replace
bun add autogit-plugin-replace
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-12-06 |
| First published | 2018-10-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 14.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Fabio Spampinato |
| Maintainers | fabiospampinato |
| Keywords | autogit, plugin, string, replace |

## Links

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

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [@types/node](https://npm.io/package/@types/node.md) ^10.12.8
- [string-matches](https://npm.io/package/string-matches.md) ^1.1.0

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2018-12-06
- 1.0.1 — 2018-11-12
- 1.0.0 — 2018-10-17

## README

# Autogit Plugin - Replace

A plugin for performing string replacements.

## Install

```sh
npm install --save autogit-plugin-replace
```

## Usage

#### Options

This plugin uses the following options object:

```js
{
  paths: [], // Array of relative paths to the files that will be replaced
  replacements: [] // Array or arguments to pass to `String.prototype.replace`
}
```

#### Configuration

Add this plugin to a command:

```js
const replace = require ( 'autogit-plugin-replace' );

module.exports = {
  commands: {
    'my-command': [
      replace ({
        paths: ['readme.md'],
        replacements: [
          [/pulgin/g, 'plugin'],
          [/foo/g, 'bar']
        ]
      })
    ]
  }
}
```

## License

MIT © Fabio Spampinato

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