@neodx/vfs/types/plugins/eslint.d.ts

Simple virtual file system - working dir context, lazy changes, different modes, integrations and moreover

import { m as VfsPlugin } from '../_internal/types-Bu8eLcj4.js';
import { ESLint } from 'eslint';

interface EsLintPluginApi {
  /** Fix ESLint issues in the given path(s) */
  fix(path: string | string[]): Promise<void>;
  /** Fix ESLint issues in all changed files */
  fixAll(): Promise<void>;
}
interface EsLintPluginParams {
  /**
   * @see ESLint.Options.fix
   * @default true
   */
  fix?: boolean;
  /**
   * Should fix all issues on apply?
   * @default true
   */
  auto?: boolean;
  /**
   * Should log errors to the console?
   * @default true
   */
  logErrors?: boolean;
  /**
   * Should log warnings to the console?
   * @default false
   */
  logWarnings?: boolean;
  /**
   * Additional ESLint options
   * @see ESLint.Options
   */
  eslintParams?: ESLint.Options;
}
declare function eslint({
  fix,
  auto,
  logErrors,
  logWarnings,
  eslintParams
}?: EsLintPluginParams): VfsPlugin<EsLintPluginApi>;

export { type EsLintPluginApi, type EsLintPluginParams, eslint };