# eslint-plugin-destructure-max-depth

**Repository Path**: UnPourTous/eslint-plugin-destructure-max-depth

## Basic Information

- **Project Name**: eslint-plugin-destructure-max-depth
- **Description**: ESLint插件，用于检测解构最大层级。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-07-11
- **Last Updated**: 2023-07-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# eslint-plugin-destructure-max-depth

解构时校验结构层级，默认0层。

## Installation

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

```sh
npm i eslint --save-dev
```

Next, install `eslint-plugin-destructure-max-depth`:

```sh
npm install eslint-plugin-destructure-max-depth --save-dev
```

## Usage

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

```json
{
    "plugins": [
        "destructure-max-depth"
    ]
}
```


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

```json
{
  "rules": {
    "destructure-max-depth/max-depth": [
      "warn",
      {
        "object": {
          "max": 1
        }
      }
    ]
  }
}
```

## Rules

<!-- begin auto-generated rules list -->
TODO: Run eslint-doc-generator to generate the rules list.
<!-- end auto-generated rules list -->