@kolhe/eslint-config

One Eslint Config to rule them all. Supports JavaScript, TypeScript, Vue 3, Prettier and much more out of the box.

Features

• Format with Prettier.
• Designed to work with TypeScript, Vue out-of-box.
• Support JSON(5), YAML, Markdown...
• Sort imports, package.json, tsconfig.json...
• ESLint Flat config, compose easily!
• Ignores common files like dist, node_modules, coverage, and files in .gitignore.
• Reasonable defaults, best practices, only one-line of config
• Reasonable strict, but with better code quality.

Install

yarn add -D @kolhe/eslint-config

Require Node.js >= 18.18, and ESLint >= 9.5.0.

Eslint Config Usage

import { eslintConfig } from '@kolhe/eslint-config'
export default eslintConfig(
  // Features: it'll detect installed dependency and enable necessary features automatically
  {
    prettier: true, // to enable eslint prettier plugin
    markdown: true,
    vue: true, // auto detection
    unocss: false // auto detection
  },
  [
    /* your custom config */
  ]
).removeRules('foo/bar') // see more in https://github.com/antfu/eslint-flat-config-utils

Presets

// eslint.config.js
import {
  presetJavaScript, // Ignore common files and include javascript support
  presetJsonc, // Includes basic json(c) file support and sorting json keys
  presetLangsExtensions, // Includes markdown, yaml + `presetJsonc` support
  presetBasic, // Includes `presetJavaScript` and typescript support

  // Includes
  // - `presetBasic` (JS+TS) support
  // - `presetLangsExtensions` (markdown, yaml, jsonc) support
  // - Vue support
  // - UnoCSS support (`uno.config.ts` is required)
  // - Prettier support
  presetAll
} from '@kolhe/eslint-config'

export default presetAll

See preset.ts for more details.

Prettier Config Usage

This config also provides a Prettier config for code formatting. For IDE integration, CLI usage, or to configure Prettier independently, create a prettier.config.js file:

// prettier.config.js
import { prettierConfig } from '@kolhe/eslint-config'

export default prettierConfig

Or extend it with your own customizations:

// prettier.config.js
import { prettierConfig } from '@kolhe/eslint-config'

export default {
  ...prettierConfig,
  // Your custom overrides
  semi: true,
  singleQuote: false
}

License

MIT License © 2022-PRESENT Sumit Kolhe