sy/yeslint
0
0
Fork 0
mirror of https://github.com/garraflavatra/yeslint.git synced 2025-04-18 05:41:03 +00:00
Code Issues Actions Packages Releases Activity

Add required ESLint version (8.x) to readme

Browse Source
This commit is contained in:
Romein van Buren 2024-07-25 12:58:12 +02:00 committed by GitHub
parent 75ab0a8c07
commit ffc8867fce
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,6 +1,6 @@
# yeslint! # yeslint!
A sensible, modern collection of configuration files for [ESLint] that enforces beautiful and correct code. It contains both rules to ensure correct code (e.g. enforce `break` statements in each `switch` `case`), and rules to make your code beautiful (e.g. adding a trailing comma to array items that start on a newline). A sensible, modern collection of configuration files for [ESLint] 8.x that enforces beautiful and correct code. It contains both rules to ensure correct code (e.g. enforce `break` statements in each `switch` `case`), and rules to make your code beautiful (e.g. adding a trailing comma to array items that start on a newline).
## What's included ## What's included
@ -19,15 +19,15 @@ Please see [the `examples` directory](./examples) for some examples. Files that
Install it together with ESLint using [npm], [pnpm], [Yarn], or whatever package manager you like to use: Install it together with ESLint using [npm], [pnpm], [Yarn], or whatever package manager you like to use:
```bash ```bash
npm install --save-dev eslint @garraflavatra/yeslint npm install --save-dev eslint@^8.57 @garraflavatra/yeslint
``` ```
```bash ```bash
yarn add --dev eslint @garraflavatra/yeslint pnpm add --save-dev eslint@^8.57 @garraflavatra/yeslint
``` ```
```bash ```bash
pnpm add --save-dev eslint @garraflavatra/yeslint bun add --save-dev eslint@^8.57 @garraflavatra/yeslint
``` ```
Then, tell ESLint to extend this configuration. Add it either in `.eslintrc.json`, add it as the default export in `.eslintrc.js`, or add it in your `package.json` under the `"eslintConfig"` key. Then, tell ESLint to extend this configuration. Add it either in `.eslintrc.json`, add it as the default export in `.eslintrc.js`, or add it in your `package.json` under the `"eslintConfig"` key.
@ -52,7 +52,7 @@ After installing, run `npx eslint .` to lint your code for the first time, or us
## Author & license ## Author & license
© [Romein van Buren](mailto:romein@vburen.nl) 2023. yeslint! is released under the MIT license — see LICENSE for the full license text. © [Romein van Buren](mailto:romein@vburen.nl) 2023-2024. yeslint! is released under the MIT license — see LICENSE for the full license text.
[ESLint]: https://eslint.org/ [ESLint]: https://eslint.org/
[Svelte]: https://svelte.dev/ [Svelte]: https://svelte.dev/