# @vinicunca/eslint-config ::note This is a fork from [anftu's ESLint config](https://github.com/antfu/eslint-config){rel="nofollow"}. A lot of the configs and plugins are based from his repo. This config add additional plugins and override other rules. Kudos for the amazing work for him. :: ## Features - Auto fix for formatting (aimed to be used standalone **without** Prettier) - Reasonable defaults, best practices, only one line of config - Designed to work with TypeScript, JSX, Vue, JSON, YAML, Toml, Markdown, etc. Out-of-box. - Opinionated, but [very customizable](https://vinicunca.dev/#customization) - Optional [React](https://vinicunca.dev/#react), [Next.js](https://vinicunca.dev/#nextjs), [Svelte](https://vinicunca.dev/#svelte), [UnoCSS](https://vinicunca.dev/#unocss), [Astro](https://vinicunca.dev/#astro), [Solid](https://vinicunca.dev/#solid) support - Optional [formatters](https://vinicunca.dev/#formatters) support for formatting CSS, HTML, XML, etc. - **Style principle**: Minimal for reading, stable for diff, consistent - Sorted imports, dangling commas - Single quotes, no semi - Using [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic){rel="nofollow"} - Respects `.gitignore` by default - Requires ESLint v9.5.0+ ## Usage ### Install ::code-group{sync="pm"} ```bash [pnpm] pnpm add -D eslint @vinicunca/eslint-config ``` ```bash [npm] npm install -D eslint @vinicunca/eslint-config ``` ```bash [bun] bun add -d eslint @vinicunca/eslint-config ``` :: And create `eslint.config.mjs` in your project root: ```ts [eslint.config.mjs] import { vinicuncaESLint } from '@vinicunca/eslint-config'; export default vinicuncaESLint(); ``` ### Add script for package.json For example: ```json [package.json] { "scripts": { "lint": "eslint", "lint:fix": "eslint --fix" } } ``` ## IDE Support (auto fix on save) ::collapsible{name="VS Code Support"} Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint){rel="nofollow"} then add the following settings to your `.vscode/settings.json`: ```jsonc { // Disable the default formatter, use eslint instead "prettier.enable": false, "editor.formatOnSave": false, // Auto fix "editor.codeActionsOnSave": { "source.fixAll.eslint": "explicit", "source.organizeImports": "never" }, // Enable eslint for all supported languages "eslint.validate": [ "javascript", "javascriptreact", "typescript", "typescriptreact", "vue", "html", "markdown", "json", "jsonc", "yaml", "toml", "xml", "gql", "graphql", "astro", "svelte", "css", "less", "scss", "pcss", "postcss" ] } ``` :: ::collapsible{name="Neovim Support"} Update your configuration to use the following: ```lua local customizations = { { rule = 'style/*', severity = 'off', fixable = true }, { rule = 'format/*', severity = 'off', fixable = true }, { rule = '*-indent', severity = 'off', fixable = true }, { rule = '*-spacing', severity = 'off', fixable = true }, { rule = '*-spaces', severity = 'off', fixable = true }, { rule = '*-order', severity = 'off', fixable = true }, { rule = '*-dangle', severity = 'off', fixable = true }, { rule = '*-newline', severity = 'off', fixable = true }, { rule = '*quotes', severity = 'off', fixable = true }, { rule = '*semi', severity = 'off', fixable = true }, } local lspconfig = require('lspconfig') -- Enable eslint for all supported languages lspconfig.eslint.setup( { filetypes = { "javascript", "javascriptreact", "javascript.jsx", "typescript", "typescriptreact", "typescript.tsx", "vue", "html", "markdown", "json", "jsonc", "yaml", "toml", "xml", "gql", "graphql", "astro", "svelte", "css", "less", "scss", "pcss", "postcss" }, settings = { -- Silent the stylistic rules in your IDE, but still auto fix them rulesCustomizations = customizations, }, } ) ``` ### Neovim format on save There's few ways you can achieve format on save in neovim: - `nvim-lspconfig` has a `EslintFixAll` command predefined, you can create a autocmd to call this command after saving file. ```lua lspconfig.eslint.setup({ --- ... on_attach = function(client, bufnr) vim.api.nvim_create_autocmd("BufWritePre", { buffer = bufnr, command = "EslintFixAll", }) end, }) ``` - Use [conform.nvim](https://github.com/stevearc/conform.nvim){rel="nofollow"}. - Use [none-ls](https://github.com/nvimtools/none-ls.nvim){rel="nofollow"} - Use [nvim-lint](https://github.com/mfussenegger/nvim-lint){rel="nofollow"} :: ## Customization Normally you only need to import the `eslint-config` preset: ```js [eslint.config.mjs] import { vinicuncaESLint } from '@vinicunca/eslint-config'; export default vinicuncaESLint(); ``` And that's it! Or you can configure each integration individually, for example: ```js [eslint.config.mjs] import { vinicuncaESLint } from '@vinicunca/eslint-config'; export default vinicuncaESLint( { // Type of the project. 'lib' for libraries, the default is 'app' type: 'lib', // `.eslintignore` is no longer supported in Flat config, use `ignores` instead // The `ignores` option in the option (first argument) is specifically treated to always be global ignores // And will **extend** the config's default ignores, not override them // You can also pass a function to modify the default ignores ignores: [ '**/fixtures', // ...globs ], // Parse the `.gitignore` file to get the ignores, on by default gitignore: true, // 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 autodetected, you can also explicitly enable them: typescript: true, vue: true, // Disable jsonc and yaml support jsonc: false, yaml: false, } ); ``` The `vinicuncaESLint` factory function also accepts any number of arbitrary custom config overrides: ```js [eslint.config.mjs] import { vinicuncaESLint } from '@vinicunca/eslint-config'; export default vinicuncaESLint( { // Configures for vinicuncaESLint's config }, // 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: ::collapsible{name="Advanced Example"} 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. ```js [eslint.config.mjs] import { combine, comments, ignores, imports, javascript, jsdoc, jsonc, markdown, node, sortPackageJson, sortTsconfig, stylistic, toml, typescript, unicorn, vue, yaml, } from '@vinicunca/eslint-config'; export default combine( ignores(), javascript(/* Options */), comments(), node(), jsdoc(), imports(), unicorn(), typescript(/* Options */), stylistic(), vue(), jsonc(), yaml(), toml(), markdown(), ); ``` :: Check out the [configs](https://github.com/vinicunca/eslint-config/blob/main/src/configs){rel="nofollow"} and [factory](https://github.com/vinicunca/eslint-config/blob/main/src/base.ts){rel="nofollow"} for more details. ### Plugins Renaming Since flat config requires us to explicitly provide the plugin names (instead of the mandatory convention from npm package name), we renamed some plugins to make the overall scope more consistent and easier to write. | New Prefix | Original Prefix | Source Plugin | | ---------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------- | | `import/*` | `import-lite/*` | [eslint-plugin-import-lite](https://github.com/9romise/eslint-plugin-import-lite){rel="nofollow"} | | `node/*` | `n/*` | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n){rel="nofollow"} | | `yaml/*` | `yml/*` | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml){rel="nofollow"} | | `ts/*` | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint){rel="nofollow"} | | `style/*` | `@stylistic/*` | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic){rel="nofollow"} | | `test/*` | `vitest/*` | [@vitest/eslint-plugin](https://github.com/vitest-dev/eslint-plugin-vitest){rel="nofollow"} | | `test/*` | `no-only-tests/*` | [eslint-plugin-no-only-tests](https://github.com/levibuzolic/eslint-plugin-no-only-tests){rel="nofollow"} | | `next/*` | `@next/next` | [@next/eslint-plugin-next](https://github.com/vercel/next.js/tree/canary/packages/eslint-plugin-next){rel="nofollow"} | When you want to override rules, or disable them inline, you need to update to the new prefix: ```diff -// eslint-disable-next-line @typescript-eslint/consistent-type-definitions +// eslint-disable-next-line ts/consistent-type-definitions type foo = { bar: 2 } ``` ::caution Warning :br About plugin renaming - it is actually rather a dangerous move that might lead to potential naming collisions, pointed out [here](https://github.com/eslint/eslint/discussions/17766){rel="nofollow"} and [here](https://github.com/prettier/eslint-config-prettier#eslintconfigjs-flat-config-plugin-caveat){rel="nofollow"}. As this config also very **personal** and **opinionated**, I ambitiously position this config as the only **"top-level"** config per project, that might pivots the taste of how rules are named. :br This config cares more about the user-facings DX, and try to ease out the implementation details. For example, users could keep using the semantic `import/order` without ever knowing the underlying plugin has migrated twice to `eslint-plugin-i` and then to `eslint-plugin-import-x`. User are also not forced to migrate to the implicit `i/order` halfway only because we swapped the implementation to a fork. :: This preset will automatically rename the plugins also for your custom configs. You can use the original prefix to override the rules directly. ::collapsible{name="Change back to original prefix"} If you really want to use the original prefix, you can revert the plugin renaming by: ```ts import { vinicuncaESLint } from '@vinicunca/eslint-config'; export default vinicuncaESLint() .renamePlugins({ ts: '@typescript-eslint', yaml: 'yml', node: 'n' // ... }); ``` :: ### 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: ```js [eslint.config.mjs] import { vinicuncaESLint } from '@vinicunca/eslint-config'; export default vinicuncaESLint( { 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: ```js [eslint.config.mjs] import { vinicuncaESLint } from '@vinicunca/eslint-config'; export default vinicuncaESLint({ vue: { overrides: { 'vue/operator-linebreak': ['error', 'before'], }, }, typescript: { overrides: { 'ts/consistent-type-definitions': ['error', 'interface'], }, }, yaml: { overrides: { // ... }, }, }); ``` ### Config Composer The factory function `vinicuncaESLint()` returns a [`FlatConfigComposer` object from `eslint-flat-config-utils`](https://github.com/antfu/eslint-flat-config-utils#composer){rel="nofollow"} where you can chain the methods to compose the config even more flexibly. ```js [eslint.config.mjs] import { vinicuncaESLint } from '@vinicunca/eslint-config'; export default vinicuncaESLint() .prepend( // some configs before the main config ) // overrides any named configs .override( 'antfu/stylistic/rules', { rules: { 'style/generator-star-spacing': ['error', { after: true, before: false }], } } ) // rename plugin prefixes .renamePlugins({ 'old-prefix': 'new-prefix', // ... }); // ... ``` ### Vue Vue support is detected automatically by checking if `vue` is installed in your project. You can also explicitly enable/disable it: ```js [eslint.config.mjs] import { vinicuncaESLint } from '@vinicunca/eslint-config'; export default vinicuncaESLint({ vue: true }); ``` #### Vue Accessibility To enable Vue accessibility support, you need to explicitly turn it on: ```js [eslint.config.mjs] import { vinicuncaESLint } from '@vinicunca/eslint-config'; export default vinicuncaESLint({ vue: { a11y: true }, }); ``` Running `pnpx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually: ::code-group{sync="pm"} ```bash [pnpm] pnpm add -D eslint-plugin-vuejs-accessibility ``` ```bash [npm] npm install -D eslint-plugin-vuejs-accessibility ``` ```bash [bun] bun add -d eslint-plugin-vuejs-accessibility ``` :: ### Optional Configs We provide some optional configs for specific use cases, that we don't include their dependencies by default. #### Formatters Use external formatters to format files that ESLint cannot handle yet (`.css`, `.html`, etc). Powered by [`eslint-plugin-format`](https://github.com/antfu/eslint-plugin-format){rel="nofollow"}. ```js [eslint.config.mjs] import { vinicuncaESLint } from '@vinicunca/eslint-config'; export default vinicuncaESLint({ formatters: { /** * Format CSS, LESS, SCSS files, also the `