Options

config

string

The name of the configuration file.

cache

boolean
Default: false

Only check changed files.

cacheLocation

string

Path to the cache file or directory.

exclude

Array<string>
Default: []

Files to exclude from linting.

format

anyOf [string, string]
Default: stylish

ESLint Output formatter (https://eslint.org/docs/user-guide/formatters).

files

Array<string>
Default: []

Files to include in linting.

force

boolean
Default: false

Succeeds even if there was linting errors.

fix

boolean
Default: false

Fixes linting errors (may overwrite linted files).

linter

Required
string
Default: eslint
Accepted values: eslint

The tool to use for running lint checks.

maxWarnings

number
Default: -1

Number of warnings to trigger nonzero exit code - default: -1.

outputFile

string

File to write report to.

quiet

boolean
Default: false

Report errors only - default: false.

silent

boolean
Default: false

Hide output text.

tsConfig

oneOf [string, Array<string>]

The name of the TypeScript configuration file.