Consistent naming for boolean props

Docs > Code Analysis > Static Analysis Rules > Consistent naming for boolean props

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Metadata

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

Language: TypeScript

Severity: Notice

Category: Code Style

Description

Enforces a consistent naming pattern for boolean props.

The pattern is: "^(is|has)[A-Z]([A-Za-z0-9]?)+" to enforce is and has prefixes.

Non-Compliant Code Examples

type Props = {
  enabled: boolean
}

Compliant Code Examples

type Props = {
  isEnabled: boolean;
  hasFoo: 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 Analysis scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Analysis documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products