https://github.com/tj-mc/eslint-plugin-no-styled-components

Last synced: 2 months ago
JSON representation

Prevent imports and usages of styled-components

README

# eslint-plugin-no-styled-components

![](https://img.shields.io/npm/d18m/eslint-plugin-no-styled-components)
![](https://img.shields.io/npm/v/eslint-plugin-no-styled-components)

Prevent imports and usages of styled-components.

## Installation

You'll first need to install [ESLint](https://eslint.org/):

```sh
npm i eslint --save-dev
```

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

```sh
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:

```json
{
"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.

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