Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/zzxming/eslint-config

Last synced: about 2 months ago
JSON representation
Host: GitHub
URL: https://github.com/zzxming/eslint-config
Owner: zzxming
License: mit
Created: 2024-06-27T07:24:06.000Z (6 months ago)
Default Branch: master
Last Pushed: 2024-09-11T01:17:41.000Z (4 months ago)
Last Synced: 2024-09-11T09:25:06.661Z (4 months ago)
Language: TypeScript
Size: 665 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # @zzxming/eslint-config

[default config rules](https://zzxming.github.io/eslint-config/configs)

> After install and config. Please run once `eslint .` to install required config rules.

## Javascript rules

already use plugin [`eslint-plugin-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports). please see official docs to config rules.

| plugin name                    | rename           |

| ------------------------------ | ---------------- |

| `eslint-plugin-unused-imports` | `unused-imports` |

## Typescript rules

already use plugin [`@typescript-eslint/eslint-plugin`](https://typescript-eslint.io/). please see official docs to config rules.

| plugin name                        | rename |

| ---------------------------------- | ------ |

| `@typescript-eslint/eslint-plugin` | `ts`   |

## Vue rules

already use plugin [`eslint-plugin-vue`](https://eslint.vuejs.org/). please see official docs to config rules.

here is the rules plugin name:

| plugin name         | rename |

| ------------------- | ------ |

| `eslint-plugin-vue` | `vue`  |

## React rules

already use plugin [`@eslint-react/eslint-plugin`](https://eslint-react.xyz/)、[`eslint-plugin-react-hooks`](https://www.npmjs.com/package/eslint-plugin-react-hooks)、[`eslint-plugin-react-refresh`](https://www.npmjs.com/package/eslint-plugin-react-refresh). please see official docs to config rules.

here is the rules plugin name:

| plugin name                       | rename                    |

| --------------------------------- | ------------------------- |

| `@eslint-react`                   | `react`                   |

| `@eslint-react/dom`               | `react-dom`               |

| `@eslint-react/hooks-extra`       | `react-hooks-extra`       |

| `@eslint-react/naming-convention` | `react-naming-convention` |

| `eslint-plugin-react-hooks`       | `react-hooks`             |

| `eslint-plugin-react-refresh`     | `react-refresh`           |

## Json rules

already use plugin [`eslint-plugin-jsonc`](https://www.npmjs.com/package/eslint-plugin-jsonc). please see official docs to config rules.

| plugin name           | rename  |

| --------------------- | ------- |

| `eslint-plugin-jsonc` | `jsonc` |

## Markdown rules

already use plugin [`eslint-plugin-markdown`](https://www.npmjs.com/package/eslint-plugin-markdown). please see official docs to config rules.

| plugin name              | rename     |

| ------------------------ | ---------- |

| `eslint-plugin-markdown` | `markdown` |

## Tailwindcss rules

already use plugin [`eslint-plugin-tailwindcss`](https://www.npmjs.com/package/eslint-plugin-tailwindcss). please see official docs to config rules.

| plugin name                 | rename        |

| --------------------------- | ------------- |

| `eslint-plugin-tailwindcss` | `tailwindcss` |

## Unicorn rules

already use plugin [`eslint-plugin-unicorn`](https://www.npmjs.com/package/eslint-plugin-unicorn). please see official docs to config rules.

| plugin name             | rename    |

| ----------------------- | --------- |

| `eslint-plugin-unicorn` | `unicorn` |

## Yaml rules

already use plugin [`eslint-plugin-yml`](https://www.npmjs.com/package/eslint-plugin-yml). please see official docs to config rules.

| plugin name         | rename |

| ------------------- | ------ |

| `eslint-plugin-yml` | `yaml` |

## Vitest rules

already use plugin [`@vitest/eslint-plugin`](https://github.com/vitest-dev/eslint-plugin-vitest). please see official docs to config rules.

| plugin name             | rename   |

| ----------------------- | -------- |

| `@vitest/eslint-plugin` | `vitest` |

## Other rules

| plugin name                   | rename          |

| ----------------------------- | --------------- |

| `eslint-plugin-antfu`         | `antfu`         |

| `@stylistic/eslint-plugin`    | `style`         |

| `eslint-plugin-format`        | `format`        |

| `eslint-plugin-import-x`      | `import`        |

| `eslint-plugin-format`        | `format`        |

| `eslint-plugin-perfectionist` | `perfectionist` |

## factory Arguments

| args   | type            | require |

| ------ | --------------- | ------- |

| option | `OptionsConfig` | `false` |

  OptionsConfig

```ts

export interface StylisticConfigOptions {

  indent?: number | 'tab';

  jsx?: boolean;

  quotes?: 'double' | 'single';

  semi?: boolean;

}

export interface FilesOverrides {

  files?: string[];

}

export interface StylisticOverrides {

  stylistic?: StylisticConfigOptions;

}

export interface OptionsOverrides {

  overrides?: Linter.Config;

}

export interface StylisticOptions extends StylisticConfigOptions, OptionsOverrides {}

export type JavascriptOptions = OptionsOverrides;

export interface TypescriptOptions extends OptionsOverrides {

  parserOptions?: ESLint.Environment['parserOptions'];

}

export interface VueOptions extends OptionsOverrides, FilesOverrides, StylisticOverrides {

  vueVersion?: 2 | 3;

  typescript?: boolean;

}

export interface JsoncOptions extends OptionsOverrides, FilesOverrides, StylisticOverrides {}

export interface MarkdownOptions extends OptionsOverrides, FilesOverrides {

  componentExts?: string[];

}

export interface FormmatterOptions extends StylisticOverrides {

  css?: boolean;

  html?: boolean;

  markdown?: boolean;

  xml?: boolean;

  prettierOptions?: Record;

}

export interface YamlOptions extends OptionsOverrides, FilesOverrides, StylisticOverrides {}

export type UnicornOptions = OptionsOverrides;

export type TailwindcssOptions = OptionsOverrides;

export interface ReactOptions extends OptionsOverrides {

  files?: string[];

}

export interface VitestOptions extends OptionsOverrides {

  files?: string[];

};

export interface OptionsConfig {

  stylistic?: boolean | StylisticOptions;

  javascript?: boolean | JavascriptOptions;

  gitignore?: boolean;

  jsx?: boolean;

  typescript?: boolean | TypescriptOptions;

  vue?: boolean | VueOptions;

  tailwindcss?: boolean | TailwindcssOptions;

  jsonc?: boolean | JsoncOptions;

  markdown?: boolean | JsoncOptions;

  formatters?: boolean | FormmatterOptions;

  yaml?: boolean | YamlOptions;

  unicorn?: UnicornOptions;

  react?: boolean | ReactOptions;

  vitest?: boolean | VitestOptions;

  overrides?: Linter.Config[];

}

```

## Credits

- [@antfu/eslint-config](https://github.com/antfu/eslint-config)