eslint-plugin-no-styled-components v1.0.2

eslint-plugin-no-styled-components

Prevent imports and usages of styled-components.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-no-styled-components:

npm install eslint-plugin-no-styled-components --save-dev

Usage

Add no-styled-components to the plugins section of your .eslintrc configuration file as shown below. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "no-styled-components"
    ]
}

Then configure the rules you want to use under the rules section.

You can choose to ban imports of styled-components, just their usages (e.g. styled.div), or both.

{
    "rules": {
        "no-styled-components/imports": 2, // <-- 2 is error, 1 is warning, 0 is off
        "no-styled-components/usages": 1
    }
}