@debbl/eslint-config

参考

https://github.com/antfu/eslint-config

安装

pnpm i eslint @debbl/eslint-config -D

配置 eslint.config.js

默认启动配置

• ignores
• javascript
• comments
• node
• jsdoc
• imports
• unicorn
• sortKeys
• test
• jsonc
• yml
• toml
• markdown
• prettier

import { defineConfig } from "@debbl/eslint-config";

export default defineConfig();

配置 Prettier, 会覆盖默认的规则

import { defineConfig } from "@debbl/eslint-config";

export default defineConfig({
  typescript: true,
  prettier: {
    semi: false,
  },
});

完整的 OptionConfig

types.ts

export interface OptionsConfig extends OptionsComponentExts {
  /**
   * Enable gitignore support.
   * Passing an object to configure the options.
   * @default true
   */
  ignores?: boolean | GetConfigOption<IgnoresConfig>;

  /**
   * Enable JavaScript support.
   * Passing an object to configure the options.
   * @default true
   */
  javascript?: GetConfigOption<JavascriptConfig>;

  /**
   * Enable TypeScript support.
   *
   * Passing an object to enable TypeScript Language Server support.
   *
   * @default false
   */
  typescript?: boolean | GetConfigOption<TypeScriptConfig>;

  /**
   * Enable test support.
   *
   * @default true
   */
  test?: boolean | GetConfigOption<TestConfig>;

  /**
   * Enable Vue support.
   *
   * @default false
   */
  vue?: boolean | GetConfigOption<VueConfig>;

  /**
   * Enable React support, Passing an object to enable Next.js support.
   *
   * @default false
   */
  react?: boolean | GetConfigOption<ReactConfig>;

  /**
   * Enable solid support, Passing an object to enable Next.js support.
   *
   * @default false
   */
  solid?: boolean;

  /**
   * Enable JSONC support.
   *
   * @default true
   */
  jsonc?: boolean | GetConfigOption<JsoncConfig>;

  /**
   * Enable YML support.
   *
   * @default true
   */
  yml?: boolean | GetConfigOption<YmlConfig>;

  /**
   * Enable TOML support.
   * @default true
   */
  toml?: boolean | GetConfigOption<TomlConfig>;

  /**
   * Enable Markdown support.
   *
   * @default true
   */
  markdown?: boolean | GetConfigOption<MarkdownConfig>;

  /**
   * Enable prettier rules.
   *
   * @default true
   */
  prettier?: boolean | Omit<GetConfigOption<PrettierConfig>, "tailwindcss">;

  /**
   * Enable Tailwind CSS support.
   * if set to "prettier", it will use `prettier-plugin-tailwindcss` @see https://github.com/tailwindlabs/prettier-plugin-tailwindcss
   * @default false
   */
  tailwindcss?: boolean | "prettier";

  /**
   * Custom config
   */
  customConfig?: ConfigItem[] | ConfigItem;
}