https://github.com/rafaelgomesxyz/eslint-plugin-mui

Custom ESLint rules for MUI
https://github.com/rafaelgomesxyz/eslint-plugin-mui

Last synced: 17 days ago
JSON representation

Custom ESLint rules for MUI

• Host: GitHub
• URL: https://github.com/rafaelgomesxyz/eslint-plugin-mui
• Owner: rafaelgomesxyz
• Created: 2021-09-18T12:47:50.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-30T14:11:25.000Z (almost 3 years ago)
• Last Synced: 2024-10-16T09:03:54.201Z (29 days ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# eslint-plugin-mui

Custom ESLint rules for MUI

## Installation

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

```sh

npm install eslint --save-dev

```

Next, install `eslint-plugin-mui`:

```sh

npm install eslint-plugin-mui --save-dev

```

## Usage

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

```json

{

	"plugins": ["mui"]

}

```

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

```json

{

	"rules": {

		"mui/rule-name": 2

	}

}

```

## Supported Rules

- [sort-sx-keys](https://github.com/rafaelgomesxyz/eslint-plugin-mui/tree/main/docs/rules/sort-sx-keys.md)

## Credits

This plugin is based on eslint-plugin-sort-keys-fix (https://github.com/leo-buneev/eslint-plugin-sort-keys-fix).