Skip to content

Commit

Permalink
chore: add readme file to sub package
Browse files Browse the repository at this point in the history
  • Loading branch information
antfu committed Sep 21, 2023
1 parent ab2b5aa commit 8d45126
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
17 changes: 17 additions & 0 deletions packages/eslint-config/README.md
@@ -0,0 +1,17 @@
# @antfu/eslint-config

[![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)

- Single quotes, no semi
- Auto fix for formatting (aimed to be used standalone **without** Prettier)
- Designed to work with TypeScript, Vue out-of-box
- Lint also for json, yaml, markdown
- Sorted imports, dangling commas
- Reasonable defaults, best practices, only one-line of config
- [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

## Usage

Check [antfu/eslint-config](https://github.com/antfu/eslint-config) for more details.
1 change: 1 addition & 0 deletions packages/eslint-config/package.json
Expand Up @@ -5,6 +5,7 @@
"description": "Anthony's ESLint config",
"author": "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
"license": "MIT",
"funding": "https://github.com/sponsors/antfu",
"homepage": "https://github.com/antfu/eslint-config",
"keywords": [
"eslint-config"
Expand Down

0 comments on commit 8d45126

Please sign in to comment.