doc: clarify escaping for ES modules #41074
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
nodejs-github-bot
added
doc
jasnell
reviewed
Dec 3, 2021
doc/api/esm.md
Outdated
| @@ -156,7 +156,7 @@ typically configured server. | |||
| ### URLs | |||
|
|
|||
| ES modules are resolved and cached as URLs. This means that files containing | |||
| special characters such as `#` and `?` need to be escaped. | |||
| special characters need to be replaced with escape sequences, such as `#` with `%23` and `?` with `%3F`. | |||
There was a problem hiding this comment.
Suggested change
| special characters need to be replaced with escape sequences, such as `#` with `%23` and `?` with `%3F`. | |
| special characters must be [percent-encoded][], such as `#` with `%23` and `?` with `%3F`. |
Then add a new reference at the bottom of the esm.md to:
[percent-encoded]: url.md#percent-encoding-in-urls
There was a problem hiding this comment.
Maybe either the bit being changed or the percent-encoding-in-urls section of url.md could point to encodeURIComponent()?
There was a problem hiding this comment.
Maybe either the bit being changed or the
percent-encoding-in-urlssection ofurl.mdcould point toencodeURIComponent()?
Or https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding?
There was a problem hiding this comment.
I'd say the link to url.md#percent-encoding-in-urls suffices here.
The other links could then be referenced in url.md#percent-encoding-in-urls. (https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding and https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent)
|
cc @nodejs/modules |
Trott
reviewed
Dec 3, 2021
doc/api/esm.md
Outdated
Comment on lines
158
to
159
| ES modules are resolved and cached as URLs. This means that files containing | ||
| special characters such as `#` and `?` need to be escaped. |
There was a problem hiding this comment.
FWIW, the word escape does not appear in the relevant MDN doc, so maybe "encoded" is the way to go instead of "escaped" or "replaced with escape sequences". Also, and I know this wasn't introduced in this PR, but "files containing" makes it sound we're talking about the file contents when we're talking about the URL.
Suggested change
| ES modules are resolved and cached as URLs. This means that files containing | |
| special characters such as `#` and `?` need to be escaped. | |
| ES modules are resolved and cached as URLs. This means that characters such as | |
| `#` and `?` need to be [percent-encoded][]. |
Then add to the bottom:
[percent-encoding]: https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding
notroid5
changed the title
This should make it clear(er) how to escape special characters like `#` and `?`. Ref: #41052
aduh95
approved these changes
Dec 4, 2021
Trott
changed the title
Trott
added
the
author ready
lpinca
approved these changes
Dec 4, 2021
aduh95
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in 3d5a7de |
danielleadams
pushed a commit
that referenced
this pull request
Dec 13, 2021
This should make it clear(er) how to escape special characters like `#` and `?`. Ref: #41052 PR-URL: #41074 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
danielleadams
pushed a commit
that referenced
this pull request
Dec 14, 2021
This should make it clear(er) how to escape special characters like `#` and `?`. Ref: #41052 PR-URL: #41074 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
danielleadams
pushed a commit
that referenced
this pull request
Jan 31, 2022
This should make it clear(er) how to escape special characters like `#` and `?`. Ref: #41052 PR-URL: #41074 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
danielleadams
pushed a commit
that referenced
this pull request
Jan 31, 2022
This should make it clear(er) how to escape special characters like `#` and `?`. Ref: #41052 PR-URL: #41074 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Linkgoron
pushed a commit
to Linkgoron/node
that referenced
this pull request
Jan 31, 2022
This should make it clear(er) how to escape special characters like `#` and `?`. Ref: nodejs#41052 PR-URL: nodejs#41074 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
danielleadams
pushed a commit
that referenced
this pull request
Feb 1, 2022
This should make it clear(er) how to escape special characters like `#` and `?`. Ref: #41052 PR-URL: #41074 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Merged
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.
Change proposed according to #41052
This should make it clear how to escape special characters like
#.I don't know if there are any more, though.
Also, how you would call this in general?
I found it as "Javascript Escape Sequence", is this a known term?
(Also, the first link below contains a dot at the end:
https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md.That should probably be removed.)
Edit: Changed text slightly, so the next check should be successful.