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

Updated es-lint docs to instruct how to install eslint-config-react-app #12998

Merged
merged 6 commits into from
Apr 2, 2019

Conversation

lukebrobbs
Copy link
Contributor

Description

  • Updated es-lint docs to recommend using eslint-config-react-app
  • Removed extra documentation to make the instructions a little more focused.

Related Issues

#12980

@lukebrobbs lukebrobbs requested a review from a team April 1, 2019 19:54
Copy link
Contributor

@KyleAMathews KyleAMathews left a comment

Choose a reason for hiding this comment

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

Thanks for jumping on this!

docs/docs/eslint.md Outdated Show resolved Hide resolved
docs/docs/eslint.md Outdated Show resolved Hide resolved
Copy link
Contributor

@dakebl dakebl left a comment

Choose a reason for hiding this comment

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

Might be worth mentioning and linking the shipped ESLint file here too for reference. So that developers are aware that a more complex version exists internally: https://github.com/gatsbyjs/gatsby/blob/master/.eslintrc.json

Copy link
Contributor

@KyleAMathews KyleAMathews left a comment

Choose a reason for hiding this comment

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

Tweaked the copy some to remove mentions of Prettier and to be more direct that Gatsby ships with .eslintrc and you add your own config file only if you want to modify that.

Thanks @lukebrobbs!

@KyleAMathews KyleAMathews merged commit c574964 into gatsbyjs:master Apr 2, 2019
@gatsbot
Copy link

gatsbot bot commented Apr 2, 2019

Holy buckets, @lukebrobbs — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

  1. We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. (Currently we’ve got a couple t-shirts available, plus some socks that are really razzing our berries right now.)
  2. We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. Accept the invite by visiting https://github.com/orgs/gatsbyjs/invitation. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!

@JDDoesDev
Copy link

I know this issue has been closed for a while, and I can open a new one if need be, but I find the language confusing on https://www.gatsbyjs.org/docs/eslint/

In the main section it says:

You’ll replicate (mostly) the ESLint config Gatsby ships with so you can then add additional presets, plugins, and rules.

but further down the page it says:

When you include a custom .eslintrc file, Gatsby gives you full control over the ESLint configuration. This means that it will override the built-in eslint-loader and you need to enable any and all rules yourself.

On first read-through, it appears to contradict the first statement and imply that by using the snippet on the page, you're losing out on all the things from the default config.

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

Successfully merging this pull request may close these issues.

4 participants