[doc] TargetableModule.spliceSource() examples and debugging instructions #3168
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
jcalcaben
added
pkg:pwa-devdocs
documentation
|
jimbo
approved these changes
May 12, 2021
| | `before` | string | Code changes are applied at the start of this string in the code | | ||
| | `after` | string | Code changes are applied to the end of this string in the code | | ||
|
|
||
| Instruction objects can only have **one** location property (`at`, `before`, `after`), but one or both action properties (`insert`, `remove`). |
There was a problem hiding this comment.
Good note; this wouldn't necessarily be obvious.
| ### Splice code using instructions | ||
|
|
||
| The `spliceSource()` function is a low level code modification function that apply changes based on an instruction object. | ||
| The `insertAfterSource()`, `insertBeforeSource()`, and `prependSource()` functions provide a simpler interface and are [facade functions][] for `spliceSource()`. |
There was a problem hiding this comment.
Good to recommend the sweeter syntax. 👍
m2-community-project
bot
added
Progress: approved
and removed
Progress: ready for review
labels
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.
Description
Adds examples for using the
TargetableModule.spliceSource()function as well as debugging instructions.Related Issue
Closes PWA-1710 and Closes #3155
Acceptance
Any core developer
@Jordaneisenburger (optional)
Verification Stakeholders
Any core developer
@Jordaneisenburger (optional)
Specification
Verification Steps
cd pwa-devdocsyarn develop/pwa-buildpack/reference/targetables/TargetableModule/Screenshots / Screen Captures (if appropriate)
Checklist