taolin/eslint-config
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: improve docs

Browse Source
This commit is contained in:
Anthony Fu 2022-03-11 04:43:17 +08:00
parent 18e673f773
commit 38c927024b
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -2,6 +2,13 @@
[![npm](https://img.shields.io/npm/v/@antfu/eslint-config)](https://npmjs.com/package/@antfu/eslint-config) [![npm](https://img.shields.io/npm/v/@antfu/eslint-config)](https://npmjs.com/package/@antfu/eslint-config)
- Single quotes, no semi
- Auto fix for formatting (aimed to be used standalone without Prettier)
- TypeScript, Vue, React out-of-box
- Lint also for json, yaml, markdown
- Sorted imports, dangling commas for cleaner commit diff
- Reasonable defaults, best practices, only one-line of config
## Usage ## Usage
### Install ### Install
@ -18,6 +25,8 @@ pnpm add -D eslint @antfu/eslint-config
} }
``` ```
> You don't need `.eslintignore` normally as it has been provided by the preset.
### Add script for package.json ### Add script for package.json
For example: For example: