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: Convert Standard to eslint-config-standard #1328

Merged
merged 5 commits into from
Nov 17, 2020

Conversation

nschonni
Copy link
Contributor

@nschonni nschonni commented Nov 13, 2020

Why:

Standard is a wrapper of opionated ESLint rules. By using the direct ESLint config, there is better integration with IDEs for showing ESLint errors while maintaining the existing style preference. Also can drop some of the JSX related dependencies that are bundled as part of the larger standard package.

What's being changed:

  • Remove the standard package and replace with the ESLint packages for standard
  • Fix issues flagged from going from older version of standard to latest ESLint+Standard
  • Update calls to standard in the CI to use ESLint

Check off the following:

@nschonni nschonni requested a review from a team as a code owner November 13, 2020 23:36
@nschonni nschonni changed the title chore: Converte Standard to eslint-config-standard chore: Convert Standard to eslint-config-standard Nov 14, 2020
@@ -146,13 +150,6 @@
"node": "12 - 14"
},
"repository": "https://github.com/github/docs",
"standard": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious about thoughts on including the eslint config and ignore in package.json instead of as separate files.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the separate ignore file usually has better performance, but I've not looked at using the inline config in package.json before

Copy link
Contributor

@heiskr heiskr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a good change to me and one that I've run into personally.

@janiceilene janiceilene added the engineering Will involve Docs Engineering label Nov 17, 2020
@chiedo
Copy link
Contributor

chiedo commented Nov 17, 2020

@nschonni thanks for creating this! Can you resolve the conflicts 🙏🏿

@nschonni
Copy link
Contributor Author

@chiedo done!

@chiedo
Copy link
Contributor

chiedo commented Nov 17, 2020

Just want one more review on this one! @JasonEtco can you please review!

Copy link
Contributor

@JasonEtco JasonEtco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks for all the improvements here (and everywhere else) @nschonni!

@JasonEtco JasonEtco merged commit b6de7c6 into github:main Nov 17, 2020
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engineering Will involve Docs Engineering
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants