xo

constructor

constructor(_linterOptions: LinterOptions, _baseXoConfig?: XoConfigOptions);

property baseXoConfig

baseXoConfig: XoConfigOptions;

• Base XO config options that allow configuration from CLI or other sources. Not to be confused with the xoConfig property which is the resolved XO config from the flat config AND base config.

property cacheLocation

cacheLocation: string;

• File path to the ESLint cache.

property eslint

eslint?: ESLint;

• A re-usable ESLint instance configured with options calculated from the XO config.

property eslintConfig

eslintConfig?: Linter.Config[];

• The ESLint config calculated from the resolved XO config.

property flatConfigPath

flatConfigPath?: string;

• The flat XO config path, if there is one.

property linterOptions

linterOptions: LinterOptions;

• Required linter options: cwd, fix, and filePath (in case of lintText).

property prettier

prettier?: boolean;

• If any user configs contain Prettier, we will need to fetch the Prettier config.

property prettierConfig

prettierConfig?: prettier.Options;

• The Prettier config if it exists and is needed.

property tsFilesGlob

tsFilesGlob: string[];

• The glob pattern for TypeScript files, for which we will handle TS files and tsconfig.

  We expand this based on the XO config and the files glob patterns.

property tsFilesIgnoresGlob

tsFilesIgnoresGlob: string[];

• We use this to also add negative glob patterns in case a user overrides the parserOptions in their XO config.

property xoConfig

xoConfig?: Simplify<
    XoConfigOptions &
        Omit<Linter.Config, 'files' | 'ignores'> & {
            files?: string | (string | string[])[];
            ignores?: string | string[];
        }
>[];

• XO config derived from both the base config and the resolved flat config.

property xoToEslintConfig

static xoToEslintConfig: (
    flatXoConfig: Simplify<
        XoConfigOptions &
            Omit<Linter.Config, 'files' | 'ignores'> & {
                files?: string | (string | string[])[];
                ignores?: string | string[];
            }
    >[],
    { prettierOptions }?: CreateConfigOptions
) => Linter.Config[];

• Static helper to convert an XO config to an ESLint config to be used in eslint.config.js.

method calculateConfigForFile

calculateConfigForFile: (filePath: string) => Promise<Linter.Config>;

method ensureCacheDirectory

ensureCacheDirectory: () => Promise<void>;

• Ensures the cache directory exists. This needs to run once before both tsconfig handling and running ESLint occur.

method getFormatter

getFormatter: (name: string) => Promise<ESLint.LoadedFormatter>;

method handleUnincludedTsFiles

handleUnincludedTsFiles: (files?: string[]) => Promise<void>;

• Checks every TS file to ensure its included in the tsconfig and any that are not included are added to an in-memory TypeScript Program for type aware linting.

  Parameter files

  The TypeScript files being linted.

method initEslint

initEslint: (files?: string[]) => Promise<void>;

• Initializes the ESLint instance on the XO instance.

method lintFiles

static lintFiles: (
    globs: string | undefined,
    options: LinterOptions & XoConfigOptions
) => Promise<XoLintResult>;

• Static helper for backwards compatibility and use in editor extensions and other tools.

• Lints the files on the XO instance.

  Parameter globs

  Glob pattern to pass to globby.

  Throws

  Error

method lintText

static lintText: (
    code: string,
    options: LintTextOptions & LinterOptions & XoConfigOptions
) => Promise<XoLintResult>;

• Static helper for backwards compatibility and use in editor extensions and other tools.

• Lints the text on the XO instance.

method outputFixes

static outputFixes: (results: XoLintResult) => Promise<void>;

• Write the fixes to disk.

method setEslintConfig

setEslintConfig: () => void;

• Sets the ESLint config on the XO instance.

method setIgnores

setIgnores: () => void;

• Sets the ignores on the XO instance.

method setXoConfig

setXoConfig: () => Promise<void>;

• Sets the XO config on the XO instance.