Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tinywaves/eslint-config

My personal eslint config.
https://github.com/tinywaves/eslint-config

eslint eslint-config

Last synced: 2 months ago
JSON representation

My personal eslint config.

Host: GitHub
URL: https://github.com/tinywaves/eslint-config
Owner: tinywaves
License: mit
Created: 2022-03-11T13:39:11.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-10-22T15:11:08.000Z (3 months ago)
Last Synced: 2024-11-15T04:36:15.739Z (2 months ago)
Topics: eslint, eslint-config
Language: TypeScript
Homepage: https://www.npmjs.com/package/@dhzh/eslint-config
Size: 662 KB
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# @dhzh/eslint-config

[![npm](https://img.shields.io/npm/v/@dhzh/eslint-config?color=444&label=)](https://npmjs.com/package/@antfu/eslint-config)

> `Special Statement`: This project comes from [`@antfu/eslint-config`](https://github.com/antfu/eslint-config). The two are almost the same, with only some differences to meet personal needs. In order to seek convenience and prevent some conflicts between the upstream branch and my own changes after forking, I chose to copy instead of fork.

Differences from [@antfu/eslint-config](https://github.com/antfu/eslint-config/blob/main/README.md):

1. With semi: `semi: true`.
2. Always arrow parens: `arrowParens: true`.
3. Explicitly use `1tbs` as brace style: `braceStyle: '1tbs'`.
4. Disabled antfu's top level function rule: `'antfu/top-level-function': 'off'`.
5. Always curly:

- `'antfu/curly': 'off'`
- `'curly': ['error', 'all']`

6. This eslint-config will enable `ts/consistent-type-imports` rule. But it will cause [compile issue](https://github.com/typescript-eslint/typescript-eslint/issues/2559) in [nest](https://nestjs.com/) projects. So I [disabled it](https://github.com/typescript-eslint/typescript-eslint/issues/2559#issuecomment-692780580) in this config in nest framework.
7. Support `'**/*.?([cm])js` and `'**/*.?([cm])jsx` files in react projects.
8. Perfectionist plugin for imports sorting:

```js
[
'builtin',
'external',
'internal',
'parent',
'sibling',
'index',
'style',
'side-effect',
'side-effect-style',
'object',
'builtin-type',
'external-type',
'internal-type',
'parent-type',
'sibling-type',
'index-type',
'unknown',
];
```

> Note: Temporarily close the rules of the [`Perfectionist`](https://perfectionist.dev/) plugin from version `v0.15.0`, because I haven't found a way to achieve the best balance between actual development needs and personal habits.

## Usage

> Requires ESLint v9.5.0+

### Starter Wizard

We provided a CLI tool to help you set up your project, or migrate from the legacy config to the new flat config with one command.

```shell
pnpm dlx @dhzh/eslint-config@latest
```

### Manual Install

If you prefer to set up manually:

```bash
pnpm i -D eslint @dhzh/eslint-config
```

And create `eslint.config.mjs` in your project root:

```js
// eslint.config.mjs
import dhzh from '@dhzh/eslint-config';

export default dhzh();
```

## License