ESLint
CLion integrates with ESLint which brings a wide range of linting rules that can also be extended with plugins. CLion shows warnings and errors reported by ESLint right in the editor, as you type. With ESLint, you can also use JavaScript Standard Style.
Installing, enabling, and configuring ESLint in CLion
Open the built-in CLion Terminal (Alt+F12) and type
npm install eslint --save-dev
ornpm install eslint -g
at the command prompt.Optionally, install additional plugins, for example, eslint-plugin-react to lint React applications.
In the Settings/Preferences dialog (Ctrl+Alt+S), choose JavaScript under Languages and Frameworks and then choose ESLint under Code Quality Tools. On the ESLint page page that opens, select the Enable checkbox. After that the controls on the page become available.
In the Node Interpreter field, specify the path to Node.js. If you followed the standard installation procedure, CLion detects the path and fills in the field itself.
In the ESLint Package field, specify the location of the
eslint
orstandard
package.- Choose the configuration to use.
With Automatic search, CLion looks for a
.eslintrc
file or tries to detect a configuration defined undereslintConfig
in apackage.json
. CLion first looks for a.eslintrc
orpackage.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.
Importing code style from ESLint
You can import some of the ESLint code style rules to the CLion JavaScript code style settings. That enables CLion 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, CLion will then no longer break properly formatted code from the ESLint perspective.
CLion 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, CLion 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 on 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 CLion ESLint integration.
To install JavaScript Standard
Open the built-in CLion Terminal (Alt+F12) and type
npm install standard --save-dev
at the command prompt. Learn more from the JavaScript Standard Style Official website.
To enable linting with Standard via ESLint
In the Settings/Preferences dialog (Ctrl+Alt+S), choose JavaScript under Languages and Frameworks and then choose ESLint under Code Quality Tools.
On the ESLint page that opens, select the Enable checkbox, 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), choose ).
On the Code Style. JavaScript page that opens, click Set from, and then choose Predefined Style | JavaScript Standard Style. The style will replace your current scheme.