Eslint Phpstorm

1. Phpstorm Eslint Prettier
2. Eslint Phpstorm Example
3. Phpstorm Eslint Vue
4. Phpstorm Eslint On Save

If someone else finds this useful or faces the same issue, the workaround is to trigger it on file save action: Go to Settings - Keymap - type eslint - now double click on Fix ESLint Problems - Add Keyboard Shortcut - press CTRL + S. Confirm, it will ask about the other mappings to the given combination - Choose 'leave' and then Ok and exit. If someone else finds this useful or faces the same issue, the workaround is to trigger it on file save action: Go to Settings - Keymap - type eslint - now double click on Fix ESLint Problems - Add Keyboard Shortcut - press CTRL + S. Confirm, it will ask about the other mappings to the given combination - Choose 'leave' and then Ok and exit. Linting is the process of running your code through a tool to analyse for potential errors. Linting isn't language specific and can be customised on a per project basis to ensure code quality. This plugin adds support for Prettier (an opinionated code formatter. Is 'Apply ESLint COde Style Rule' applied for current project configuration or IDE? It changes current project configuration Does it work with 'vue:recommended' extends option? I've read in somewhere that it's needed put in 'plugin' options 'vue' and/or 'import' in order to the IDE works, is that true? Yes, you need to have 'vue' added to 'plugins' in your.eslintrc to make.

Using Prettier in WebStorm

Use the Reformat with Prettier action (Opt-Shift-Cmd-P on macOS or Alt-Shift-Ctrl-P on Windows and Linux) to format the selected code, a file, or a whole directory.

To run Prettier on save in WebStorm 2020.1 or above, open Preferences | Languages & Frameworks | JavaScript | Prettier and enable the option Run on save for files.

By default, only JavaScript and TypeScript files will be formatted automatically. You can further configure what files will be updated using the glob pattern.

Don't forget to install Prettier first.

To use Prettier in IntelliJ IDEA, PhpStorm, PyCharm, and other JetBrains IDEs, please install this plugin.

To run Prettier on save in older IDE versions, you can set up a file watcher following the instructions below.

Running Prettier on save using File Watcher

To automatically format your files using Prettier on save in WebStorm 2019.* or earlier, you can use a File Watcher.

Go to Preferences | Tools | File Watchers and click + to add a new watcher.

In Webstorm 2018.2, select Prettier from the list, review the configuration, add any additional arguments if needed, and click OK.

In older IDE versions, select Custom and do the following configuration:

• Name: Prettier or any other name
• File Type: JavaScript (or Any if you want to run Prettier on all files)
• Scope: Project Files
• Program: full path to .bin/prettier or .binprettier.cmd in the project's node_module folder. Or, if Prettier is installed globally, select prettier on macOS and Linux or C:Usersuser_nameAppDataRoamingnpmprettier.cmd on Windows (or whatever npm prefix -g returns).
• Arguments: --write [other options] $FilePath$
• Output paths to refresh: $FilePathRelativeToProjectRoot$
• Working directory: $ProjectFileDir$
• Environment variables: add COMPILE_PARTIAL=true if you want to run Prettier on partials (like _component.scss)
• Auto-save edited files to trigger the watcher: Uncheck to reformat on Save only.

Using Prettier with ESLint

If you are using ESLint with eslint-plugin-prettier, use the Fix ESLint Problems action to reformat the current file – find it using Find Action (Cmd/Ctrl-Shift-A) or add a keyboard shortcut to it in Preferences | Keymap and then use it.

Make sure that the ESLint integration is enabled in Preferences | Languages & Frameworks | JavaScript | Code Quality Tools | ESLint.

Using Prettier as External Tool

Go to Preferences | Tools | External Tools and click + to add a new tool. Let's name it Prettier.

• Program: prettier on macOS and Linux or C:Usersuser_nameAppDataRoamingnpmprettier.cmd on Windows (or whatever npm prefix -g returns), if Prettier is installed globally
• Parameters: --write [other options] $FilePath$
• Working directory: $ProjectFileDir$

If Prettier is installed locally in your project, replace the path in Program with $ProjectFileDir$/node_modules/.bin/prettier on macOS and Linux or $ProjectFileDir$node_modules.binprettier.cmd on Windows.

Press Cmd/Ctrl-Shift-A (Find Action), search for Prettier, and then hit Enter.

