-
-
Notifications
You must be signed in to change notification settings - Fork 26.9k
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
Suggest to create .eslintrc for IDE lint plugins #2054
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -207,50 +207,24 @@ To configure the syntax highlighting in your favorite text editor, head to the [ | |
|
||
## Displaying Lint Output in the Editor | ||
|
||
>Note: this feature is available with `[email protected]` and higher. | ||
>Note: this feature is available with `[email protected]` and higher. | ||
>It also only works with npm 3 or higher. | ||
|
||
Some editors, including Sublime Text, Atom, and Visual Studio Code, provide plugins for ESLint. | ||
|
||
They are not required for linting. You should see the linter output right in your terminal as well as the browser console. However, if you prefer the lint results to appear right in your editor, there are some extra steps you can do. | ||
|
||
You would need to install an ESLint plugin for your editor first. | ||
|
||
>**A note for Atom `linter-eslint` users** | ||
|
||
>If you are using the Atom `linter-eslint` plugin, make sure that **Use global ESLint installation** option is checked: | ||
|
||
><img src="http://i.imgur.com/yVNNHJM.png" width="300"> | ||
|
||
|
||
>**For Visual Studio Code users** | ||
|
||
>VS Code ESLint plugin automatically detects Create React App's configuration file. So you do not need to create `eslintrc.json` at the root directory, except when you want to add your own rules. In that case, you should include CRA's config by adding this line: | ||
|
||
>```js | ||
>{ | ||
> // ... | ||
> "extends": "react-app" | ||
>} | ||
>``` | ||
|
||
Then add this block to the `package.json` file of your project: | ||
You would need to install an ESLint plugin for your editor first. Then, add a file called `.eslintrc` to the project root: | ||
|
||
```js | ||
{ | ||
// ... | ||
"eslintConfig": { | ||
"extends": "react-app" | ||
} | ||
"extends": "react-app" | ||
} | ||
``` | ||
|
||
Finally, you will need to install some packages *globally*: | ||
|
||
```sh | ||
npm install -g [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] | ||
``` | ||
Now your editor should report the linting warnings. | ||
|
||
We recognize that this is suboptimal, but it is currently required due to the way we hide the ESLint dependency. The ESLint team is already [working on a solution to this](https://github.com/eslint/eslint/issues/3458) so this may become unnecessary in a couple of months. | ||
Note that even if you edit your `.eslintrc` file further, these changes won’t affect the terminal and in-browser lint output. This is because Create React App intentionally provides a minimal set of rules that find common mistakes. If you want to enforce a coding style for your project, consider using [Prettier](https://github.com/jlongster/prettier) instead of ESLint style rules. | ||
|
||
## Debugging in the Editor | ||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this be
.eslintrc.json
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are many options.
http://eslint.org/docs/user-guide/configuring#configuration-file-formats
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're explicitly recommending a json format, but I didn't know if this matters.
The docs says JSON is fine in this file, but it is deprecated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need to list them in readme too? but I think .eslintrc is the most widely used
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm cool with changing to whatever but I have a hunch some editor plugins only know about
.eslintrc
and don't read other files. Happy to change to anything that's supported by most IDE plugins though!There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes me too. as long as it goes towards our goal (shows linting in editor)