ESLint
PhpStorm integrates with ESLint which brings a wide range of linting rules that can also be extended with plugins. PhpStorm shows warnings and errors reported by ESLint right in the editor, as you type. With ESLint, you can also use JavaScript Standard Style.
To view the description of a problem, hover over the highlighted code.
Installing ESLint
-
In the embedded Terminal (Alt+F12), type one of the following commands:
-
npm install eslint -g
for global installation. -
npm install eslint --save-dev
to install ESLint as a development dependency.
-
-
Optionally, install additional plugins, for example, eslint-plugin-react to lint React applications.
Activating and configuring ESLint in PhpStorm
By default, PhpStorm uses the ESLint package from the project node_modules folder and the .eslint.* configuration file from the folder where the current file is stored. If no .eslint.* is found in the current file folder, PhpStorm will look for one in its parent folders up to the project root.
If you have several package.json files with ESLint listed as a dependency, PhpStorm starts a separate process for each package.json and processes everything below it. This lets you apply a specific ESLint version or a specific set of plugins to each path in a monorepo or a project with multiple ESLint configurations.
This behavior is default in all new PhpStorm projects. To enable it in a previously created project, go to Settings/Preferences dialog (Ctrl+Alt+S) and select the Automatic ESLint configuration option.
in theYou can also configure ESLint manually to use a custom ESLint package and configuration.
-
In the Settings/Preferences dialog (Ctrl+Alt+S), go to .
-
Select the Manual Configuration option to use a custom ESLint package and configuration.
-
In the Node Interpreter field, specify the path to Node.js. If you followed the standard installation procedure, PhpStorm detects the path and fills in the field itself.
-
In the ESLint Package field, specify the location of the eslint or standard package.
-
Choose the configuration to use.
-
With Automatic search, PhpStorm looks for a .eslintrc file or tries to detect a configuration defined under
eslintConfig
in a package.json. PhpStorm first looks for a .eslintrc or package.json in the folder with the file to be linted, then in its parent folder, and so on up to the project root. -
Choose Configuration File to use a custom file and specify the file location in the Path field.
-
-
Optionally:
-
In the Extra ESLint Options field, specify additional command line options to run ESLint with, use spaces as separators.
-
In the Additional Rules Directory field, specify the location of the files with additional code verification rules. These rules will be applied after the rules from .eslintrc or the above specified custom configuration file and accordingly will override them.
-
Configuring highlighting for ESLint
By default, PhpStorm marks the detected errors and warnings based on the severity levels from the ESLint configuration. For example, errors are highlighted with a red squiggly line, while warnings are marked with a yellow background.
To change the severity level of a rule in the ESLint configuration
In .eslintrc or under eslintConfig
in package.json, locate the rule you want to edit and set its ID to 1
(warn
) or to 2
(error
). Learn more from the ESLint official website.
You can override the severities from the ESLint configuration so that PhpStorm ignores them and shows everything reported by the linter as errors, warnings, or in a custom color.
To ignore the severity levels from the configuration
-
In the Settings/Preferences dialog (Ctrl+Alt+S), select . The Inspections page opens.
-
In the central pane, go to JavaScript | Code quality tools | ESLint.
-
In the right-hand pane, clear the Use rule severity from the configuration file checkbox and select the severity level to use instead of the default one.
Importing code style from ESLint
You can import some of the ESLint code style rules to the PhpStorm JavaScript code style settings. That enables PhpStorm to use more accurate code style options for your project when auto-completing, generating, or refactoring the code or adding import statements. When you use the Reformat action, PhpStorm will then no longer break properly formatted code from the ESLint perspective.
PhpStorm understands ESLint configurations in all official formats: .eslintrc JSON files, package.json files with the eslintConfig
field, as well as JavaScript and YAML configuration files.
When you open your project for the first time, PhpStorm imports the code style from the project ESLint configuration automatically.
-
If your ESLint configuration is updated (manually or from your version control), open it in the editor and choose Apply ESLint Code Style Rules from the context menu.
Alternatively, just answer Yes to the "Apply code style from ESLint?" question on top of the file.
The list of applied rules is shown in the Event log tool window:
Using JavaScript Standard Style
You can set JavaScript Standard Style as default JavaScript code style for your application so its main rules are applied when you type the code or reformat it. Since Standard is based on ESLint, you can also use Standard via the PhpStorm ESLint integration.
To install JavaScript Standard
In the embedded Terminal (Alt+F12), type:
npm install standard --save-dev
Learn more from the JavaScript Standard Style official website.
To enable linting with Standard via ESLint
-
In the Settings/Preferences dialog (Ctrl+Alt+S), go to .
-
On the ESLint page that opens, select Manual ESLint configuration and specify the location of the
standard
package in the ESLint Package field.
To set the JavaScript Standard Style as default
-
In the Settings/Preferences dialog (Ctrl+Alt+S), go to ).
-
On the Code Style. JavaScript page that opens, click Set from, and then select Predefined Style | JavaScript Standard Style. The style will replace your current scheme.
Linting TypeScript code with ESLint
PhpStorm highlights errors reported by ESLint in .ts and .tsx files when @typescript-eslint/parser
is set as a parser in your project ESLint configuration.
Learn more from the readme file in the typescript-eslint repo.
To use ESLint for TypeScript in a new project
-
In the embedded Terminal (Alt+F12), type:
npm install @typescript-eslint/parser @typescript-eslint/eslint-plugin --save-dev
-
In the .eslintrc configuration file or under
eslintConfig
in package.json, add:{ "parser": "@typescript-eslint/parser", "plugins": ["@typescript-eslint"], "extends": ["plugin:@typescript-eslint/recommended"] }
To suppress linting TypeScript code with ESLint
If you are already using @typescript-eslint/parser
but you do not want to check TypeScript code with ESLint, add .ts or .tsx to the .eslintignore file.
ESLint 4.0
If you are using previous versions of ESLint, you have to install babel-eslint
, typescript-eslint-parser
, or eslint-plugin-typescript
because ESLint 4.0 and earlier do not support scoped packages.
To use babel-eslint
-
In the embedded Terminal (Alt+F12), type:
npm install eslint babel-eslint --save-dev
-
In the .eslintrc configuration file or under
eslintConfig
in package.json, add:{ "parser":"babel-eslint" }
To use typescript-eslint-parser
-
In the embedded Terminal (Alt+F12), type:
npm install typescript-eslint-parser --save-dev
-
In the .eslintrc configuration file or under
eslintConfig
in package.json, add:{ "parser":"typescript-eslint-parser" }
To use eslint-plugin-typescript
-
In the embedded Terminal (Alt+F12), type:
npm install typescript-eslint-parser eslint-plugin-typescript --save-dev
-
In the .eslintrc configuration file or under
eslintConfig
in package.json, add:{ "parser": "typescript-eslint-parser", "plugins": ["eslint-plugin-typescript"] }