auvred/eslint-config

⚙️ Opinionated ESLint config for Typescript and Vue projects

@auvred/eslint-config

Partially based on these awesome configs: @so1ve/eslint-config, @antfu/eslint-config

Features

• Single quotes, no semi, trailing commas
• Formatting with Prettier
• Typescript and Vue support out-of-box
• Sortable imports

Usage

Install

pnpm add -D @auvred/eslint-config eslint prettier

Config eslint.config.js

In ESM projects:

import { auvred } from '@auvred/eslint-config'

export default auvred()

In CJS projects:

module.exports = (async () => {
  const { auvred } = await import('@auvred/eslint-config')

  return auvred()
})()

Configure your editor

VS Code

Install dbaeumer.vscode-eslint extension

{
  "eslint.experimental.useFlatConfig": true,
  "prettier.enable": false,
  "editor.formatOnSave": false,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "explicit",
    "source.organizeImports": "never"
  },
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
    "vue",
    "html",
    "markdown",
    "json",
    "jsonc",
    "yaml"
  ],
  "eslint.rules.customizations": [
    { "rule": "auvred/prettier", "severity": "off" }
  ]
}

It's better to put these settings to workspace settings (.vscode/settings.json)

coc.nvim

Install coc-eslint extension

{
  "eslint.experimental.useFlatConfig": true,
  "eslint.autoFixOnSave": true,
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
    "vue",
    "html",
    "markdown",
    "json",
    "jsonc",
    "yaml"
  ],
  "eslint.rules.customizations": [
    { "rule": "auvred/prettier", "severity": "off" }
  ]
}

It's better to put these settings to workspace settings (.vim/coc-settings.json)

JetBrains IDEs

If you're working on project with eslint >= 8.23.0, it'd be better to update your IDE to version >= 2022.2.2 because of this issue

1. Open ESLint settings (docs)
2. Set linting scope to {**/*,*}.{js,jsx,ts,tsx,vue,html,md,json,jsonc,yaml,yml}

License

MIT