eslint-plugin-custom-display-name
v0.3.0
Published
Eslint plugin that provides custom rules about `displayName` for React components.
Downloads
6
Readme
eslint-plugin-custom-display-name
Eslint plugin that provides custom rules about displayName for React components.
Install
$ npm install --save-dev eslint-plugin-custom-display-nameand add it to your .eslintrc.
{
"plugins": ["custom-display-name"],
"rules": {
"custom-display-name/display-name-only-exported-component": "error",
"custom-display-name/prefer-unique-display-name": "error"
}
}Rules
| Rule ID | Description | | :--------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------- | | custom-display-name/display-name-only-exported-component | Exported Component requires displayName. | | custom-display-name/prefer-unique-display-name | displayName should be different from component's variable name. |
Contributing
Welcome your contribution!
See also ESLint/Working with Plugins.
Setup
$ git clone [email protected]:nissy-dev/eslint-plugin-custom-display-name.git
$ cd eslint-plugin-custom-display-name
$ npm ciDevelopment Tools
// run tsc, eslint, prettier
$ npm run lint
// run test
$ npm run test