docs(sed): document sed syntax, quoting, and escaping slash #170
Conversation
This file contains hidden or 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
No change to logic, only docs. This documents the special sed syntax (ex. `shx sed s/foo/bar/g filename.txt`). With that, this mentions that `/` is a special character, so the user must escape that if it's present in either the regex or replacement string. This also documents how Windows handles single quotes differently, so it's desirable to avoid single quotes in package.json scripts. This part isn't specific to sed, but since it's popular to quote sed expressions, I'm adding this to the docs at the same time. Fixes #165 Fixes #169
Codecov Report
@@ Coverage Diff @@
## master #170 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 5 5
Lines 114 114
=====================================
Hits 114 114Continue to review full report at Codecov.
|
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.
No change to logic, only docs.
This documents the special sed syntax (ex.
shx sed s/foo/bar/g filename.txt). With that, this mentions that/is a specialcharacter, so the user must escape that if it's present in either the
regex or replacement string.
This also documents how Windows handles single quotes differently, so
it's desirable to avoid single quotes in package.json scripts. This part
isn't specific to sed, but since it's popular to quote sed expressions,
I'm adding this to the docs at the same time.
Fixes #165
Fixes #169