npm package: @infernodesign/eslint-config
Description: ESLint config for Inferno Design.
Author: Inferno Design
Latest version: 2.1.0

# @infernodesign/eslint-config

Shared ESLint flat config presets for Inferno Design projects. Orignally forked from [Antfu's eslint-config](https://github.com/antfu/eslint-config).

- Autofix for formatting (aimed to be used standalone **without** Prettier)
- Reasonable best practices and only one line of config.
- Designed to work with TypeScript, JSX, Vue, JSON, YAML, Toml, Markdown, etc. Out-of-box.
- Uses the [ESLint Flat Config](https://eslint.org/docs/latest/use/configure/configuration-files-new) for easy compilation.
- Optional [React](#react), [Next.js](#nextjs), [Svelte](#svelte), [UnoCSS](#unocss), [Astro](#astro), [Storybook](#storybook), [Solid](#solid) support, [TailwindCSS](#tailwindcss) support.
- Optional [formatters](#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)
- Respects `.gitignore` by default
- Requires ESLint v9.5.0+

## 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.

```bash
npx @infernodesign/eslint-config@latest
```

### Manual Install

If you prefer to set up manually:

```bash
npm i -D eslint @infernodesign/eslint-config
```

And create `eslint.config.mjs` in your project root:

```js
// eslint.config.mjs
import { config } from '@infernodesign/eslint-config'

export default config()
```

<details>
<summary>
Combined with legacy config:
</summary>

If you still use some configs from the legacy eslintrc format, you can use the [`@eslint/eslintrc`](https://www.npmjs.com/package/@eslint/eslintrc) package to convert them to the flat config.

```js
// eslint.config.mjs
import { FlatCompat } from '@eslint/eslintrc'
import { config } from '@infernodesign/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](#customization) for more details.

</details>

### Add script for package.json

For example:

```json
{
  "scripts": {
    "lint": "eslint",
    "lint:fix": "eslint --fix"
  }
}
```

## IDE Support (auto fix on save)

### VS Code support

Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

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"
  },

  // Silent the stylistic rules in you IDE, but still auto fix them
  "eslint.rules.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 }
  ],

  // 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"
  ]
}
```

## Customization

Since v1.0, we migrated to [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new). It provides much better organization and composition.

Normally you only need to import the `antfu` preset:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config()
```

And that's it! Or you can configure each integration individually, for example:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  // Type of the project. 'lib' for libraries, the default is 'app'
  type: 'lib',

  // Customize the stylistic rules
  stylistic: {
    blockSpacing: false,
    braceStyle: '1tbs',
    commaDangle: 'always-multiline',
    experimental: false,
    indent: 2, // 4, or 'tab'
    jsx: true,
    quoteProps: 'consistent',
    quotes: 'single', // or 'double'
    semi: false,

    // Disable the opinionated spacing rules (space in parenthesis, objects, arrays, etc.)
    lessOpinionated: true,
  },

  // TypeScript and Vue are autodetected, you can also explicitly enable them:
  typescript: true,
  vue: true,

  // Enable Next.js
  nextjs: true,

  // Enable Storybook
  storybook: true,

  // Enable JSDoc comment enforcement
  jsdoc: 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 `antfu` factory function also accepts any number of arbitrary custom config overrides:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config(
  {
    // Configures for antfu'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:

<details>
<summary>Advanced Example</summary>

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.js
import {
  combine,
  comments,
  ignores,
  imports,
  javascript,
  jsdoc,
  jsonc,
  markdown,
  nextjs,
  node,
  sortPackageJson,
  sortTsconfig,
  storybook,
  stylistic,
  toml,
  typescript,
  unicorn,
  vue,
  yaml,
} from '@infernodesign/eslint-config'

export default combine(
  ignores(),
  javascript( /* Options */ ),
  comments(),
  node(),
  jsdoc(),
  imports(),
  nextjs(),
  storybook(),
  unicorn(),
  typescript( /* Options */ ),
  stylistic(),
  vue(),
  jsonc(),
  yaml(),
  toml(),
  markdown(),
)
```

</details>

Check out the [configs](https://github.com/antfu/eslint-config/blob/main/src/configs) and [factory](https://github.com/antfu/eslint-config/blob/main/src/factory.ts) for more details.

> Thanks to [sxzz/eslint-config](https://github.com/sxzz/eslint-config) for the inspiration and reference.

### 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)                     |
| `nextjs`                  | `@next/next`                      | [@next/eslint-plugin-next](https://github.com/vercel/next.js/tree/canary/packages/eslint-plugin-next) |
| `node`                    | `n`                               | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)                                |
| `react`                   | `@eslint-react`                   | [@eslint-react/eslint-plugin](https://github.com/eslint-react/eslint-plugin)                          |
| `react-dom`               | `@eslint-react/dom`               | [@eslint-react/eslint-plugin](https://github.com/eslint-react/eslint-plugin)                          |
| `react-naming-convention` | `@eslint-react/naming-convention` | [@eslint-react/eslint-plugin](https://github.com/eslint-react/eslint-plugin)                          |
| `style`                   | `@stylistic`                      | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic)                      |
| `tailwindcss/*`           | `better-tailwindcss/*`            | [eslint-plugin-better-tailwindcss](https://github.com/unjs/eslint-plugin-better-tailwindcss)          |
| `test`                    | `vitest`                          | [@vitest/eslint-plugin](https://github.com/vitest-dev/eslint-plugin-vitest)                           |
| `ts`                      | `@typescript-eslint`              | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint)            |
| `yaml`                    | `yml`                             | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml)                                   |

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 }
```

### Change back to original prefix

If you really want to use the original prefix, you can revert the plugin renaming by:

```ts
import { config } from '@infernodesign/eslint-config'

export default config()
  .renamePlugins( {
    node: 'n',
    ts: '@typescript-eslint',
    yaml: 'yml'
    // ...
  } )
```

### 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.js
import { config } from '@infernodesign/eslint-config'

export default config(
  {
    typescript: true,
    vue: 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.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  typescript: {
    overrides: {
      'ts/consistent-type-definitions': [ 'error', 'interface' ],
    },
  },
  vue: {
    overrides: {
      'vue/operator-linebreak': [ 'error', 'before' ],
    },
  },
  yaml: {
    overrides: {
      // ...
    },
  },
} )
```

### Config Composer

Since v2.10.0, the factory function `config()` returns a [`FlatConfigComposer` object from `eslint-flat-config-utils`](https://github.com/antfu/eslint-flat-config-utils#composer) where you can chain the methods to compose the config even more flexibly.

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config()
  .prepend(
    // some configs before the main config
  )
  // overrides any named configs
  .override(
    'config/stylistic/rules',
    {
      rules: {
        'style/generator-star-spacing': [ 'error', { after: true, before: false } ],
      }
    }
  )
  // 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.

#### Astro

To enable astro support, you need to explicitly turn it on:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  astro: true,
} )
```

Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:

```bash
npm i -D eslint-plugin-astro
```

#### 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).

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  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 `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:

```bash
npm i -D eslint-plugin-format
```

#### React

To enable React support, you need to explicitly turn it on:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  react: true,
} )
```

Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:

```bash
npm i -D @eslint-react/eslint-plugin eslint-plugin-react-refresh
```

#### Next.js

To enable Next.js support, you need to explicitly turn it on:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  nextjs: true,
} )
```

To configure Next.js, you can pass an object with the following options:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  nextjs: {
    // Specify the root directory for Next.js. Defaults to the cwd() of the Node.js process.
    rootDir: 'src',
  },
} )
```

Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:

```bash
npm i -D @next/eslint-plugin-next
```

#### Storybook

To enable storybook support, you need to explicitly turn it on:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  storybook: true,
} )
```

Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:

```bash
npm i -D eslint-plugin-storybook
```

#### Svelte

To enable svelte support, you need to explicitly turn it on:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  svelte: true,
} )
```

Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:

```bash
npm i -D eslint-plugin-svelte
```

#### Solid

To enable Solid support, you need to explicitly turn it on:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  solid: true,
} )
```

Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:

```bash
npm i -D eslint-plugin-solid
```

#### TailwindCSS

To enable TailwindCSS support, you need to explicitly turn it on:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  tailwindcss: true,
} )
```

To configure the TailwindCSS support, you can pass an object with the following options:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  tailwindcss: {
    // Enable component class detection
    detectComponentClasses: true,
    // Specify the entry point for Tailwind CSS
    // If not provided, the config will try to find the `global.css` or `globals.css` file in the project.
    entryPoint: 'src/styles/globals.css',
  },
} )
```

Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:

