Fix broken terminal links with zero width spaces #995
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
|
Thanks for your contribution! Depending on what you are working on, you may want to request a review from a Shopify team:
|
Coverage report
Test suite run success881 tests passing in 455 suites. Report generated by 🧪jest coverage report action from bb4f83d |
This comment has been minimized.
This comment has been minimized.
isaacroldan
requested review from
a team,
matteodepalo and
pepicrft
and removed request for
a team
alvaro-shopify
approved these changes
Jan 3, 2023
pepicrft
reviewed
Jan 3, 2023
| return terminalLink(colors.green(stringifyMessage(this.value)), this.link ?? '') | ||
| const text = colors.green(stringifyMessage(this.value)) | ||
| const url = this.link ?? '' | ||
| return terminalLink(text, url, {fallback: () => `${text} ( ${url} )`}) |
There was a problem hiding this comment.
I'd add a test that captures why the parenthesis is needed:
test("the link includes spaces between the URL and the parenthesis for command/control click to work", () => {
// ...
})There was a problem hiding this comment.
you're right, added
pepicrft
approved these changes
Jan 3, 2023
Benchmark reportThe following table contains a summary of the startup time for all commands.
|
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.
WHY are these changes introduced?
The
terminal-linkdependency adds a zero width space character to links.Why?
Because if you show something like
(https://shopify.com), the terminal will interpret that the last parenthesis is part of the URL likehttps://shopify.com)and that will break it. So you need to add a space before the parenthesis for it to work, like:( https://shopify.com )if you make that space then a zero-width space, it will look like there is nothing :)BUT
The terminal will assume the space is part of the URL and although most webs will ignore it, some won't (the link to the chrome store for the post purchase extension is broken because of this)
This is a known issue of
terminal-linkthat was reported a year ago but hasn't been fixed yet (not sure there is a fix possible...)Fixes #991
WHAT is this pull request doing?
Add a normal space in the URLs instead of a zero-width one
BEFORE:
AFTER:
How to test your changes?
devand links to the post-purchase chrome extension should workMeasuring impact
How do we know this change was effective? Please choose one:
Checklist
devordeployhave been reflected in the internal flowchart.