[plugin-replace] Document the values option
#814
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shellscape
reviewed
Feb 22, 2021
packages/replace/README.md
Outdated
| 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: |
There was a problem hiding this comment.
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: |
shellscape
reviewed
Feb 22, 2021
packages/replace/README.md
Outdated
Comment on lines
129
to
131
|
|
||
| // ⬇ ⬇ ⬇ ⬇ ⬇ ⬇ ⬇ ⬇ ⬇ | ||
|
|
There was a problem hiding this comment.
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
|
Thanks for the PR, a few comments to address but looks solid. |
|
Updated! Sorry it took three commits, I was trying to do it through the GH ui 😅 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rollup Plugin Name:
replaceThis PR contains:
Are tests included?
Breaking Changes?
If yes, then include "BREAKING CHANGES:" in the first commit message body, followed by a description of what is breaking.
List any relevant issue numbers:
Description
I discovered this option because it was used in the
preventAssignmentexample, but it wasn't documented.I got the option type from the
.d.tsfile.