Document and test options to createPatch #345
Merged
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.
The documentation states that createPatch only supports
context
, when in actuality it passes the options on to the diffLines implementation.This PR updates the documentation to clarify this and also adds tests to verify this behavior.
Since these methods are supposed to output a patch, it's arguable that the options doesn't make sense, but I'd argue that the
ignoreWhitespace
at least makes sense since outputting a patch is a pretty normalized way to display a diff and it makes sense to be able to use the existing options for it.newLineIsToken
is a bit weirder when creating "patches". I added docs and tests for that in separate commit so that it can be reverted if it's something that is not wanted.