Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[plugin-replace] Document the values option #814

Merged
merged 5 commits into from Mar 10, 2021
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 23 additions & 0 deletions packages/replace/README.md
Expand Up @@ -114,6 +114,29 @@ Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should operate on. By default all files are targeted.

### `values`

Type: `{ [key: String]: Replacement }`, where `Replacement` is either a string or a `function` that returns a string.
Default: `{}`

To avoid mixing replacement strings with the other options, you can specify replacements in the `values` option:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To avoid mixing replacement strings with the other options, you can specify replacements in the `values` option:
To avoid mixing replacement strings with the other options, you can specify replacements in the `values` option. For example, the following signature:


```js
replace({
include: ["src/**/*.js"],
changed: "replaced"
});

// ⬇ ⬇ ⬇ ⬇ ⬇ ⬇ ⬇ ⬇ ⬇

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// ⬇ ⬇ ⬇ ⬇ ⬇ ⬇ ⬇ ⬇ ⬇
Can be replaced with:

I'm not sure how to suggest code fence / backticks on here, but please separate the two signatures in their own code blocks

replace({
include: ["src/**/*.js"],
values: {
changed: "replaced"
}
});
```

## Word Boundaries

By default, values will only match if they are surrounded by _word boundaries_.
Expand Down