Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 1.27 KB

jsx-pascal-case.md

File metadata and controls

62 lines (43 loc) · 1.27 KB
Raw

Enforce PascalCase for user-defined JSX components (react/jsx-pascal-case)

Enforces coding style that user-defined JSX components are defined and referenced in PascalCase.

Note that since React's JSX uses the upper vs. lower case convention to distinguish between local component classes and HTML tags this rule will not warn on components that start with a lower case letter.

Rule Details

The following patterns are considered warnings:

<Test_component />
<TEST_COMPONENT />

The following patterns are not considered warnings:

<div />
<TestComponent />
<TestComponent>
  <div />
</TestComponent>
<CSSTransitionGroup />

Rule Options

...
"react/jsx-pascal-case": [<enabled>, { allowAllCaps: <allowAllCaps>, ignore: <ignore> }]
...
  • enabled: for enabling the rule. 0=off, 1=warn, 2=error. Defaults to 0.
  • allowAllCaps: optional boolean set to true to allow components name in all caps (default to false).
  • ignore: optional string-array of component names to ignore during validation.

allowAllCaps

The following patterns are not considered warnings when allowAllCaps is true:

<ALLOWED />
<TEST_COMPONENT />

When Not To Use It

If you are not using JSX.