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). Any prefix symbol (_, $, etc) is allowed.

Non-Compliant Code Examples

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

Compliant Code Examples

type Props = {
  isEnabled: boolean;
  hasFoo: boolean;
  __hasFoo: boolean;
  IS_ENABLED: boolean;
  is_enabled: boolean;
  has_enabled: boolean;
  __is_enabled: boolean;
  __has_enabled: boolean;
  hasEnabled: boolean;
  __isEnabled: boolean;
  __hasEnabled: boolean;
}

Seamless integrations. Try Datadog Code Security

Datadog Code Security