You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
73 lines
2.4 KiB
73 lines
2.4 KiB
3 years ago
|
/** @typedef {import("eslint").ESLint.Options} ESLintOptions */
|
||
|
|
/** @typedef {import('eslint').ESLint.LintResult} LintResult */
|
||
|
|
/** @typedef {import('eslint').ESLint.LintResultData} LintResultData */
|
||
|
|
/**
|
||
|
|
* @callback FormatterFunction
|
||
|
|
* @param {LintResult[]} results
|
||
|
|
* @param {LintResultData=} data
|
||
|
|
* @returns {string}
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* @typedef {Object} OutputReport
|
||
|
|
* @property {string=} filePath
|
||
|
|
* @property {string|FormatterFunction=} formatter
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* @typedef {Object} PluginOptions
|
||
|
|
* @property {string=} context
|
||
|
|
* @property {boolean=} emitError
|
||
|
|
* @property {boolean=} emitWarning
|
||
|
|
* @property {string=} eslintPath
|
||
|
|
* @property {string|string[]=} exclude
|
||
|
|
* @property {string|string[]=} extensions
|
||
|
|
* @property {boolean=} failOnError
|
||
|
|
* @property {boolean=} failOnWarning
|
||
|
|
* @property {string|string[]=} files
|
||
|
|
* @property {boolean=} fix
|
||
|
|
* @property {string|FormatterFunction=} formatter
|
||
|
|
* @property {boolean=} lintDirtyModulesOnly
|
||
|
|
* @property {boolean=} quiet
|
||
|
|
* @property {OutputReport=} outputReport
|
||
|
|
* @property {number|boolean=} threads
|
||
|
|
*/
|
||
|
|
/** @typedef {PluginOptions & ESLintOptions} Options */
|
||
|
|
/**
|
||
|
|
* @param {Options} pluginOptions
|
||
|
|
* @returns {PluginOptions}
|
||
|
|
*/
|
||
|
|
export function getOptions(pluginOptions: Options): PluginOptions;
|
||
|
|
/**
|
||
|
|
* @param {Options} loaderOptions
|
||
|
|
* @returns {ESLintOptions}
|
||
|
|
*/
|
||
|
|
export function getESLintOptions(loaderOptions: Options): ESLintOptions;
|
||
|
|
export type ESLintOptions = import('eslint').ESLint.Options;
|
||
|
|
export type LintResult = import('eslint').ESLint.LintResult;
|
||
|
|
export type LintResultData = import('eslint').ESLint.LintResultData;
|
||
|
|
export type FormatterFunction = (
|
||
|
|
results: LintResult[],
|
||
|
|
data?: LintResultData | undefined
|
||
|
|
) => string;
|
||
|
|
export type OutputReport = {
|
||
|
|
filePath?: string | undefined;
|
||
|
|
formatter?: (string | FormatterFunction) | undefined;
|
||
|
|
};
|
||
|
|
export type PluginOptions = {
|
||
|
|
context?: string | undefined;
|
||
|
|
emitError?: boolean | undefined;
|
||
|
|
emitWarning?: boolean | undefined;
|
||
|
|
eslintPath?: string | undefined;
|
||
|
|
exclude?: (string | string[]) | undefined;
|
||
|
|
extensions?: (string | string[]) | undefined;
|
||
|
|
failOnError?: boolean | undefined;
|
||
|
|
failOnWarning?: boolean | undefined;
|
||
|
|
files?: (string | string[]) | undefined;
|
||
|
|
fix?: boolean | undefined;
|
||
|
|
formatter?: (string | FormatterFunction) | undefined;
|
||
|
|
lintDirtyModulesOnly?: boolean | undefined;
|
||
|
|
quiet?: boolean | undefined;
|
||
|
|
outputReport?: OutputReport | undefined;
|
||
|
|
threads?: (number | boolean) | undefined;
|
||
|
|
};
|
||
|
|
export type Options = PluginOptions & ESLintOptions;
|