AppCode
 
2023.1
Shortcuts: Windows
Get AppCode
  1. Integrations
  2. JavaScript
  3. JavaScript linters
  4. JSCS

JSCS

Last modified: 06 February 2023

Required plugin:

Javascript and TypeScript -  The plugin is bundled with AppCode and enabled by default.

JSCS -  Install the plugin on the Settings | Plugins page, tab Marketplace.

warning

Since AppCode 2020.2, JSCS support in the IDE has been deprecated, see the JSCS official website for details.

However, JSCS support is still available through the JSCS plugin, which can be installed on the Settings | Plugins page as described in Installing plugins from JetBrains repository.

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

Descriptions of the errors detected in the current file and quick-fixes for them are available from the editor and from the 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:

Inspection widget

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

AppCode 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 Preferences | Plugins page, tab Marketplace, as described in Installing plugins from JetBrains repository.

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

    AppCode 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 AppCode

  1. In the Preferences dialog (Ctrl+Alt+S), go to Languages & 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, AppCode 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, AppCode locates the package itself and fills in the field automatically. Otherwise, type the path manually or click App general open disk hover 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.

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

      If no jscsConfig property is found, AppCode will look for a .jscsrc or a .jscs.json configuration file. AppCode 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.

    tip

    You can use the selected set independently or in addition to a configuration file. Note that rules from configuration files override predefined rules.