Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Format style guide links so they can be clicked #12189

Merged
merged 3 commits into from Nov 13, 2019

Conversation

@ivandotv
Copy link
Contributor

ivandotv commented Aug 30, 2019

What is the purpose of this pull request? (put an "X" next to item)

[ x ] Other, please explain:

What changes did you make? (Give an overview)

When initializing new eslint project and coming to style guide step, visual studio code terminal doesn't properly format style guide links so when user clicks on one of the links (in the terminal) it takes them to e.q https://github.com/airbnb/javascript) (note the ) at the end)
Putting spaces after the opening brace and before the closing brace fixes this issue.
Is there anything you'd like reviewers to focus on?
No

ivandotv added 2 commits Aug 30, 2019
When using the initializer and coming to style guide step, visual studio code terminal doesn't properly format style guide links so when user clicks on one of the links it takes them to e.q `https://github.com/airbnb/javascript)` (note the `)` at the end) 
Putting spaces between links and opening and closing braces fixes this.
Properly format styleguide links so they can be clicked
@jsf-clabot
Copy link

jsf-clabot commented Aug 30, 2019

CLA assistant check
All committers have signed the CLA.

@eslint eslint bot added the triage label Aug 30, 2019
@ivandotv ivandotv changed the title Format style guide links so they can be clicked Chore: Format style guide links so they can be clicked Aug 30, 2019
@platinumazure
Copy link
Member

platinumazure commented Aug 30, 2019

Hi @ivandotv, thanks for the PR.

Wouldn't it be better to resolve this in Visual Studio Code? I'm not sure https://github.com/airbnb/javascript) is even a valid URL.

@ivandotv
Copy link
Contributor Author

ivandotv commented Aug 31, 2019

Clicking the airbnb link goes to 404 page on github.com
I can confirm that linux terminals recognize the url properly, so this is vscode editor issue (maybe some other editors too)
However many other npm modules are aware of this issue and they put spaces around links.

@ilyavolodin
Copy link
Member

ilyavolodin commented Sep 14, 2019

I think I'd be fine with this fix. It's so minor, it's not worth trying to push it off to VSCode (although it should also be reported there as well).

@mysticatea mysticatea added accepted cli and removed triage labels Sep 14, 2019
@platinumazure
Copy link
Member

platinumazure commented Sep 14, 2019

I just think spaces in parentheses are kind of ugly. Can we come up with another approach here? Maybe remove the parentheses altogether and use some other approach?

Copy link
Member

platinumazure left a comment

Is there another approach we could take here? I don't really like this approach.

Are the URLs critical? What if we removed them entirely (but provided them some other way)? Or, could we use a different punctuator that VSCode won't trip on?

@g-plane
Copy link
Member

g-plane commented Sep 29, 2019

We can use colon.

Screenshots:
图片

图片

Links can be detected properly.

@ivandotv
Copy link
Contributor Author

ivandotv commented Sep 30, 2019

I also like it more with the colon.
Should I make the change?

@g-plane
Copy link
Member

g-plane commented Sep 30, 2019

Feel free to do it!

Remove braces around links and add a colon at the beginning.
Copy link
Member

platinumazure left a comment

LGTM, thanks!

Copy link
Member

g-plane left a comment

LGTM, thanks!

@aladdin-add aladdin-add merged commit a477707 into eslint:master Nov 13, 2019
9 checks passed
9 checks passed
commit-message PR title follows commit message guidelines
Details
continuous-integration Build #20190930.1 succeeded
Details
continuous-integration (Test on Node.js 10 (Linux)) Test on Node.js 10 (Linux) succeeded
Details
continuous-integration (Test on Node.js 12 (Linux)) Test on Node.js 12 (Linux) succeeded
Details
continuous-integration (Test on Node.js 12 (Windows)) Test on Node.js 12 (Windows) succeeded
Details
continuous-integration (Test on Node.js 12 (macOS)) Test on Node.js 12 (macOS) succeeded
Details
continuous-integration (Test on Node.js 8 (Linux)) Test on Node.js 8 (Linux) succeeded
Details
licence/cla Contributor License Agreement is signed.
Details
release-monitor No patch release is pending
Details
@aladdin-add
Copy link
Member

aladdin-add commented Nov 13, 2019

merged, thanks for contributing!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

8 participants
You can’t perform that action at this time.