Customization

Reference

Type Declarations

interface DefineConfigOptions {
  /**
   * An array of glob patterns indicating the files that the configuration
   * object should not apply to.
   */
  ignores?: string[]
  /**
   * Configuration for various features.
   */
  features?: Features
  /**
   * Predefined configurations for common use cases.
   */
  presets?: Preset[]
  /**
   * Additional configurations to extend.
   */
  extends?: Arrayable<ConfigModule>
}

export interface Features {
  /**
   * Enable stylistic rules.
   *
   * @default true
   */
  stylistic?: boolean | StylisticConfig
  /**
   * Enable sorting rules.
   *
   * @default true
   */
  sorting?: boolean
  /**
   * Enable TypeScript support.
   */
  typescript?: boolean
}

interface StylisticConfig {
  /**
   * Indentation level
   * Similar to the `tabWidth` and `useTabs` options in Prettier
   *
   * @default 2
   */
  indent?: 'tab' | number
  /**
   * Quote style
   * Similar to `singleQuote` option in Prettier
   *
   * @default 'single'
   */
  quotes?: 'double' | 'single'
  /**
   * Whether to enable semicolons
   * Similar to `semi` option in Prettier
   *
   * @default false
   */
  semi?: boolean
  /**
   * Enable JSX support
   * @default true
   */
  jsx?: boolean
  /**
   * When to enable arrow parenthesis
   * Similar to `arrowParens` option in Prettier
   *
   * @default false
   */
  arrowParens?: boolean
  /**
   * Which brace style to use
   * @default '1tbs'
   */
  braceStyle?: '1tbs' | 'allman' | 'stroustrup'
  /**
   * Whether to require spaces around braces
   * Similar to `bracketSpacing` option in Prettier
   *
   * @default true
   */
  blockSpacing?: boolean
  /**
   * When to enable prop quoting
   * Similar to `quoteProps` option in Prettier
   *
   * @default 'consistent-as-needed'
   */
  quoteProps?: 'always' | 'as-needed' | 'consistent-as-needed' | 'consistent'
  /**
   * When to enable comma dangles
   * Similar to `trailingComma` option in Prettier
   *
   * @default 'always-multiline'
   */
  commaDangle?: 'always-multiline' | 'always' | 'never' | 'only-multiline'
}

eslint.config.js

import { defineConfig, presetVue } from 'witheslint'

export default defineConfig({
  // Customize ignored files and directories.
  ignores: [
    '**/.idea',
  ],
  features: {
    // typescript: false, // Do not want to use TypeScript.
    // stylistic: false, // Do not want to use stylistic rules
  },
  presets: [
    presetVue() // In your vue project
  ],
  extends: [
    {
      // 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'],
      },
    }
  ]
})

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-x/*	eslint-plugin-import-x
ts/*	@typescript-eslint/*	@typescript-eslint/eslint-plugin
style/*	@stylistic/*	@stylistic/eslint-plugin
sorting/*	perfectionist/*	eslint-plugin-perfectionist
-	antfu/*	eslint-plugin-antfu
-	jsdoc/*	eslint-plugin-jsdoc
-	unicorn/*	eslint-plugin-unicorn
-	unused-imports/*	eslint-plugin-unused-imports