ESLint-Plugin-Sort-Decorators

!Code coverage

An ESLint plugin to sort decorators

Installation

First, the peer dependencies must be installed:

- eslint
- typescript
- @typescript-eslint/parser

``bash
npm i --save-dev typescript eslint @typescript-eslint/parser
`

Next, install eslint-plugin-sort-decorators:

`bash
npm i --save-dev @elsikora/eslint-plugin-sort-decorators
`

Usage

As this plugin only works with _typescript_,
the parser must be set in a .eslintrc
file:

`json
{
"parser": "@typescript-eslint/parser"
}
`

The plugin can then be activated by adding sort-decorators to the plugins property:

`json
{
"plugins": ["@elsikora/sort-decorators"]
}
`

The different rules can be defined as follows:

`json
{
"rules": {
"@elsikora/sort-decorators/sort-on-classes": "error"
}
}
`

Or simply extends a configuration preset:

`json
{
"extends": ["plugin:@elsikora/sort-decorators/recommended"]
}
`

$3

| Name | Description |
|:-----------------------------------------------|:---------------------------------------------------------------|
| plugin:@elsikora/sort-decorators/recommended | Enables all rules with a warn security level. |
| plugin:@elsikora/sort-decorators/strict | Enables all rules with a error security level and autoFix. |

---

> All this configuration can be done on a override section:
>

Rules

💼 Configurations enabled in.\
⚠️ Configurations set to warn in.\
✅ Set in the recommended configuration.\
🔒 Set in the strict configuration.\
🔧 Automatically fixable by the --fix` CLI option.

| Name | Description | 💼 | ⚠️ | 🔧 |
| :----------------------------------------------------- | :-------------------------------------- | :- | :- | :- |
| sort-on-accessors | Enforces order of accessors decorators | 🔒 | ✅ | 🔧 |
| sort-on-classes | Enforces order of class decorators | 🔒 | ✅ | 🔧 |
| sort-on-methods | Enforces order of methods decorators | 🔒 | ✅ | 🔧 |
| sort-on-parameters | Enforces order of parameters decorators | 🔒 | ✅ | 🔧 |
| sort-on-properties | Enforces order of properties decorators | 🔒 | ✅ | 🔧 |

Releases

See information about breaking changes and release notes here.