It will run Prettier for the current file.

You can add a keyboard shortcut to run this External tool configuration in Preferences | Keymap.

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 as well as lint your TypeScript code.

Besides JavaScript and TypeScript, ESLint can be applied to files of other types in the entire project or in its specific parts, see Configure linting scope.

Before you start

1. Download and install Node.js.

2. Make sure a local Node.js interpreter is configured in your project: open the Settings/Preferences dialog Ctrl+Alt+S and go to Languages and Frameworks | Node.js and NPM. The Node Interpreter field shows the default project Node.js interpreter.

   Learn more from Configuring a local Node.js interpreter.

Install ESLint

1. In the embedded Terminal (Alt+F12), type one of the following commands:

   • npm install --g eslint for global installation.

   • npm install --save-dev eslint to install ESLint as a development dependency.

2. Optionally, install additional plugins, for example, eslint-plugin-react to lint React applications.

Activate and configure ESLint in PhpStorm

By default, ESLint is disabled. You can choose to configure it automatically or specify all the configuration settings manually.

Configure ESLint automatically

With automatic configuration, PhpStorm uses the ESLint package from the project node_modules folder and the .eslintrc.* configuration file from the folder where the current file is stored. If no .eslintrc.* 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.

• To configure ESLint automatically in the current project, open the Settings/Preferences dialog Ctrl+Alt+S, go to Languages and Frameworks | JavaScript | Code Quality Tools | ESLint, and select the Automatic ESLint configuration option.

• To configure ESLint automatically in all new projects, open the Settings for New Projects dialog (File | Settings for New Projects), go to Languages and Frameworks | JavaScript | Code Quality Tools | ESLint, and select the Automatic ESLint configuration option.

Configure ESLint manually

With manual configuration, you can use a custom ESLint package, configuration file, and working directories, as well as apply various additional rules and options.

1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Languages and Frameworks | JavaScript | Code Quality Tools | ESLint, and select Manual ESLint configuration.

2. In the ESLint package field, specify the location of the eslint or standard package.

3. In the Working directories field, specify the working directories for the ESLint process.

   By default the field is empty and PhpStorm detects the working directory automatically. First it looks for a directory closest to the linted file which contains a .eslintignore or .eslintrc.* file, or a package.json file with either a eslintIgnore or a eslintConfig property.

   If the auto-detected working directory doesn't match your project configuration, you need to specify the working directory (directories) manually. Use semicolons as separators. The acceptable values are:

   • Absolute paths.

   • Paths relative to the project base directory (the parent folder of the .idea folder where PhpStorm-specific project metadata is stored). For example:

     • ./- use project base directory as ESLint process working directory.

     • client;server- use the /client and /server as working directories. For files that are neither under the client not under the server folder, the working directory will be auto-detected as described above.

     • packages/*- each subfolder of the /packages folder will be used as the working directory for the corresponding linted files.

   • Paths relative to the content roots can be used if some linted files are not under project base directory in the folder hierarchy.

   • Glob patterns that define relative paths to the working directories. For example, with **/foo -* each folder with the name starting with foo- will be used as the working directory for the corresponding linted files.

4. Choose the configuration to use.

   • Automatic search- select this option if ESLint rules are configured in your a package.json or in a .eslintrc.* file. This can be a .eslintrc, .eslintrc.json, or .eslintrc.yaml file, or a file in another supported format, see the ESLint official website for details.

     PhpStorm looks for a .eslintrc.* file or for a eslintConfig property in a package.json. PhpStorm starts the search from the folder where the file to be checked is stored, then searches in its parent folder, and so on until the project root is reached.

   • Configuration File- select this option to use a custom file and specify the file location in the Path field.

   Learn more about configuring ESLint from the ESLint official website.

5. Optionally:

   • In the Extra eslint options field, specify additional command-line options to run ESLint with, use spaces as separators.

     Learn more about ESLint CLI options from the ESLint official website.

   • 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 package.json, .eslintrc.*, or a custom configuration file and accordingly will override them.

     See the ESLint official website for more information about ESLint configuration files and adding rules.

Configure linting scope

1. Open the Settings/Preferences dialog Ctrl+Alt+S, go to Languages and Frameworks | JavaScript | Code Quality Tools | ESLint, and select Automatic ESLint configuration or Manual ESLint configuration.

