# @r1chm8/eslint-plugin-sort-destructure-keys

> require object destructure key to be sorted

Latest version **0.0.1** (published 2022-07-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install @r1chm8/eslint-plugin-sort-destructure-keys
pnpm add @r1chm8/eslint-plugin-sort-destructure-keys
yarn add @r1chm8/eslint-plugin-sort-destructure-keys
bun add @r1chm8/eslint-plugin-sort-destructure-keys
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2022-07-05 |
| First published | 2022-07-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 1 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 97 |
| Author | Michael Hadley |
| Maintainers | r1chm8 |
| Keywords | eslint, eslintplugin, eslint-plugin |

## Links

- npm: https://www.npmjs.com/package/@r1chm8/eslint-plugin-sort-destructure-keys
- Repository: https://github.com/mthadley/eslint-plugin-sort-destructure-keys
- Homepage: https://github.com/mthadley/eslint-plugin-sort-destructure-keys#readme
- Issues: https://github.com/mthadley/eslint-plugin-sort-destructure-keys/issues
- npm.io page: https://npm.io/package/@r1chm8/eslint-plugin-sort-destructure-keys

## Dependencies (1)

- [natural-compare-lite](https://npm.io/package/natural-compare-lite.md) ^1.4.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2022-07-05

## README

# eslint-plugin-sort-destructure-keys

require object destructure key to be sorted

## Installation

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

```
$ npm i eslint --save-dev
```

Next, install `eslint-plugin-sort-destructure-keys`:

```
$ npm install eslint-plugin-sort-destructure-keys --save-dev
```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-sort-destructure-keys` globally.

## Usage

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

```json
{
    "plugins": [
        "sort-destructure-keys"
    ]
}
```


Then configure the rule under the rules section.

```json
{
    "rules": {
        "sort-destructure-keys/sort-destructure-keys": 2
    }
}
```

## Rule Options

```json
{
    "sort-destructure-keys/sort-destructure-keys": [2, {"caseSensitive": false}]
}
```

### `caseSensitive`

When `true` the rule will enforce properties to be in case-sensitive order. Default is `true`.

Example of **incorrect** code for the `{"caseSensitive": false}` option:

```js
let {B, a, c} = obj;
```

Example of **correct** code for the `{"caseSensitive": false}` option:

```js
let {a, B, c} = obj;
```

Example of **incorrect** code for the `{"caseSensitive": true}` option:

```js
let {a, B, c} = obj;
```

Example of **correct** code for the `{"caseSensitive": true}` option:

```js
let {B, a, c} = obj;
```

## Changelog

### `1.4.0`

- Add compatibility with eslint 8. ([#123])

[#123]: https://github.com/mthadley/eslint-plugin-sort-destructure-keys/pull/123

### `1.3.5`

- Add `^7.0.0` to eslint peer dependency. ([#53], by [dsernst])

[#53]: https://github.com/mthadley/eslint-plugin-sort-destructure-keys/pull/53
[dsernst]: https://github.com/dsernst

### `1.3.4`

- Fixes TypeError issue with multiple property expressions ([#20])

[#20]: https://github.com/mthadley/eslint-plugin-sort-destructure-keys/issues/20

### `1.3.3`

- Add `6.0.0` to eslint peer dependency. ([#21], by [@7rulnik])

[#21]: https://github.com/mthadley/eslint-plugin-sort-destructure-keys/pull/21
[@7rulnik]: https://github.com/7rulnik

### `1.3.2`

- Fix bug where computed properties were causing the rule to throw errors. ([#15], thanks [@TSMMark]!)

[#15]: https://github.com/mthadley/eslint-plugin-sort-destructure-keys/issues/15
[@TSMMark]: https://github.com/TSMMark

### `1.3.1`

- Fix bug with rest properties being sorted incorrectly. ([#11], [#12], thanks [@briandastous] and [@njdancer]!)

[#11]: https://github.com/mthadley/eslint-plugin-sort-destructure-keys/issues/11
[@briandastous]: https://github.com/briandastous
[#12]: https://github.com/mthadley/eslint-plugin-sort-destructure-keys/pull/12
[@njdancer]: https://github.com/njdancer

### `1.3.0`

- Add support for `--fix` eslint cli flag

### `1.2.0`

- Add peer dependency support for eslint `^5.0.0`

### `1.1.0`

- Add `caseSensitive` option ([#1] by [@bsonntag])

[#1]: https://github.com/mthadley/eslint-plugin-sort-destructure-keys/pull/1
[@bsonntag]: https://github.com/bsonntag

---
_Source: https://npm.io/package/@r1chm8/eslint-plugin-sort-destructure-keys · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._