TypeScript

Prerequisites

In order to analyze TypeScript code, you need to have Node.js >= 8 installed on the machine running the scan. If standard node is not available, you have to set property sonar.nodejs.executable to an absolute path to Node.js executable.

Also make sure to have TypeScript as a project dependency or dev dependency. If it's not the case, add it:

cd <your-project-folder>
npm install -D typescript

If you can't have TypeScript as a project dependency you can set your NODE_PATH variable to point to your globally installed TypeScript (but this is generally discouraged by the Node.js documentation).

Language-Specific Properties

Discover and update the TypeScript-specific properties in: Administration > General Settings > TypeScript

Supported Frameworks and Versions

  • TypeScript >=3.2.1 <3.8.0. If it's not possible to upgrade version of TypeScript used by the project, consider installing supported TypeScript version just for the time of analysis.

Rule Profiles

There are 2 built-in rule profiles for TypeScript: Sonar way (default) and Sonar way Recommended.

  • Sonar way profile is activated by default. It defines a trimmed list of high-value/low-noise rules useful in almost any TS development context.
  • Sonar way Recommended contains all rules from Sonar way, plus more rules that mandate high code readability and long-term project evolution.

Related Pages