eslint-plugin-idiomatic-jsx
v1.1.0
Published
Eslint jsx plugin to bring more idiomatic control over jsx
Downloads
300
Maintainers
Readme
eslint-plugin-idiomatic-jsx
These rules allow you to create idiomatic styling over JSX in your projects. For instance, enforcing or preventing certain attributes on JSX elements. The goal is to extend the rule sets provided by eslint-plugin-react and eslint-plugin-jsx-a11y to give you more control over how JSX is used.
Some Possible Use Cases
- Require
id
tags on components likea
andinput
for easier automated tests - Prevent
onClick
being used ondiv
orspan
components - Prevent use of
button
components in favor of a customButton
components
Installation
You'll first need to install ESLint:
# npm
npm install eslint --save-dev
# yarn
yarn add eslint --dev
Next, install eslint-plugin-idiomatic-jsx:
# npm
npm install eslint-plugin-idiomatic-jsx --save-dev
# yarn
yarn add eslint-plugin-idiomatic-jsx --dev
Note: If you installed ESLint globally then you must also install eslint-plugin-idiomatic-jsx globally.
Configuration
Add idiomatic-jsx
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix
{
"plugins": [
"idiomatic-jsx"
]
}
Configure the rules you want to use under the rules section.
{
"rules": {
"idiomatic-jsx/rule-name": [ 2, {
// options
} ]
}
}
List of Supported Rules
- prevent-attributes: Prevent specified
attributes
on specifiedcomponents
from being used. - prevent-components: Prevent specified
components
from being used. - require-attributes: Require specified
attributes
on specifiedcomponents
to be defined.
License
eslint-plugin-idiomatic-jsx
is licensed under the MIT License.