@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:

// eslint.config.mjs
import dethdkn from '@dethdkn/eslint-config'

export default dethdkn()

3. Add lint scripts to package.json:

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix"
  }
}

4. Add the following configuration to .vscode/settings.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:

// eslint.config.mjs
import dethdkn from '@dethdkn/eslint-config'

export default dethdkn({tailwind: false, nuxt: false})

• i18n rules can be enabled:

// eslint.config.mjs
import dethdkn from '@dethdkn/eslint-config'

export default dethdkn({i18n: true})

📝 License

Copyright © 2024 Gabriel 'DethDKN' Rosa
This project is under MIT license