RubyMine 2020.2 Help

JSCS

When JSCS support is enabled, RubyMine highlights errors that JSCS detects, provides descriptions for them, and suggests quick-fixes where possible.

Error descriptions and quick-fixes are available from the editor and from the Problems tool window. To open the tool window, click the Inspection widget in the upper-right corner of the editor:

Inspection widget

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

RubyMine also provides code completion in JSCS configuration files.

Before you start

  1. Download and install Node.js.

  2. Install and enable the JSCS plugin on the Settings/Preferences | Plugins page as described in Installing plugins from JetBrains repository.

    If the JSCS repository plugin is missing, RubyMine suggests installing it when you open a .jscsrc or a .jscs.json configuration file.

    RubyMine suggests installing JSCS plugin

Install JSCS globally

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

    npm install --g jscs

Enable JSCS and configure its behavior in RubyMine

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Languages and Frameworks | JavaScript | Code Quality Tools | JSCS. On the JSCS page, that opens, select the Enable checkbox. After that the other controls on the page become available.

  2. In the Node Interpreter field, specify the path to Node.js. If you followed the standard installation procedure, RubyMine detects the path and fills in the field itself.

  3. In the JSCS Package field, specify the location of the jscs package.

    If you installed JSCS through the Node Package Manager, RubyMine locates the package itself and fills in the field automatically. Otherwise, type the path manually or click icons.general.openDiskHover.svg and select the package location in the dialog that opens.

  4. Specify the configuration to use.

    • Search for config(s) - select this option if JSCS rules are configured in your project package.json, in .jscsrc, or in .jscs .json.

      RubyMine will first look for a jscsConfig property in the project package .json.

      If no jscsConfig property is found, RubyMine will look for a .jscsrc or a .jscs.json configuration file. RubyMine starts the search from the folder where the file to be checked is stored, then searches in the parent folder, and so on until the project root is reached.

    • Configuration File - select this option if JSCS rules are configured in a custom JSON file. Specify the file location in the Path field. Select the path from the list or click the Browse button and select the relevant file in the dialog that opens.

  5. To apply a predefined set of rules associated with the code style you are using, select the set from the Code Style Preset list.

Last modified: 19 August 2020