File Format Support

/**
 * JSONC configuration for JSON files with comments
 * @param options - JSONC configuration options
 * @returns ESLint config for JSONC files
 */
function jsonc(
  options?: OptionsOverrides & OptionsStylistic
): Promise<TypedFlatConfigItem[]>;

import { jsonc } from "@antfu/eslint-config";

// Basic JSONC config
const jsoncConfig = await jsonc();

// With custom stylistic options
const jsoncConfigStyled = await jsonc({
  stylistic: {
    indent: 2,
  },
  overrides: {
    'jsonc/sort-keys': 'error',
  },
});

/**
 * YAML configuration for YAML files
 * @param options - YAML configuration options
 * @returns ESLint config for YAML files
 */
function yaml(
  options?: OptionsOverrides & OptionsStylistic
): Promise<TypedFlatConfigItem[]>;

import { yaml } from "@antfu/eslint-config";

// Basic YAML config
const yamlConfig = await yaml();

// With custom rules
const yamlConfigCustom = await yaml({
  overrides: {
    'yml/indent': ['error', 2],
    'yml/quotes': ['error', { prefer: 'single' }],
  },
});

/**
 * TOML configuration for TOML files
 * @param options - TOML configuration options
 * @returns ESLint config for TOML files
 */
function toml(
  options?: OptionsOverrides & OptionsStylistic
): Promise<TypedFlatConfigItem[]>;

import { toml } from "@antfu/eslint-config";

// Basic TOML config
const tomlConfig = await toml();

// With stylistic preferences
const tomlConfigStyled = await toml({
  stylistic: {
    indent: 2,
  },
  overrides: {
    'toml/indent': ['error', 2],
  },
});

/**
 * Markdown configuration for code blocks in Markdown files
 * @param options - Markdown configuration options
 * @returns ESLint config for Markdown files
 */
function markdown(
  options?: OptionsOverrides & OptionsComponentExts
): Promise<TypedFlatConfigItem[]>;

import { markdown } from "@antfu/eslint-config";

// Basic markdown config
const markdownConfig = await markdown();

// With component extensions and custom rules
const markdownConfigCustom = await markdown({
  componentExts: ['vue', 'svelte'],
  overrides: {
    'no-console': 'off', // Allow console in code examples
    'import/no-unresolved': 'off',
  },
});

/**
 * Sort package.json fields according to conventions
 * @returns ESLint config for package.json sorting
 */
function sortPackageJson(): Promise<TypedFlatConfigItem[]>;

import { sortPackageJson } from "@antfu/eslint-config";

// Package.json sorting config
const packageSortConfig = await sortPackageJson();

/**
 * Sort tsconfig.json fields according to conventions
 * @returns ESLint config for tsconfig.json sorting
 */
function sortTsconfig(): Promise<TypedFlatConfigItem[]>;

import { sortTsconfig } from "@antfu/eslint-config";

// TSConfig sorting config  
const tsconfigSortConfig = await sortTsconfig();

/**
 * Regular expression linting configuration
 * @param options - RegExp configuration options
 * @returns ESLint config for RegExp rules
 */
function regexp(
  options?: OptionsRegExp & OptionsOverrides
): Promise<TypedFlatConfigItem[]>;

interface OptionsRegExp {
  /** Override rule levels */
  level?: 'error' | 'warn';
}

import { regexp } from "@antfu/eslint-config";

// Basic RegExp config
const regexpConfig = await regexp();

// With warning level instead of errors
const regexpConfigWarn = await regexp({
  level: 'warn',
  overrides: {
    'regexp/no-unused-capturing-group': 'error',
  },
});

/**
 * Unicorn plugin configuration for code quality rules
 * @param options - Unicorn configuration options
 * @returns ESLint config for Unicorn rules
 */
function unicorn(
  options?: OptionsUnicorn
): Promise<TypedFlatConfigItem[]>;

interface OptionsUnicorn extends OptionsOverrides {
  /** Include all recommended rules instead of curated subset */
  allRecommended?: boolean;
}

import { unicorn } from "@antfu/eslint-config";

// Basic unicorn config (curated rules)
const unicornConfig = await unicorn();

// All recommended rules
const unicornConfigAll = await unicorn({
  allRecommended: true,
  overrides: {
    'unicorn/prevent-abbreviations': 'off',
  },
});

/**
 * PNPM workspace configuration for monorepo support
 * @returns ESLint config for PNPM workspace files
 */
function pnpm(): Promise<TypedFlatConfigItem[]>;

import { pnpm } from "@antfu/eslint-config";

// PNPM workspace config
const pnpmConfig = await pnpm();

/**
 * UnoCSS configuration for CSS utility class validation
 * @param options - UnoCSS configuration options
 * @returns ESLint config for UnoCSS rules
 */
function unocss(
  options?: OptionsUnoCSS
): Promise<TypedFlatConfigItem[]>;

interface OptionsUnoCSS extends OptionsOverrides {
  /** Enable attributify support */
  attributify?: boolean;
  /** Enable strict mode with blocklisted classes */
  strict?: boolean;
}

import { unocss } from "@antfu/eslint-config";

// Basic UnoCSS config
const unocssConfig = await unocss();

// With attributify and strict mode
const unocssConfigStrict = await unocss({
  attributify: true,
  strict: true,
  overrides: {
    '@unocss/order': 'warn',
  },
});