No Underscore React Props

Error

small-rules/no-underscore-react-props

Ban React property names that begin with an underscore in JSX.

Diagnostic Messages

noUnderscoreReactProperty

React prop '{{propName}}' starts with '_'. Remove the leading underscore from the prop name.

Configuration

This rule does not accept options.

{
  "jsPlugins": [
    "@pobammer-ts/small-rules"
  ],
  "rules": {
    "small-rules/no-underscore-react-props": "error"
  }
}

Examples

Underscored React prop

<InventoryItemTooltip
    key="inventory-tooltip"
    _tooltipGradient={tooltipGradient}
/>;

Regular React prop

<InventoryItemTooltip
      key="inventory-tooltip"
      tooltipGradient={tooltipGradient}
/>;