sonarsource/sonarts

Static code analyzer for TypeScript

TypeScript analysis for SonarQube was migrated to JavaScript analyzer. This is a legacy repository which is used to produce an artifact required for backward compatibility with SonarQube.

If you are interested in the plugin for TSLint, check v1.9 which was the last release of tslint-sonarts package (deprecated now).

If you have any question or feedback please start a topic on SonarSource Community Forum.

sonarts's Issues

Manually Add Rules Documentation for SonarQube

Redirect external process errors to analysisError

Release 0.1.0

• finish README.md
• add rule docs
• test with different ts & tslint versions -> peer dep is added for tslint@^5.1.0 (which implicitly forces supported typescript version)
• and .npmignore
• add prepublish script to compile the project

Define rules (using SXXXX style for rule keys)

Rule: Useless Cast and not null assertion

The TypeScript compiler automatically casts objects to a specific type inside conditionals with instanceof :

if(x instanceof string) {
  x = (x as string).concat("postfix"); // This cast is not required
}

but also when property values that are set at type definition are checked for :

class Wolf extends Animal {
  kind = hunting.PackHunter;
  howl() {}
}

class Cat extends Animal {
  kind = hunting.SoloHunter;
  meow() {}
}

function emitSound(animal: Animal) {
  if(animal.kind === hunting.PackHunter) {
    (animal as Wolf).howl(); // This case is not required either
  }
}

Rule: Identical expressions should not be used on both sides of a binary operator

Implements RSPEC-1764

no-use-of-empty-return-value: simplify message

include in the message only method/function name, not entire callee

Rule: All branches in a conditional structure should not have exactly the same implementation

RSPEC-3923

Create npm module

Rule: Variables should be declared before they are used

RSPEC-1526

Rule: Variables and functions should not be redeclared

Useful only for var

https://jira.sonarsource.com/browse/RSPEC-2814

include in npm artifact only required files

Currently we distribute entire project, including cfg-viewer. It makes the size of the artifact significant.

compute basic metrics

on typescript side

• lines of code (NCLOC)
• comment lines
• number of functions/classes/statements
• NOSONAR lines

on java side

• lines of code (NCLOC)
• comment lines
• number of functions/classes/statements
• NOSONAR lines

Rule: Return values should not be ignored when function calls don't have any side effects

RSPEC-2201

SonarTS Plugin for Windows

• run integration test on Windows
• have CI running on Windows

Automate documentation update

We should automate update of documentation:

• the list of rules in README
• each rule documentation
• ...

Rule: Two branches in a conditional structure should not have exactly the same implementation

RSPEC-1871

Improve: Dead stores should be removed (CFG with break, continue, try, catch)

RSPEC-1854

Rule: Related "if/else if" statements and "cases" in a "switch" should not have the same condition

RSPEC-1862

Generate JSON/HTML with rule-api and feed SQ

Add "require type-checker" to rules documentation

Rule:Variables should not be self-assigned

https://jira.sonarsource.com/browse/RSPEC-1656

Extend S1526 : Let/Const variables should not be used before declaration

When a variable is used within an inner function the TS compiler can't say if that variable is declared before or after its use. In some specific cases (methods well known to execute their callbacks on the fly) it is detectable :

arr.forEach( e => newArray.push(e.foo()));
let newArray = [];

Rule: Logical OR operators should not be used in switch cases

RSPEC-3616

Rule: Literal values should be not be used as 'switch' expression

const x = 1;

switch (x) { // Noncompliant
    case 2 * 4:
       //...
    case 1 + 5:
        // ...
}

Support both TS and TSX files

add syntax highlighting

On typescript part:

• keywords
• comments (structured or not)
• string literals, template literals
• numbers (as constants)

Rule: Sections of code should not be "commented out"

RSPEC-125

Rule: Unused local variables should be removed

Implements RSPEC-1481

Import coverage

Rule: Dead stores should be removed

RSPEC-1854

Only non-breaking flows

Rule: Functions should use "return" consistently

Implements RSPEC-3801

function foo(p: number) { // Noncompliant, function can implicitly return undefined 
  if (p > 0) {
    return 43;
  }
}

Rule type-checker independent version of no-unused-variable

There is no-unused-variable from tslint core which is base on compiler option (not part of default profile). May be for users it would be valuable to have the same rule but not using type-checker.
To validate this idea we have look through some regular projects using tslint and see if they enabled that rule.

Rule: "delete" should not be used on arrays

RSPEC-2870

Rule: Destructuring patterns should not be empty

RSPEC-3799

Rule: "Array.reverse" should not be used misleadingly

Implements RSPEC-4043

Rule: Multiline blocks should be enclosed in curly braces

Implements RSPEC-2681

Feed 'executable lines' metric

See developer docs and MMF-739

Integrate SonarTS with SonarQube

• embed tslint and sonarts folders in jar
• maven plugin to download npm
• plugin integration test
• QA chain
• add ability to integrate measures and highlighting
• document some rules

Rule: Switch cases should end with an unconditional "break" statement

Implements RSPEC-128

Rule: Jump statements should not be used unconditionally

RSPEC-1751

Rule: The output of functions that don't return anything should not be used

https://jira.sonarsource.com/browse/RSPEC-3699

Rule: Track lack of copyright and license headers

As per [RSPEC-1451]

Rule: Values should not be uselessly incremented

RSPEC-2123

Rule: Collection sizes and array length comparisons should make sense

Implements RSPEC-3981

Improve no-identical-expressions

Add ==, ===, !==, !=

Rename repository to align to SonarSource standard

This repository is called SonarTS, which seems unusual. Language plugin namings usually follow the kebab-case style:
sonar-java
sonar-css
sonar-javascript

Rename the repository to align to the common style. Suggestion:
sonar-typescript

Rule: "=+" should not be used instead of "+="

RSPEC-2757

This rule might intersect with whitespace

Calculate Cyclomatic Complexity metric

Contact Pablissimo

https://groups.google.com/forum/?pli=1#!searchin/sonarqube/tslint%7Csort:relevance/sonarqube/3O9vDYozu-Q/DAx_cKo1AgAJ