@ntnyq/eslint-config

ESLint flat config preset for modern frontend projects (TypeScript, Vue, JSON, Markdown, YAML, TOML, and more).

📋 Requirements

• Node.js ^22.23.0 || >=24.15.0
• ESLint ^10.4.0

Tip

Need legacy runtime support?

• Node.js v18: use v4
• Node.js < 20.19.0: use v5
• Node.js < 22.23.0: use v6

✨ Features

• 🚀 Works out of the box with ESLint flat config.
• 🔍 Auto-detects and enables configs by your dependencies and file types.
• 🧩 Covers common frontend files: TS, Vue SFC, JSON, Markdown, YAML, TOML.
• 🎨 Keeps formatting tool friendly (Prettier or oxfmt).
• 📈 Supports scaling from single apps to monorepos.

📦 Install

# pnpm
pnpm add -D eslint typescript @ntnyq/eslint-config

# npm
npm i -D eslint typescript @ntnyq/eslint-config

# yarn
yarn add -D eslint typescript @ntnyq/eslint-config

# bun
bun add -D eslint typescript @ntnyq/eslint-config

⚡ Quick start

1. Create eslint.config.mjs in project root.
2. Add npm scripts.
3. Run lint.

// eslint.config.mjs
// @ts-check

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

export default defineESLintConfig()

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

pnpm lint

🧰 Common Frontend Setups

💚 Vite + Vue 3 + TypeScript

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

export default defineESLintConfig({
  vue: true,
  typescript: {
    tsconfigPath: './tsconfig.app.json',
  },
})

⚛️ Vite + React + TypeScript

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

export default defineESLintConfig({
  vue: false,
  typescript: {
    tsconfigPath: './tsconfig.json',
  },
})

🏗️ Monorepo (apps + packages)

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

export default defineESLintConfig(
  {
    typescript: true,
    vue: true,
  },
  [
    {
      files: ['apps/web/**'],
      rules: {
        'no-console': 'warn',
      },
    },
    {
      files: ['packages/**'],
      rules: {
        'no-console': 'off',
      },
    },
  ],
)

⚙️ Configuration Patterns

🎛️ Enable or disable modules

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

export default defineESLintConfig({
  svgo: true,
  astro: true,
  jsdoc: false,
  unicorn: false,
})

🛠️ Override built-in rules

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

export default defineESLintConfig({
  vue: {
    overrides: {
      'vue/slot-name-casing': 'off',
    },
  },
  typescript: {
    overrides: {
      '@typescript-eslint/no-unused-vars': 'warn',
    },
  },
})

🧱 Add project-specific flat config blocks

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

export default defineESLintConfig({}, [
  {
    files: ['**/scripts/**'],
    rules: {
      'no-console': 'off',
    },
  },
])

🎨 Formatter Integration

Use one formatter strategy in a project:

• Prettier path: install prettier and optional @ntnyq/prettier-config
• Oxfmt path: install oxfmt

💅 Prettier example

pnpm add -D prettier @ntnyq/prettier-config

// prettier.config.mjs
// @ts-check

import { defineConfig } from '@ntnyq/prettier-config'

export default defineConfig()

🧑‍💻 VS Code example

{
  "eslint.enable": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "explicit",
    "source.organizeImports": "never",
    "source.sortImports": "never"
  }
}

🧩 Optional Configs (Disabled by Default)

• astro
• eslintPlugin
• html
• pnpm
• svelte
• svgo
• unusedImports

Enable them explicitly in defineESLintConfig({ ... }) when needed.

🔎 Inspect Final Rules

• Online inspector: eslint-config-inspector.ntnyq.com
• Local inspect: npx eslint --inspect-config path/to/file.ts

🧠 Advanced API

• Config options type
• Factory implementation

🏷️ Versioning Policy

This project follows Semantic Versioning with opinionated lint rules:

• Treated as breaking: Node.js engine changes, major plugin incompatibility, broad refactors.
• Treated as non-breaking: enabling/disabling rules, rule option tuning, dependency bumps.

🙏 Credits

• @sxzz/eslint-config
• @antfu/eslint-config

📄 License

MIT License © 2023-PRESENT ntnyq