yeslint/README.md

72 lines
2.6 KiB
Markdown
Raw Normal View History

2023-07-27 21:56:03 +02:00
# yeslint!
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).
2023-07-27 21:56:03 +02:00
2024-07-25 13:28:19 +02:00
TypeScript is supported out of the box! No configuration is required.
2023-07-27 21:56:03 +02:00
## What's included
Currently, the 3 following configuration files are available:
* `generic`: generic ESLint configuration for all modern JavaScript runtimes.
2024-07-25 13:28:19 +02:00
* `node`: an extension on the generic config, with rules specific to Node.js. Also works with [Bun]!
2023-07-27 21:56:03 +02:00
* `svelte`: configuration for [Svelte] and JavaScript in browser environments.
## Examples
2024-07-25 13:28:19 +02:00
Please see [the `example` directory](./example) for some examples. Files that start with `wrong.` contain many errors, and the fixed version of those files is in their `correct.` equivalent.
2023-07-27 21:56:03 +02:00
## Installation
Install it together with ESLint using [npm], [pnpm], [Yarn], or whatever package manager you like to use:
```bash
npm install --save-dev eslint@^8.57 @garraflavatra/yeslint
2023-07-27 21:56:03 +02:00
```
```bash
pnpm add --save-dev eslint@^8.57 @garraflavatra/yeslint
2023-07-27 21:56:03 +02:00
```
```bash
bun add --save-dev eslint@^8.57 @garraflavatra/yeslint
2023-07-27 21:56:03 +02:00
```
2024-07-25 13:28:19 +02:00
## Usage
After installing the package, tell ESLint to extend its configuration. Either add it to `.eslintrc.json`, set it as the default export in `.eslintrc.js`, or add it to your `package.json` under the `"eslintConfig"` key.
2023-07-27 21:56:03 +02:00
Please consider the following example. You should replace `<name>` with the name of the configuration you want to use.
```javascript
module.exports = {
2023-07-28 20:33:10 +02:00
extends: './node_modules/@garraflavatra/yeslint/configs/<name>.js',
2023-07-27 21:56:03 +02:00
};
```
Or add this to your `package.json` file:
```json
"eslintConfig": {
2023-07-28 20:33:10 +02:00
"extends": "./node_modules/@garraflavatra/yeslint/configs/<name>.js"
2023-07-27 21:56:03 +02:00
}
```
After installing, run `npx eslint .` to lint your code for the first time, or use `npx eslint --fix .` to lint while automatically fixing all auto-fixable problems ESLint finds in your codebase.
2024-07-25 13:28:19 +02:00
## Feedback
Please feel free to [report](https://github.com/garraflavatra/yeslint/issues/new) any issues and questions! Much appreciated :)
2023-07-27 21:56:03 +02:00
## Author & license
© [Romein van Buren](mailto:romein@vburen.nl) 2023-2024. yeslint! is released under the MIT license — see LICENSE for the full license text.
2023-07-27 21:56:03 +02:00
2024-07-29 15:57:04 +02:00
[![Smart Yellow](https://code.smartyellow.net/smartyellow/meta/raw/branch/main/logo.png)](https://www.smartyellow.nl)
2023-07-27 21:56:03 +02:00
[ESLint]: https://eslint.org/
[Svelte]: https://svelte.dev/
[npm]: https://www.npmjs.com/
[pnpm]: https://pnpm.io/
2024-07-25 13:28:19 +02:00
[Bun]: https://bun.sh/