Consistent naming for boolean props

Docs > Datadog Security > Code Security > Static Code Analysis (SAST) > SAST Rules > Consistent naming for boolean props

Metadata

ID: typescript-best-practices/boolean-prop-naming

Language: TypeScript

Severity: Notice

Category: Code Style

Description

Enforces a consistent naming pattern for boolean props to ensure that the variable is prefixed with either is or has (or the uppercase equivalent).

Non-Compliant Code Examples

type Props = {
  enabled: boolean;
  __enabled: boolean;
}

Compliant Code Examples

type Props = {
  isEnabled: boolean;
  hasFoo: boolean;
  __hasFoo: boolean;
  IS_ENABLED: boolean;
}

How to use this rule

1
2
rulesets:
  - typescript-best-practices     # Rules to enforce TypeScript best practices.

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