just-scripts
Version:
Just Stack Scripts
39 lines • 1.69 kB
TypeScript
import { TaskFunction } from 'just-task';
/**
* Task options generally follow ESLint CLI options explained here:
* https://eslint.org/docs/user-guide/command-line-interface
*/
export interface EsLintTaskOptions {
files?: string[];
configPath?: string;
ignorePath?: string;
resolvePluginsPath?: string;
fix?: boolean;
extensions?: string;
noEslintRc?: boolean;
maxWarnings?: number;
cache?: boolean;
cacheLocation?: string;
/**
* Upon lint completion, display a table of the 10 slowest rules
* (see https://eslint.org/docs/developer-guide/working-with-rules-deprecated#per-rule-performance).
*/
timing?: boolean;
/** Can be set to write the eslint report to a file */
outputFile?: string;
/** Can be set to dictate the format of use for report file generated with the output flag: https://eslint.org/docs/latest/user-guide/command-line-interface#-f---format */
format?: string;
/** Prevents the logging & auto-fixing of warnings */
quiet?: boolean;
/**
* Can be set to force the flat config on or off, which can be helpful when migrating to ESLint v9.
* This will be passed as an environment variable to eslint with the value ESLINT_USE_FLAT_CONFIG (https://eslint.org/blog/2024/04/eslint-v9.0.0-released/#flat-config-is-now-the-default-and-has-some-changes).
*/
useFlatConfig?: boolean;
/**
* When set to true, eslint will report any eslint-disable comments that are not used as an error.
*/
reportUnusedDisableDirectives?: boolean;
}
export declare function eslintTask(options?: EsLintTaskOptions): TaskFunction;
//# sourceMappingURL=eslintTask.d.ts.map