eslint-plugin-typescript-sort-keys
Version:
Sort interface and string enum keys
79 lines (54 loc) • 2.07 kB
Markdown
# eslint-plugin-typescript-sort-keys
Sort interface and string enum keys
Inspired by and sourced from [eslint/sort-keys]([https://github.com/eslint/eslint/blob/master/docs/rules/sort-keys.md](https://github.com/eslint/eslint/blob/main/docs/src/rules/sort-keys.md))
## Installation
You'll first need to install
- [eslint](http://eslint.org)
- [typescript](http://www.typescriptlang.org/)
- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser)
```sh
yarn add -D eslint typescript @typescript-eslint/parser
```
Next, install `eslint-plugin-typescript-sort-keys`:
```sh
yarn add -D eslint-plugin-typescript-sort-keys
```
**Note:** If you installed ESLint globally then you must also install `eslint-plugin-typescript-sort-keys` globally.
## Usage
Specify the parser for typescript files in your `.eslintrc` configuration file:
```json
{
"parser": "@typescript-eslint/parser"
}
```
Add `typescript-sort-keys` to the plugins section. You can omit the `eslint-plugin-` prefix:
```json
{
"plugins": ["typescript-sort-keys"]
}
```
Then configure the rules you want to use under the rules section.
```json
{
"rules": {
"typescript-sort-keys/interface": "error",
"typescript-sort-keys/string-enum": "error"
}
}
```
Or enable all rules with defaults
```json
{
"extends": ["plugin:typescript-sort-keys/recommended"]
}
```
## Supported Rules
<!-- begin rule list -->
**Key**: :heavy_check_mark: = recommended, :wrench: = fixable
<!-- prettier-ignore -->
| Name | Description | :heavy_check_mark: | :wrench: |
| ---- | ----------- | ------------------ | -------- |
| [`typescript-sort-keys/interface`](./docs/rules/interface.md) | require interface keys to be sorted | :heavy_check_mark: | :wrench: |
| [`typescript-sort-keys/string-enum`](./docs/rules/string-enum.md) | require string enum members to be sorted | :heavy_check_mark: | :wrench: |
<!-- end rule list -->