-
-
Notifications
You must be signed in to change notification settings - Fork 26.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Suggest to create .eslintrc for IDE lint plugins (#2054)
* Suggest to create .eslintrc for IDE lint plugins * Update README.md * Update README.md
- Loading branch information
Showing
1 changed file
with
6 additions
and
32 deletions.
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 | ||
|
||
|