@ivanmaxlogiudice/eslint-config v2.0.1
@ivanmaxlogiudice/eslint-config
Personal Flat ESLint configuration for Javascript, TypeScript, Vue 3.
based on @antfu/eslint-config
Features
- Single quotes, no semi
- Auto fix for formatting (aimed to be used standalone without Prettier)
- Designed to work with TypeScript, JSX, Vue out-of-box
- Lint also for json, yaml, markdown
- Sorted imports, dangling commas
- Reasonable defaults, best practices, only one-line of config
- Respects
.gitignore
by default - Optional formatters support for CSS, HTML, etc.
- ESLint Flat config, compose easily!
- Using ESLint Stylistic
- Using ESLint Perfectionist for sorting
- Style principle: Minimal for reading, stable for diff, consistent
Usage
Starter Wizard
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.
pnpx @ivanmaxlogiudice/eslint-config@latest
Manual Install
If you prefer to set up manually:
pnpm add -D @ivanmaxlogiudice/eslint-config
And create eslint.config.mjs
in your project root:
// eslint.config.mjs
import config from '@ivanmaxlogiudice/eslint-config'
export default 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 { FlatCompat } from '@eslint/eslintrc'
import config from '@ivanmaxlogiudice/eslint-config'
const compat = new FlatCompat()
export default config(
{
ignores: [],
},
// Legacy config
...compat.config({
extends: [
'eslint:recommended',
// Other extends...
],
})
// Other flat configs...
)
Note that
.eslintignore
no longer works in Flat config, see customization for more details.
Add script for package.json
For example:
{
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix"
}
}
Migration
We provided an experimental CLI tool to help you migrate from the legacy config to the new flat config.
# pnpm
pnpx @ivanmaxlogiudice/eslint-config@latest
Options:
-y, --yes Skip prompts and use default values
-i, --ignore-git Skip uncommitted changes
Before running the migration, make sure to commit your unsaved changes first.
VS Code support (auto fix on save)
Install VS Code ESLint extension
Add the following settings to your settings.json
:
{
// Enable the flat config support
"eslint.useFlatConfig": true,
// Disable the default formatter
"prettier.enable": false,
"editor.formatOnSave": false,
// Auto fix
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.organizeImports": "never"
},
// Silent the stylistic rules in you IDE, but still auto fix them
"eslint.rules.customizations": [
{ "rule": "style/*", "severity": "off" },
{ "rule": "format/*", "severity": "off" },
{ "rule": "*-indent", "severity": "off" },
{ "rule": "*-spacing", "severity": "off" },
{ "rule": "*-spaces", "severity": "off" },
{ "rule": "*-order", "severity": "off" },
{ "rule": "*-dangle", "severity": "off" },
{ "rule": "*-newline", "severity": "off" },
{ "rule": "*quotes", "severity": "off" },
{ "rule": "*semi", "severity": "off" }
],
// The following is optional.
// It's better to put under project setting `.vscode/settings.json`
// to avoid conflicts with working with different eslint configs
// that does not support all formats.
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact",
"vue",
"html",
"markdown",
"json",
"jsonc",
"gql",
"graphql"
]
}
Customization
Normally you only need to import the config
preset:
// eslint.config.js
import config from '@ivanmaxlogiudice/eslint-config'
export default config()
And that's it! Or you can configure each integration individually, for example:
// eslint.config.js
import config from '@ivanmaxlogiudice/eslint-config'
export default config({
// Enable stylistic formatting rules
// stylistic: true,
// Or customize the stylistic rules
stylistic: {
indent: 2, // 4, or 'tab'
quotes: 'single', // or 'double'
},
// TypeScript and Vue are auto-detected, you can also explicitly enable them:
typescript: true,
vue: true,
// Disable jsonc and yaml support
jsonc: false,
yaml: false,
// `.eslintignore` is no longer supported in Flat config, use `ignores` instead
ignores: [
'**/fixtures',
// ...globs
]
})
The config
factory function also accepts any number of arbitrary custom config overrides:
// eslint.config.js
import config from '@ivanmaxlogiudice/eslint-config'
export default config(
{
// Configuration
},
// From the second arguments they are ESLint Flat Configs
// you can have multiple configs
{
files: ['**/*.ts'],
rules: {},
},
{
rules: {},
},
)
Going more advanced, you can also import fine-grained configs and compose them as you wish:
We wouldn't recommend using this style in general unless you know exactly what they are doing, as there are shared options between configs and might need extra care to make them consistent.
// eslint.config.js
import {
comments,
ignores,
imports,
javascript,
jsdoc,
jsonc,
markdown,
node,
perfectionist,
sortPackageJson,
sortTsconfig,
stylistic,
test,
typescript,
unicorn,
unocss,
vue,
yaml,
} from '@ivanmaxlogiudice/eslint-config'
export default [
...comments(),
...ignores(),
...imports(),
...javascript(/* options */),
...jsdoc(),
...jsonc(),
...markdown(),
...node(),
...perfectionist(),
...sortPackageJson(),
...sortTsconfig(),
...stylistic(),
...test(),
...typescript(/* options */),
...unicorn(),
...unocss(),
...vue(),
...yaml(),
]
Check out the configs and factory for more details.
Plugins Renaming
Since flat config requires us to explicitly provide the plugin names (instead of mandatory convention from npm package name), we renamed some plugins to make overall scope more consistent and easier to write.
New Prefix | Original Prefix | Source Plugin |
---|---|---|
import/* | import-x/* | eslint-plugin-import-x |
node/* | n/* | eslint-plugin-n |
yaml/* | yml/* | eslint-plugin-yml |
ts/* | @typescript-eslint/* | @typescript-eslint/eslint-plugin |
style/* | @stylistic/* | @stylistic/eslint-plugin |
test/* | vitest/* | eslint-plugin-vitest |
test/* | no-only-tests/* | eslint-plugin-no-only-tests |
When you want to override rules, or disable them inline, you need to update to the new prefix:
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+// eslint-disable-next-line ts/consistent-type-definitions
type foo = { bar: 2 }
Since v2.0.0, this preset will automatically rename the plugins also for your custom configs. You can use the original prefix to override the rules directly.
Rules Overrides
Certain rules would only be enabled in specific files, for example, ts/*
rules would only be enabled in .ts
files and vue/*
rules would only be enabled in .vue
files. If you want to override the rules, you need to specify the file extension:
// eslint.config.js
import config from '@ivanmaxlogiudice/eslint-config'
export default config(
{
vue: true,
typescript: true
},
{
// Remember to specify the file glob here, otherwise it might cause the vue plugin to handle non-vue files
files: ['**/*.vue'],
rules: {
'vue/operator-linebreak': ['error', 'before'],
},
},
{
// Without `files`, they are general rules for all files
rules: {
'style/semi': ['error', 'never'],
},
}
)
We also provided the overrides
options in each integration to make it easier:
// eslint.config.js
import config from '@ivanmaxlogiudice/eslint-config'
export default config({
vue: {
overrides: {
'vue/operator-linebreak': ['error', 'before'],
},
},
typescript: {
overrides: {
'ts/consistent-type-definitions': ['error', 'interface'],
},
},
yaml: {
overrides: {
// ...
},
},
})
Config Composer
Since v2.0.0, the factory function config()
returns a FlatConfigComposer
object from eslint-flat-config-utils
where you can chain the methods to compose the config even more flexibly.
// eslint.config.js
import config from '@ivanmaxlogiudice/eslint-config'
export default config()
.prepend(
// some configs before the main config
)
// overrides any named configs
.override(
'antfu/imports',
{
rules: {
'import/order': ['error', { 'newlines-between': 'always' }],
}
}
)
// rename plugin prefixes
.renamePlugins({
'old-prefix': 'new-prefix',
// ...
})
// ...
Optional Configs
We provide some optional configs for specific use cases, that we don't include their dependencies by default.
Formatters
!WARNING Experimental feature, changes might not follow semver. Use external formatters to format files that ESLint cannot handle yet (
.css
,.html
, etc). Powered byeslint-plugin-format
.
// eslint.config.js
import config from '@ivanmaxlogiudice/eslint-config'
export default config({
// Enable all formatters
// formatters: true,
// Or customize the formatters
formatters: {
/**
* Format CSS, LESS, SCSS files, also the `<style>` blocks in Vue
* By default uses Prettier
*/
css: true,
/**
* Format HTML files
* By default uses Prettier
*/
html: true,
/**
* Format Markdown files
* Supports Prettier and dprint
* By default uses Prettier
*/
markdown: 'prettier'
}
})
Running pnpx eslint
should prompt you to install the required dependencies, otherwise, you can install them manually:
pnpm add -D eslint-plugin-format
UnoCSS
UnoCSS is auto-detected, you can also explicitly enable them:
// eslint.config.js
import config from '@ivanmaxlogiudice/eslint-config'
export default config({
unocss: true,
})
Running pnpx eslint
should prompt you to install the required dependencies, otherwise, you can install them manually:
pnpm add -D @unocss/eslint-plugin
Optional Rules
This config also provides some optional plugins/rules for extended usage.
perfectionist
(sorting)
This plugin eslint-plugin-perfectionist
allows you to sort object keys, imports, etc, with auto-fix.
The plugin is installed, you can check the enabled rules for more info.
It's recommended to opt-in on each file individually using configuration comments.
/* eslint perfectionist/sort-objects: "error" */
const objectWantedToSort = {
a: 2,
b: 1,
c: 3,
}
Type Aware Rules
You can optionally enable the type aware rules by passing the options object to the typescript
config:
// eslint.config.js
import config from '@ivanmaxlogiudice/eslint-config'
export default config({
typescript: {
tsconfigPath: 'tsconfig.json',
// or if you have multiple tsconfigs
tsconfigPath: ['tsconfig.json', 'tsconfig.node.json', 'packages/*/tsconfig.json']
},
})
Editor Specific Disables
Some rules are disabled when inside ESLint IDE integrations, namely unused-imports/no-unused-imports
test/no-only-tests
This is to prevent unused imports from getting removed by the IDE during refactoring to get a better developer experience. Those rules will be applied when you run ESLint in the terminal or Lint Staged. If you don't want this behavior, you can disable them:
// eslint.config.js
import config from '@ivanmaxlogiudice/eslint-config'
export default config({
isInEditor: false
})
Lint Staged
If you want to apply lint and auto-fix before every commit, you can add the following to your package.json
:
{
"simple-git-hooks": {
"pre-commit": "pnpm lint-staged"
},
"lint-staged": {
"*": "eslint --fix"
}
}
and then
pnpm add -D lint-staged simple-git-hooks
View what rules are enabled
Use @eslint/config-inspector to view what rules are enabled in your project and apply them to what files,
Go to your project root that contains eslint.config.js
and run:
pnpx @eslint/config-inspector
FAQ
Prettier?
Why I don't use Prettier ? Check @antfu post
Well, you can still use Prettier to format files that are not supported well by ESLint yet, such as .css
, .html
, etc. See formatters for more details.
dprint?
dprint is also a great formatter that with more abilities to customize. However, it's in the same model as Prettier which reads the AST and reprints the code from scratch. This means it's similar to Prettier, which ignores the original line breaks and might also cause the inconsistent diff. So in general, we prefer to use ESLint to format and lint JavaScript/TypeScript code.
Meanwhile, we do have dprint integrations for formatting other files such as .md
. See formatters for more details.
How to format CSS?
You can opt-in to the formatters
feature to format your CSS. Note that it's only doing formatting, but not linting. If you want proper linting support, give stylelint
a try.
License
MIT License © 2022-PRESENT Iván M. Lo Giudice
13 days ago
14 days ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
10 months ago
9 months ago
9 months ago
7 months ago
7 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago