Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dethdkn/eslint-config
🧹 My Opinionated ESLint Config
https://github.com/dethdkn/eslint-config
Last synced: about 2 months ago
JSON representation
🧹 My Opinionated ESLint Config
- Host: GitHub
- URL: https://github.com/dethdkn/eslint-config
- Owner: dethdkn
- License: mit
- Created: 2024-05-23T04:23:07.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-27T14:01:56.000Z (about 2 months ago)
- Last Synced: 2024-12-02T07:59:17.324Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://eslint.rosa.dev.br
- Size: 480 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
@dethdkn/eslint-config
🧹 My Opinionated ESLint Config
## 📦 About This Package
This is my opinionated `eslint-config`, heavily inspired by Antfu's config. This setup is a combination of the following rules:
-
Stylistic
-
Antfu
-
Javascript
-
Unused Imports
-
Eslint Comments
-
Node
-
Promise
-
Security
-
JSDoc
-
Import X
-
Unicorn
-
Perfectionist
-
Regexp
-
Typescript
-
Vitest
-
Json
-
Vue
-
TailwindCSS
-
CSS
-
Nuxt
-
Accessibility
-
I18n
-
Yaml
-
Toml
- And more...
Click here to check all enabled rules
## 🚀 Setup
1. Install with your favorite package manager:
- **pnpm** : `pnpm add -D eslint @dethdkn/eslint-config`
- npm : `npm i -D eslint @dethdkn/eslint-config`
- yarn : `yarn add -D eslint @dethdkn/eslint-config`
- bun : `bun add -D eslint @dethdkn/eslint-config`
2. Create a `eslint.config.mjs` in the project root:
```js
// eslint.config.mjs
import dethdkn from '@dethdkn/eslint-config'
export default dethdkn()
```
3. Add lint scripts to `package.json`:
```json
{
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix"
}
}
```
4. Add the following configuration to `.vscode/settings.json`:
```json
{
// Disable the default formatter, use eslint instead
"prettier.enable": false,
"editor.formatOnSave": false,
// Auto fix
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.organizeImports": "never"
},
// Silent the stylistic rules in you IDE, but still auto fix them
"eslint.rules.customizations": [
{ "rule": "style/*", "severity": "off" },
{ "rule": "format/*", "severity": "off" },
{ "rule": "*-indent", "severity": "off" },
{ "rule": "*-spacing", "severity": "off" },
{ "rule": "*-spaces", "severity": "off" },
{ "rule": "*-order", "severity": "off" },
{ "rule": "*-dangle", "severity": "off" },
{ "rule": "*-newline", "severity": "off" },
{ "rule": "*quotes", "severity": "off" },
{ "rule": "*semi", "severity": "off" }
],
// Enable eslint for all supported languages
"eslint.validate": [
"javascript",
"typescript",
"vue",
"html",
"markdown",
"json",
"jsonc",
"yaml",
"toml",
"xml",
"gql",
"graphql",
]
}
```
## ⚙️ Options
- `tailwind` and `nuxt` rules can be disabled:
```js
// eslint.config.mjs
import dethdkn from '@dethdkn/eslint-config'
export default dethdkn({tailwind: false, nuxt: false})
```
- `i18n` rules can be enabled:
```js
// eslint.config.mjs
import dethdkn from '@dethdkn/eslint-config'
export default dethdkn({i18n: true})
```
## 📝 License
Copyright © 2024 [Gabriel 'DethDKN' Rosa](https://github.com/dethdkn)\
This project is under [MIT license](https://github.com/dethdkn/eslint-config/blob/main/LICENSE)