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

Pionxzh's ESLint config presets
https://github.com/pionxzh/eslint-config

Last synced: about 1 month ago
JSON representation

Pionxzh's ESLint config presets

• Host: GitHub
• URL: https://github.com/pionxzh/eslint-config
• Owner: pionxzh
• License: mit
• Created: 2022-10-17T17:45:22.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-28T10:58:34.000Z (7 months ago)
• Last Synced: 2024-10-05T03:31:05.034Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 572 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @pionxzh/eslint-config

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

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

- Single quotes, no semi

- Auto fix for formatting (aimed to be used standalone **without** Prettier)

- Designed to work with TypeScript, Vue, React out-of-box

- Lints also for json, yaml, markdown

- Sorted imports, dangling commas

- Reasonable defaults, best practices, only one-line of config

- Respects `.gitignore` by default

- [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), compose easily!

- Using [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)

- **Style principle**: Minimal for reading, stable for diff, consistent

## Usage

### Install

```bash

pnpm i -D eslint @pionxzh/eslint-config

```

### Usage

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

```js

// eslint.config.mjs

import pionxzh from '@pionxzh/eslint-config'

export default pionxzh()

```

## Extended Reading

Learn more about the context - [Why I don't use Prettier](https://antfu.me/posts/why-not-prettier).

## License

[MIT](./LICENSE) License © 2022-PRESENT [Pionxzh](https://github.com/pionxzh)