@layerzerolabs/eslint-config-next/README.md

LayerZero Eslint Config

## Usage

```
yarn add --dev @rushstack/eslint-patch @layerzerolabs/eslint-config-next
```

.eslintrc.js

```
require('@rushstack/eslint-patch/modern-module-resolution');

module.exports = {
  extends: ['@layerzerolabs/eslint-config-next/recommended'],
};
```

## Requirements

WARNING: `normalizePackageName` in `@eslint/eslintrc` requires that the format of the package name should be `@layerzerolabs/eslint-config-next` or `eslint-config-layerzerolabs`.

## Configuration

- use [sort-imports](https://eslint.org/docs/latest/rules/sort-imports) and [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import) to organize imports.
- apply prettier with `eslint-plugin-prettier` and `eslint-config-prettier`.
- mark `^@layerzerolabs/` as internal with `import/internal-regex`.
- use `pathGroups` to put `^@layerzerolabs/**` ahead of the internal group.
- treat `['node_modules', '.yarn']` as external with `import/external-module-folders`.
- list typescript projects under `import/resolver`.

## Debug

set environment `DEBUG=*`