ESLint Config

Appearance

ESLint ConfigAn opinionated ESLint config preset

Battle-tested, TypeScript & Vue ready, works with Prettier

Get Started
View Configs
Inspector
⚡️

Zero Config

Works out of the box with sensible defaults. Just install and start linting.

🎯

Opinionated

Single quote, no semicolons, trailing commas. Battle-tested preferences from real projects.

📦

All-in-One

Support for TypeScript, Vue, JSON, Markdown, YAML, TOML, SVG, Astro, Svelte, and more.

🔧

Customizable

Easy to override rules and add custom configurations for your specific needs.

🪄

Auto-detect

Automatically applies the right configs based on your project structure.

🎨

Formatter Ready

Designed to work seamlessly with formatters like prettier or oxfmt. No conflicts, just clean code.

🛡️

Strict but Sensible

Catches real bugs while staying pragmatic. Guards your codebase effectively.

🚀

ESLint 9 + Flat Config

Built on the latest ESLint with modern flat config for better performance.

💡

Command Shortcuts

Use magic ESLint commands to quickly disable rules or add ignores inline.

Quick Start ​

Install the package:

shell
npm i eslint typescript @ntnyq/eslint-config -D
shell
pnpm add eslint typescript @ntnyq/eslint-config -D
shell
yarn add eslint typescript @ntnyq/eslint-config -D
shell
bun add eslint typescript @ntnyq/eslint-config -D

Create eslint.config.mjs:

js
// @ts-check

import { defineESLintConfig } from '@ntnyq/eslint-config'

export default defineESLintConfig()

Add lint scripts:

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

That's it! 🎉

What's Included? ​

  • JavaScript & TypeScript: Full support with strict typing rules
  • Vue 3: SFC linting with composition API support
  • Frameworks: Astro, Svelte (opt-in)
  • Data Formats: JSON, JSONC, YAML, TOML
  • Markdown: Lint code blocks and prose
  • SVG: SVGO optimization rules
  • Node.js: Best practices for Node.js projects
  • Tests: Vitest, Jest support
  • Import/Export: Smart import sorting and organization

Resources ​

Credits ​

This config is inspired by and built upon amazing work from:

License ​

MIT License © 2023-PRESENT ntnyq