WebStorm 2018.2 Help

TSLint

WebStorm integrates with the TSLint code verification tool so you can check your TypeScript code for most common mistakes and discrepancies without running the application. When the tool is activated, it launches automatically on the edited TypeScript file. Discrepancies are highlighted and reported in pop-up information windows, a pop-up window appears when you hover the mouse pointer over a stripe in the Validation sidebar. You can also press Alt+Enter to examine errors and apply suggested quick fixes. Learn more about inspections and intention actions at Code Inspection and Intention actions.

Installing TSLint

  • Open the embedded Terminal (View | Tool Windows | Terminal or Alt+F12) and type npm install tslint typescript --save-dev. Learn more from the TSLint Official website.

Activating and configuring TSLint in WebStorm

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), choose TypeScript under Languages and Frameworks, then choose TSLint. The TSLint page opens.
  2. Select the Enable checkbox. After that all the controls in the page become available.
  3. Specify the location of the Node.js executable file and the path to the TSLint package.
  4. In the Configuration File area, appoint the configuration to use. By default, WebStorm first looks for a tslint.json configuration file. WebStorm starts the search from the folder where the file to be checked is stored, then searches in the parent folder, and so on until reaches the project root. If no tslint.json file is found, TSLint uses its default embedded configuration file. Accordingly, you have to define the configuration to apply either in a tslint.json configuration file, or in a custom JSON configuration file, or rely on the default embedded configuration.
    • To have WebStorm look for a tslint.json file, choose the Search for tslint.json option. If no tslint.json file is found, the default embedded configuration file will be used.
    • To use a custom file, choose the Configuration File option and specify the location of the file in the Path field. Choose the path from the drop-down list, or type it manually, or click the browseButton button and select the relevant file from the dialog box that opens.
  5. If necessary, 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 tslint.json or the above specified custom configuration file and accordingly will override them.

Importing code style from tslint.json

WebStorm understands some of the TSLint rules described in tslint.json and lets you apply them to the TypeScript code style configuration in your project.

  • When you open your project for the first time, WebStorm imports the code style from the project tslint.json automatically.
  • If tslint.json is updated (manually or from your version control), open it in the editor and choose Apply TSLint Code Style Rules on the context menu:
    Import TSLint code style rules from the editor: context menu
    Alternatively, just answer Yes to the "Apply code style from TSLint"? question on top of the file::
    WebStorm suggests importing the code style from tslint.json

TSLint quick-fixes

WebStorm lets you automatically fix some of the issues reported by TSLint.

  • To fix a specific error, place the cursor at the highlighted code, press Alt+Enter, and then choose TSLint: fix current error from the pop-up menu.
  • To fix all the issues detected in the file, choose TSLint: fix current file.
    ws_tslint_quick_fixes.png
Last modified: 13 June 2018

See Also