```bash
npm i -D eslint-plugin-better-tailwindcss
```

#### UnoCSS

To enable UnoCSS support, you need to explicitly turn it on:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  unocss: true,
} )
```

Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:

```bash
npm i -D @unocss/eslint-plugin
```

### 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.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  vue: true
} )
```

#### Vue 2

We have limited support for Vue 2 (as it's already [reached EOL](https://v2.vuejs.org/eol/)). If you are still using Vue 2, you can configure it manually by setting `vueVersion` to `2`:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  vue: {
    vueVersion: 2
  },
} )
```

As it's in maintenance mode, we only accept bug fixes for Vue 2. It might also be removed in the future when `eslint-plugin-vue` drops support for Vue 2. We recommend upgrading to Vue 3 if possible.

#### Vue Accessibility

To enable Vue accessibility support, you need to explicitly turn it on:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  vue: {
    a11y: true
  },
} )
```

Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:

```bash
npm i -D eslint-plugin-vuejs-accessibility
```

### Optional Rules

This config also provides some optional plugins/rules for extended usage.

#### `command`

Powered by [`eslint-plugin-command`](https://github.com/antfu/eslint-plugin-command). It is not a typical rule for linting, but an on-demand micro-codemod tool that triggers by specific comments.

For a few triggers, for example:

- `/// to-function` - converts an arrow function to a normal function
- `/// to-arrow` - converts a normal function to an arrow function
- `/// to-for-each` - converts a for-in/for-of loop to `.forEach()`
- `/// to-for-of` - converts a `.forEach()` to a for-of loop
- `/// keep-sorted` - sorts an object/array/interface
- ... etc. - refer to the [documentation](https://github.com/antfu/eslint-plugin-command#built-in-commands)

You can add the trigger comment one line above the code you want to transform, for example (note the triple slash):

<!-- eslint-skip -->

```ts
/// to-function
const foo = async (msg: string): void => {
  console.log(msg)
}
```

Will be transformed to this when you hit save with your editor or run `eslint --fix`:

```ts
async function foo( msg: string ): void {
  console.log( msg )
}
```

The command comments are usually one-off and will be removed along with the transformation.

### Type Aware Rules

You can optionally enable the [type aware rules](https://typescript-eslint.io/linting/typed-linting/) by passing the options object to the `typescript` config:

```js
// eslint.config.js
import { config } from '@infernodesign/eslint-config'

export default config( {
  typescript: {
    tsconfigPath: 'tsconfig.json',
  },
} )
```

### Editor Specific Disables

Auto-fixing for the following rules are disabled when ESLint is running in a code editor:

- [`prefer-const`](https://eslint.org/docs/rules/prefer-const)
- [`test/no-only-tests`](https://github.com/levibuzolic/eslint-plugin-no-only-tests)
- [`unused-imports/no-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports)

Since v3.16.0, they are no longer disabled, but made non-fixable using [this helper](https://github.com/antfu/eslint-flat-config-utils#composerdisablerulesfix).

This is to prevent unused imports from getting removed by the editor during refactoring to get a better developer experience. Those rules will be applied when you run ESLint in the terminal or [Lint Staged](#lint-staged). If you don't want this behavior, you can disable them:

```js
// eslint.config.js
import { config } from '@infernodesign/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`:

```json
{
  "simple-git-hooks": {
    "pre-commit": "npx lint-staged"
  },
  "lint-staged": {
    "*": "eslint --fix"
  }
}
```

and then

```bash
npm i -D lint-staged simple-git-hooks

# to activate the hooks
npx simple-git-hooks
```

## View what rules are enabled

I built a visual tool to help you view what rules are enabled in your project and apply them to what files, [@eslint/config-inspector](https://github.com/eslint/config-inspector)

Go to your project root that contains `eslint.config.mjs` and run:

```bash
npx @eslint/config-inspector
```

## Versioning Policy

This project follows [Semantic Versioning](https://semver.org/) for releases. However, since this is just a config and involves opinions and many moving parts, we don't treat rules changes as breaking changes.

### Changes Considered as Breaking Changes

- Node.js version requirement changes
- Huge refactors that might break the config
- Plugins made major changes that might break the config
- Changes that might affect most of the codebases

### Changes Considered as Non-breaking Changes

- Enable/disable rules and plugins (that might become stricter)
- Rules options changes
- Version bumps of dependencies

## FAQ

### How to format CSS?

You can opt-in to the [`formatters`](#formatters) feature to format your CSS. Note that it's only doing formatting, but not linting. If you want proper linting support, give [`stylelint`](https://stylelint.io/) a try.

## License

Licensed under the [MIT License](./LICENSE).

## Credits

- Orignally forked from [Antfu's eslint-config](https://github.com/antfu/eslint-config)