如何用Antfu的ESLint配置打造极致代码品质?
还在为代码风格不统一而烦恼吗?🤔 想要一键提升项目代码质量?Antfu的ESLint配置预设正是你的绝佳选择!这款由知名开发者Anthony Fu精心打造的配置集合,专为追求代码品质的现代开发者设计。✨
🚀 快速入门:5分钟搞定专业级代码检查
安装配置超简单,只需一行命令:
pnpm i -D eslint @antfu/eslint-config
创建配置文件 eslint.config.mjs:
import antfu from '@antfu/eslint-config'
export default antfu()
就是这么简单!🎉 现在你的项目已经拥有了:
- 自动格式化修复(无需Prettier)
- 合理的默认值和最佳实践
- TypeScript、JSX、Vue等多格式支持
- 开箱即用的现代化配置
📊 传统配置 vs Antfu配置对比
| 特性 | 传统ESLint配置 | Antfu配置 |
|---|---|---|
| 安装复杂度 | 高(需要多个插件) | 低(一键安装) |
| 格式化支持 | 需要Prettier配合 | 内置格式化 |
| 配置文件大小 | 冗长(100+行) | 简洁(1-3行) |
| 多格式支持 | 需要手动配置 | 开箱即用 |
| 更新维护 | 困难(手动更新) | 自动(持续维护) |
🛠️ 实战案例:Vue 3项目配置
import antfu from '@antfu/eslint-config'
export default antfu({
vue: {
vueVersion: 3,
a11y: true // 启用无障碍支持
},
typescript: true,
stylistic: {
indent: 2,
quotes: 'single'
}
})
运行检查命令:
pnpm lint # 检查代码
pnpm lint:fix # 自动修复
💡 最佳实践建议
1. IDE集成配置(VS Code)
在 .vscode/settings.json 中添加:
{
"prettier.enable": false,
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
}
}
2. Git Hook自动化
在 package.json 中配置:
{
"simple-git-hooks": {
"pre-commit": "npx lint-staged"
},
"lint-staged": {
"*": "eslint --fix"
}
}
🎯 特色功能亮点
🔧 智能插件重命名
将复杂的插件前缀简化为易记的名称:
@typescript-eslint/*→ts/*@stylistic/*→style/*yml/*→yaml/*
🌈 多框架支持
- React:
react: true - Next.js:
nextjs: true - Svelte:
svelte: true - Astro:
astro: true - Solid:
solid: true
⚡ 格式化器集成
支持CSS、HTML、Markdown等文件的外部格式化器:
formatters: {
css: true, // 格式化CSS文件
html: true, // 格式化HTML文件
markdown: 'prettier' // Markdown使用Prettier
}
❓ 常见问题解答
Q: 还需要安装Prettier吗? A: 不需要!Antfu配置内置了格式化功能,可以完全替代Prettier。🚫
Q: 如何自定义规则? A: 在配置对象中添加rules字段即可覆盖默认规则:
export default antfu({
rules: {
'style/semi': ['error', 'never']
}
})
Q: 支持Vue 2吗? A: 有限支持,建议升级到Vue 3以获得完整功能。📈
🎉 开始使用吧!
Antfu的ESLint配置不仅提升了代码质量,更极大地改善了开发体验。无论是个人项目还是团队协作,这都是一个值得尝试的优秀工具。现在就去体验一键配置的便利吧!✨
提示:记得定期更新配置以获得最新的规则和改进功能。🔄
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



