69 lines
1.5 KiB
TypeScript
69 lines
1.5 KiB
TypeScript
export interface Options {
|
|
/**
|
|
* Path to a configuration file.
|
|
*/
|
|
config?: string;
|
|
/**
|
|
* Exclude globs from path expansion.
|
|
*/
|
|
exclude?: string | string[];
|
|
/**
|
|
* File paths to lint.
|
|
*/
|
|
files?: string[];
|
|
/**
|
|
* Whether to return status code 0 even if there are lint errors.
|
|
*/
|
|
force?: boolean;
|
|
/**
|
|
* Whether to fixes linting errors for select rules. This may overwrite linted files.
|
|
*/
|
|
fix?: boolean;
|
|
/**
|
|
* Output format.
|
|
*/
|
|
format?: string;
|
|
/**
|
|
* Formatters directory path.
|
|
*/
|
|
formattersDirectory?: string;
|
|
/**
|
|
* Whether to generate a tslint.json config file in the current working directory.
|
|
*/
|
|
init?: boolean;
|
|
/**
|
|
* Output file path.
|
|
*/
|
|
out?: string;
|
|
/**
|
|
* Whether to output absolute paths
|
|
*/
|
|
outputAbsolutePaths?: boolean;
|
|
/**
|
|
* tsconfig.json file.
|
|
*/
|
|
project?: string;
|
|
/**
|
|
* Rules directory paths.
|
|
*/
|
|
rulesDirectory?: string | string[];
|
|
/**
|
|
* That TSLint produces the correct output for the specified directory.
|
|
*/
|
|
test?: string;
|
|
/**
|
|
* Whether to enable type checking when linting a project.
|
|
*/
|
|
typeCheck?: boolean;
|
|
}
|
|
export declare const enum Status {
|
|
Ok = 0,
|
|
FatalError = 1,
|
|
LintError = 2,
|
|
}
|
|
export interface Logger {
|
|
log(message: string): void;
|
|
error(message: string): void;
|
|
}
|
|
export declare function run(options: Options, logger: Logger): Promise<Status>;
|