TypeScript Warning Classes Corresponding to typescript-eslint Rules

• Introduction
• TypeScript Warning Classes from typescript-eslint rules
• Built-in TypeScript Warning Classes
• Enabling and Disabling

Introduction

This page describes the CodeSonar warning classes that are assigned to warnings imported from a SARIF file produced by ESLint.

For information on setting up your CodeSonar project to incorporate TypeScript source code and the corresponding ESLint results, see Including JavaScript and TypeScript Components in a CodeSonar Project.

TypeScript Warning Classes from typescript-eslint rules

When CodeSonar imports a SARIF file, it determines a corresponding CodeSonar warning class for each rule object in the SARIF rules. If a given warning class does not already exist, the SARIF importer creates it.

There is special handling for SARIF files produced by ESLint, including special handling for any typescript-eslint rules in those files.

• CodeSonar ships with a large number of built-in TypeScript warning classes corresponding to rules from typescript-eslint version v7.0.2. Each of these classes has the following properties.
  • The Name is generated using a typescript-eslint-specific mechanism.
  • The Categories include a mnemonic (in the TS.* branch of the CodeSonar mnemonic hierarchy) and a typescript-eslint:<id> category.
• In cases where there is no existing warning class corresponding to a particular typescript-eslint rule object in the SARIF rules, the SARIF importer creates a new warning class.
  • The Name is generated using the same typescript-eslint-specific mechanism used for the built-in language warning classes.
  • The Categories include a typescript-eslint:<id> category, but no mnemonic.
• For SARIF rules entries that are not from typescript-eslint, handling is described in JavaScript Warning Classes Corresponding to ESLint Rules.

Example

Suppose the imported SARIF file includes rule objects like the following.

# ...
    "rules":[
        # ...
        {
          "id": "no-empty",
          # ...
        },
        {
          "id": "@typescript-eslint/no-unused-vars",
          # ...
        },
      # ...
    ],
# ...

CodeSonar identifies the first of these rules ("id": "no-empty") as originating from a built-in ESLint rule, and handles it as described for JavaScript Warning Classes Corresponding to ESLint Rules.

The id for the second rule ("id": "@typescript-eslint/no-unused-vars") starts with @typescript-eslint/, so CodeSonar identifies it as originating from a typescript-eslint rule.
(It corresponds to the typescript-eslint no-unused-vars rule.)

1. CodeSonar computes the corresponding warning class name: "No Unused Vars (TS-ESLint)".
2. If there is not already a warning class with this name, CodeSonar creates the warning class. The class categories will be
   • TS.PROBLEM.NUV (the mnemonic)
     • the meta.type property of the corresponding typescript-eslint rule is "problem".
   • typescript-eslint:no-unused-vars
3. CodeSonar creates a "No Unused Vars (TS-ESLint)" warning instance for each result entry in the SARIF that has "ruleId": "@typescript-eslint/no-unused-vars".

SARIF files produced by ESLint

CodeSonar will consider a SARIF file to be produced by ESLint in the following cases.

• The SARIF file was produced and imported via a codesonar es_scan.py invocation.
• The file is imported with a codesonar import_sarif.py invocation that specifies -analyzer eslint.
• The file is imported with a codesonar import_sarif.py invocation that does not specify -analyzer, and the SARIF importer can determine from the file contents that it was produced by ESLint.

Within a SARIF file produced by ESLint, CodeSonar will determine an individual result to be produced by typescript-eslint if its id begins with @typescript-eslint/.
(For other warnings in ESLint SARIF, see JavaScript Warning Classes Corresponding to ESLint Rules.)

Built-in TypeScript Warning Classes

These warning classes correspond to rules from typescript-eslint version v7.0.2.

Enabling and Disabling

You have multiple degrees of control over reporting for the warnings issued by ESLint, including when it is used with typescript-eslint.

• To enable or disable checking for a specific ESLint rule or set of rules (and thus for the corresponding CodeSonar warning class or classes), use your ESLint configuration.

  See the ESLint documentation for details: Configure ESLint .

• To selectively disable submission to the hub for a warning or set of warnings, define a WARNING_FILTER discard rule in a suitable CodeSonar configuration file.

  You can also specify a combination of WARNING_FILTER discard and WARNING_FILTER allow rules, if that is the most convenient way to characterize a specific set. When you specify warning class names (or parts of names) in your WARNING_FILTER rules, make sure you are using the generated CodeSonar warning class name as described above.