We provided a CLI tool to help you set up your project, or migrate from the legacy config to the new flat config with one command.
pnpm dlx @avanlan/eslint-config@latestIf you prefer to set up manually:
pnpm i -D eslint @avanlan/eslint-configAnd create eslint.config.mjs in your project root:
// eslint.config.mjs
import avanlan from '@avanlan/eslint-config'
export default avanlan()Combined with legacy config:
If you still use some configs from the legacy eslintrc format, you can use the @eslint/eslintrc package to convert them to the flat config.
// eslint.config.mjs
import antfu from '@avanlan/eslint-config'
import { FlatCompat } from '@eslint/eslintrc'
const compat = new FlatCompat()
export default antfu(
{
ignores: [],
},
// Legacy config
...compat.config({
extends: [
'eslint:recommended',
// Other extends...
],
})
// Other flat configs...
)Note that
.eslintignoreno longer works in Flat config, see customization for more details.
For example:
{
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix"
}
}