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

zhangyu1818's eslint config
https://github.com/zhangyu1818/eslint-config

Last synced: 23 days ago
JSON representation

zhangyu1818's eslint config

• Host: GitHub
• URL: https://github.com/zhangyu1818/eslint-config
• Owner: zhangyu1818
• Created: 2024-06-10T08:46:40.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-11-30T12:03:06.000Z (23 days ago)
• Last Synced: 2024-11-30T12:07:24.333Z (23 days ago)
• Language: TypeScript
• Size: 210 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @zhangyu1818/eslint-config

Very opinionated Flat ESLint Config, but supports rules overrides.

Support ESLint `^9` for `React`, `Next.js`, `TailwindCSS`, `Prettier`.

## Usage

```shell

pnpm i @zhangyu1818/eslint-config -D

```

```js

// esling.config.js or esling.config.mjs

import { defineConfig } from '@zhangyu1818/eslint-config'

export default defineConfig()

```

## API

```ts

import { FlatESLintConfig } from 'eslint-define-config'

type RulesOverrides = FlatESLintConfig['rules']

interface TsParserOptions {

  project?: boolean | string | string[]

  tsconfigRootDir?: string

}

interface ReactFrameworkOptions {

  next?: boolean

  vite?: boolean

}

interface ReactOptions {

  a11y?: boolean

  framework?: ReactFrameworkOptions

}

interface Presets {

  comments?: RulesOverrides | boolean

  ignores?: boolean

  imports?: RulesOverrides | boolean

  javascript?: RulesOverrides | boolean

  jsonc?: RulesOverrides | boolean

  jsx?: boolean

  next?: RulesOverrides | boolean

  node?: RulesOverrides | boolean

  perfectionist?: RulesOverrides | boolean

  prettier?: RulesOverrides | boolean

  react?: RulesOverrides | boolean

  regexp?: RulesOverrides | boolean

  sort?: boolean

  tailwindcss?: RulesOverrides | boolean

  test?: RulesOverrides | boolean

  typescript?: RulesOverrides | boolean

  unicorn?: RulesOverrides | boolean

}

interface Options {

  parserOptions?: TsParserOptions

  presets?: Presets

  reactOptions?: ReactOptions

}

declare function defineConfig(

  options?: Options,

  userConfigs?: FlatESLintConfig[],

): FlatESLintConfig[]

```

## Default presets

```typescript

const defaultPresets: Presets = {

  comments: true,

  ignores: true,

  imports: true,

  javascript: true,

  jsonc: true,

  jsx: true,

  perfectionist: true,

  regexp: true,

  sort: true,

  unicorn: true,

}

```

---

## TODO

- [x] Upgrade to ESLint v9, currently some plugins do not support ESLint v9.

- [ ] Change the configuration to dynamic on-demand imports to reduce dependencies of this package.

- [ ] Add CLI tool.

- [ ] Optimize packaging.

---

This project heavily references [@antfu/eslint-config](https://github.com/antfu/eslint-config). Thanks to [Anthony Fu](https://github.com/antfu) for the outstanding contributions to open source.