2. In the Run for files field, specify the pattern that defines the set of files to be linted. You can accept the default pattern or type a custom one.

   With the default pattern, {**/*,*}.{js,ts,jsx,tsx,html,vue}, ESLint will wake up and process any updated JavaScript, TypeScript, JSX, TSX, HTML, or Vue file. To lint files of other types or files stored in specific folders, use glob patterns to update the default pattern.

   • For example, to automatically reformat CoffeeScript files as well, add coffee to the default pattern as follows:

   • To lint files from a specific folder, replace {**/*,*} with *.

     Suppose, you have a project with the following structure:

     To lint only the files in the coffee folder, update the pattern as follows:

     coffee/*.{js,ts,jsx,tsx,html,vue,coffee}

     As a result, the file linting.coffee will be linted while no_linting.coffee will not.

Fix problems automatically on save

ESLint can fix the detected problems every time your changes are saved either manually, with Ctrl+S, or automatically, when you launch a run/debug configuration, or close PhpStorm, or perform version control actions, see Autosave for details.

• Open the Settings/Preferences dialog Ctrl+Alt+S, go to Languages and Frameworks | JavaScript | Code Quality Tools | ESLint, and select the Run eslint --fix on save checkbox.

Lint your code

When installed and enabled, ESLint activates automatically every time you open a JavaScript file.

By default, PhpStorm marks detected problems based on the severity levels from the ESLint configuration. See Configuring ESLint highlighting to learn how to override these settings.

Descriptions of the errors detected in the current file and quick-fixes for them are available from the editor and from the Current File tab of the Problems tool window.

Errors in all previously opened files and quick-fixes for them are shown in the Project Errors tab of the Problems tool window. To open the tool window, click the Inspection widget in the upper-right corner of the editor:

See View problems and apply quick-fixes in the editor and Problems tool window for details.

View problems and apply quick-fixes in the editor

• To view the description of a problem, hover over the highlighted code.

  To resolve the detected problem, click ESLint: Fix '' or press Alt+Shift+Enter.

  To resolve all the detected problems in the current file, click More actions (Alt+Enter) and select ESLint: Fix current file from the list.

  See View problems and apply quick-fixes in the editor for details.

• Alternatively open the Current File tab of the Problems tool window Alt+6, where you can view problem descriptions, apply quick-fixes, navigate to the fragments in the source code where errors occurred, as well as fix them in the Editor Preview pane without leaving the tool window. Learn more from Problems tool window.

• You can also configure ESLint to fix all the problems in a file when this file is saved. To configure such behavior, select the Run eslint --fix on save checkbox on the ESLint page of the Settings dialog as described in Activating and configuring ESLint in PhpStorm.

Phpstorm Eslint Prettier

Lint your code in the Problems tool window

To open the Problems tool window, click the Inspections widget in the upper-right corner of the editor.

Alternatively select View | Tool windows | Problems from the main menu or press Alt+6.

The Project Errors tab shows the errors in all files that were opened during the current session, with error messages grouped by files in which they were detected.

Here you can view problem descriptions, apply quick-fixes, navigate to the fragments in the source code where errors occurred, as well as fix them in the Editor Preview pane without leaving the tool window. Learn more from Problems tool window.

Configure 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. See Code inspections and Change inspection severity for details.

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 1warn or to 2error.

  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.

Ignore the severity levels from the configuration

1. In the Settings/Preferences dialog Ctrl+Alt+S, select Editor | Inspections. The Inspections page opens.

2. In the central pane, go to JavaScript | Code quality tools | ESLint.

3. 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.

Import 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:

Use 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.

Install JavaScript Standard

• In the embedded Terminal (Alt+F12), type:

  npm install standard --save-dev

  Learn more from the JavaScript Standard Style official website.

Eslint Phpstorm Example

Enable linting with Standard via ESLint

If you open a project where standard is listed in the project's package.json file, PhpStorm enables linting with Standard automatically.

1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Languages and Frameworks | JavaScript | Code Quality Tools | ESLint.

2. On the ESLint page that opens, select Manual ESLint configuration and specify the location of the standard package in the ESLint Package field.

Phpstorm Eslint Vue

Set the JavaScript Standard Style as default

Phpstorm Eslint On Save

1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | Code Style | JavaScript.

2. On the Code Style. JavaScript page that opens, click Set from, and then select JavaScript Standard Style. The style will replace your current scheme.