Antfu Eslint Config
An opinionated, auto-fixing ESLint flat config preset for TypeScript, Vue, React, and more, designed to work standalone without Prettier.
What is Antfu Eslint Config?
@antfu/eslint-config is an opinionated ESLint configuration preset that provides a comprehensive set of linting and formatting rules for modern JavaScript and TypeScript projects. It solves the problem of fragmented tooling by offering a single, auto-fixing configuration that works across multiple file types and frameworks without requiring Prettier. The config is designed to enforce consistent code style, best practices, and minimal diffs through ESLint's flat config system.
Frontend and full-stack developers working with TypeScript, Vue, React, or related frameworks who want a pre-configured, opinionated linting setup that reduces configuration overhead and integrates seamlessly into their workflow.
Developers choose this config for its zero-config approach, auto-fixing capabilities, and broad framework support out of the box. Its unique selling point is the ability to replace Prettier entirely while maintaining a highly customizable, composable configuration that respects modern ESLint flat config conventions.
Overview
Anthony's ESLint config preset
Use Cases
Best For
- Setting up a consistent linting and formatting workflow for TypeScript projects
- Replacing Prettier with ESLint-based auto-formatting
- Enforcing code style in Vue or React applications with minimal configuration
- Migrating legacy ESLint configurations to the new flat config format
- Linting multi-language projects that include JSON, YAML, Markdown, and TOML files
- Teams adopting opinionated code style rules to reduce bike-shedding
Not Ideal For
- Projects that rely heavily on Prettier and resist migrating to ESLint for formatting due to established workflows
- Teams with extensive, custom ESLint configurations that would conflict with the preset's opinionated rules and plugin renaming
- Environments stuck on older ESLint versions (pre-v9.5.0) or legacy config formats incompatible with flat config
- Vue 2 codebases seeking long-term support, as maintenance is limited and may be dropped
Pros & Cons
Pros
Aims to replace Prettier by handling code formatting directly through ESLint rules, providing automatic fixes on save as stated in the README's key features.
Leverages ESLint's modern flat config system for easy customization and extension, allowing setup with a single line of code as shown in the usage examples.
Out-of-the-box support for TypeScript, Vue, JSX, and multiple file types, with optional integrations for React, Next.js, and Svelte, reducing configuration overhead.
Enforces a consistent style with rules like single quotes and sorted imports, minimizing diff instability and bike-shedding across teams.
Cons
Based on personal preferences that may not align with all teams, requiring frequent rule overrides or forking, as cautioned in the README's warnings.
Renames ESLint plugins to simplify prefixes, but this can cause naming collisions and integration issues with other configs, a risk acknowledged in the documentation.
Requires non-trivial setup for IDEs like VS Code and Neovim to enable auto-fix on save, involving multiple settings changes that can be error-prone.
Frequently Asked Questions
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.