API

Avoid @ts-<directive> comments

Docs > Datadog Security > Code Security > Static Code Analysis (SAST) > SAST Rules > Avoid @ts-<directive> comments

Metadata

ID: typescript-code-style/ban-ts-comment

Language: TypeScript

Severity: Notice

Category: Best Practices

Description

Correct your types instead of disabling TypeScript.

Non-Compliant Code Examples

// @ts-expect-error
// @ts-ignore
// @ts-nocheck
// @ts-check

Compliant Code Examples

// just a comment containing @ts-expect-error somewhere
// just a comment containing @ts-ignore somewhere
// just a comment containing @ts-nocheck somewhere
// just a comment containing @ts-check somewhere

How to use this rule

1
2
rulesets:
  - typescript-code-style     # Rules to enforce TypeScript code style.

Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Security scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Security documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products