https://github.com/tinloof/eslint-plugin-better-styled-components

ESlint's rules for styled components 💅
https://github.com/tinloof/eslint-plugin-better-styled-components

eslint eslint-plugin react styled-components

Last synced: 3 months ago
JSON representation

ESlint's rules for styled components 💅

• Host: GitHub
• URL: https://github.com/tinloof/eslint-plugin-better-styled-components
• Owner: tinloof
• License: apache-2.0
• Created: 2018-08-22T16:39:06.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T20:43:27.000Z (almost 2 years ago)
• Last Synced: 2024-07-07T21:04:43.415Z (4 months ago)
• Topics: eslint, eslint-plugin, react, styled-components
• Language: JavaScript
• Homepage:
• Size: 294 KB
• Stars: 64
• Watchers: 2
• Forks: 9
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-eslint - Better Styled Components - Auto fixable ESlint's rules for styled components. (Plugins / CSS in JS)

README

        
# eslint-plugin-better-styled-components 💅

Auto fixable ESlint's rules for styled components.

## Installation

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

```

$ npm i eslint --save-dev

```

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

```

$ npm install eslint-plugin-better-styled-components --save-dev

```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-better-styled-components` globally.

## Usage

Add `better-styled-components` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json

{

    "plugins": [

        "better-styled-components"

    ]

}

```

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

```json

{

    "plugins": [

        "better-styled-components"

    ],

    "rules": {

        "better-styled-components/sort-declarations-alphabetically": 2

    }

}

```

## Supported Rules

* 🔤`sort-declarations-alphabetically`: auto fixable rule that enforces alphabetically sorted declarations.

## License

Unless otherwise specified this project is licensed under [Apache License Version 2.0](./LICENSE).