@zuke/eslint

`@zuke/eslint` — typed `eslint` task wrappers for Zuke builds.

Symbols

# EslintSettings class

class EslintSettings extends ToolSettings

Settings for an eslint run.

Member	Signature	Doc
`paths`	`paths(...values: PathLike[]): this`	Files, directories, or globs to lint (positional); repeatable.
`config`	`config(path: PathLike): this`	Use an explicit config file (`-c`/`--config`).
`ext`	`ext(...extensions: string[]): this`	Additional file extensions to lint (`--ext`); repeatable.
`fix`	`fix(): this`	Apply automatic fixes (`--fix`).
`fixDryRun`	`fixDryRun(): this`	Compute fixes without writing them (`--fix-dry-run`).
`fixType`	`fixType(...types: string[]): this`	Restrict fixes to the given types (`--fix-type`); repeatable.
`quietWarnings`	`quietWarnings(): this`	Report errors only, suppressing warnings (`--quiet`).
`maxWarnings`	`maxWarnings(count: number): this`	Fail once this many warnings are reached (`--max-warnings`).
`format`	`format(value: string): this`	Output format, e.g. `stylish`, `json` (`-f`/`--format`).
`outputFile`	`outputFile(path: PathLike): this`	Write the report to a file (`-o`/`--output-file`).
`cache`	`cache(): this`	Cache results between runs (`--cache`).
`cacheLocation`	`cacheLocation(path: PathLike): this`	Where to store the cache (`--cache-location`).
`ignorePath`	`ignorePath(path: PathLike): this`	Read ignore globs from a file (`--ignore-path`).
`ignorePattern`	`ignorePattern(glob: string): this`	Ignore files matching a glob (`--ignore-pattern`); repeatable.
`noIgnore`	`noIgnore(): this`	Disable all ignore handling (`--no-ignore`).
`noConfigLookup`	`noConfigLookup(): this`	Do not search for a config file (`--no-config-lookup`).
`reportUnusedDisableDirectives`	`reportUnusedDisableDirectives(): this`	Report unused `eslint-disable` directives (`--report-unused-disable-directives`).

# EslintTasks const

const EslintTasks: EslintTasksApi

Typed task functions for the eslint linter.

# EslintTasksApi interface

interface EslintTasksApi

The shape of EslintTasks.

Member	Signature	Doc
`lint`	`lint(configure?: Configure<EslintSettings>): Promise<CommandOutput>`	Lint with `eslint`.