mirror of
https://github.com/bendtherules/eslint-plugin-no-classname-with-stylename.git
synced 2026-08-18 13:53:24 +00:00
Add proper Readme with badges
TODO: Enable CI services
This commit is contained in:
@@ -1,5 +1,9 @@
|
||||
# eslint-plugin-no-classname-with-stylename
|
||||
|
||||
[](https://www.npmjs.com/package/eslint-plugin-no-classname-with-stylename)
|
||||
Travis: [](https://travis-ci.org/bendtherules/eslint-plugin-no-classname-with-stylename)
|
||||
Appveyor: [](https://ci.appveyor.com/project/bendtherules/eslint-plugin-no-classname-with-stylename)
|
||||
|
||||
While using CSS Modules, disallow using (non-conditional / string) classNames in a JSX tag if it already has a styleName
|
||||
|
||||
## Installation
|
||||
@@ -20,6 +24,23 @@ $ npm install eslint-plugin-no-classname-with-stylename --save-dev
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
Either extend from the plugin or add the rules explicitly.
|
||||
|
||||
### A. Extend from plugin
|
||||
```js
|
||||
{
|
||||
"extends": [
|
||||
// ... other extends here (like airbnb)
|
||||
"plugin:no-classname-with-stylename/recommended"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## OR
|
||||
|
||||
### B. Use rule directly
|
||||
|
||||
Add `no-classname-with-stylename` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
|
||||
|
||||
```json
|
||||
@@ -30,20 +51,21 @@ Add `no-classname-with-stylename` to the plugins section of your `.eslintrc` con
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Then configure the rules you want to use under the rules section.
|
||||
|
||||
```json
|
||||
```js
|
||||
{
|
||||
"rules": {
|
||||
"no-classname-with-stylename/rule-name": 2
|
||||
"no-classname-with-stylename/no-classname-with-stylename": 1,
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Supported Rules
|
||||
|
||||
* Fill in provided rules here
|
||||
There is only one rule, for now -
|
||||
|
||||
* `no-classname-with-stylename` - Disallow string className alongwith styleName attribute in the same JSX tag.
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user