+++ /dev/null
-import { Linter } from './Linter';\r
-declare class ESLintBase {\r
- /**\r
- * Creates a new instance of the main ESLint API.\r
- * @param options The options for this instance.\r
- */\r
- constructor(options?: ESLint.ESLintOptions);\r
- /**\r
- * This method calculates the configuration for a given file, which can be useful for debugging purposes.\r
- * - It resolves and merges extends and overrides settings into the top level configuration.\r
- * - It resolves the parser setting to absolute paths.\r
- * - It normalizes the plugins setting to align short names. (e.g., eslint-plugin-foo → foo)\r
- * - It adds the processor setting if a legacy file extension processor is matched.\r
- * - It doesn't interpret the env setting to the globals and parserOptions settings, so the result object contains\r
- * the env setting as is.\r
- * @param filePath The path to the file whose configuration you would like to calculate. Directory paths are forbidden\r
- * because ESLint cannot handle the overrides setting.\r
- * @returns The promise that will be fulfilled with a configuration object.\r
- */\r
- calculateConfigForFile(filePath: string): Promise<Linter.Config>;\r
- /**\r
- * This method checks if a given file is ignored by your configuration.\r
- * @param filePath The path to the file you want to check.\r
- * @returns The promise that will be fulfilled with whether the file is ignored or not. If the file is ignored, then\r
- * it will return true.\r
- */\r
- isPathIgnored(filePath: string): Promise<boolean>;\r
- /**\r
- * This method lints the files that match the glob patterns and then returns the results.\r
- * @param patterns The lint target files. This can contain any of file paths, directory paths, and glob patterns.\r
- * @returns The promise that will be fulfilled with an array of LintResult objects.\r
- */\r
- lintFiles(patterns: string | string[]): Promise<ESLint.LintResult[]>;\r
- /**\r
- * This method lints the given source code text and then returns the results.\r
- *\r
- * By default, this method uses the configuration that applies to files in the current working directory (the cwd\r
- * constructor option). If you want to use a different configuration, pass options.filePath, and ESLint will load the\r
- * same configuration that eslint.lintFiles() would use for a file at options.filePath.\r
- *\r
- * If the options.filePath value is configured to be ignored, this method returns an empty array. If the\r
- * options.warnIgnored option is set along with the options.filePath option, this method returns a LintResult object.\r
- * In that case, the result may contain a warning that indicates the file was ignored.\r
- * @param code The source code text to check.\r
- * @param options The options.\r
- * @returns The promise that will be fulfilled with an array of LintResult objects. This is an array (despite there\r
- * being only one lint result) in order to keep the interfaces between this and the eslint.lintFiles()\r
- * method similar.\r
- */\r
- lintText(code: string, options?: ESLint.LintTextOptions): Promise<ESLint.LintResult[]>;\r
- /**\r
- * This method loads a formatter. Formatters convert lint results to a human- or machine-readable string.\r
- * @param name TThe path to the file you want to check.\r
- * The following values are allowed:\r
- * - undefined. In this case, loads the "stylish" built-in formatter.\r
- * - A name of built-in formatters.\r
- * - A name of third-party formatters. For examples:\r
- * -- `foo` will load eslint-formatter-foo.\r
- * -- `@foo` will load `@foo/eslint-formatter`.\r
- * -- `@foo/bar` will load `@foo/eslint-formatter-bar`.\r
- * - A path to the file that defines a formatter. The path must contain one or more path separators (/) in order to distinguish if it's a path or not. For example, start with ./.\r
- * @returns The promise that will be fulfilled with a Formatter object.\r
- */\r
- loadFormatter(name?: string): Promise<ESLint.Formatter>;\r
- /**\r
- * This method copies the given results and removes warnings. The returned value contains only errors.\r
- * @param results The LintResult objects to filter.\r
- * @returns The filtered LintResult objects.\r
- */\r
- static getErrorResults(results: ESLint.LintResult): ESLint.LintResult;\r
- /**\r
- * This method writes code modified by ESLint's autofix feature into its respective file. If any of the modified\r
- * files don't exist, this method does nothing.\r
- * @param results The LintResult objects to write.\r
- * @returns The promise that will be fulfilled after all files are written.\r
- */\r
- static outputFixes(results: ESLint.LintResult): Promise<void>;\r
- /**\r
- * The version text.\r
- */\r
- static readonly version: string;\r
-}\r
-declare namespace ESLint {\r
- interface ESLintOptions {\r
- /**\r
- * If false is present, ESLint suppresses directive comments in source code.\r
- * If this option is false, it overrides the noInlineConfig setting in your configurations.\r
- */\r
- allowInlineConfig?: boolean;\r
- /**\r
- * Configuration object, extended by all configurations used with this instance.\r
- * You can use this option to define the default settings that will be used if your configuration files don't\r
- * configure it.\r
- */\r
- baseConfig?: Linter.Config | null;\r
- /**\r
- * If true is present, the eslint.lintFiles() method caches lint results and uses it if each target file is not\r
- * changed. Please mind that ESLint doesn't clear the cache when you upgrade ESLint plugins. In that case, you have\r
- * to remove the cache file manually. The eslint.lintText() method doesn't use caches even if you pass the\r
- * options.filePath to the method.\r
- */\r
- cache?: boolean;\r
- /**\r
- * The eslint.lintFiles() method writes caches into this file.\r
- */\r
- cacheLocation?: string;\r
- /**\r
- * The working directory. This must be an absolute path.\r
- */\r
- cwd?: string;\r
- /**\r
- * Unless set to false, the eslint.lintFiles() method will throw an error when no target files are found.\r
- */\r
- errorOnUnmatchedPattern?: boolean;\r
- /**\r
- * If you pass directory paths to the eslint.lintFiles() method, ESLint checks the files in those directories that\r
- * have the given extensions. For example, when passing the src/ directory and extensions is [".js", ".ts"], ESLint\r
- * will lint *.js and *.ts files in src/. If extensions is null, ESLint checks *.js files and files that match\r
- * overrides[].files patterns in your configuration.\r
- * Note: This option only applies when you pass directory paths to the eslint.lintFiles() method.\r
- * If you pass glob patterns, ESLint will lint all files matching the glob pattern regardless of extension.\r
- */\r
- extensions?: string[] | null;\r
- /**\r
- * If true is present, the eslint.lintFiles() and eslint.lintText() methods work in autofix mode.\r
- * If a predicate function is present, the methods pass each lint message to the function, then use only the\r
- * lint messages for which the function returned true.\r
- */\r
- fix?: boolean | ((message: LintMessage) => boolean);\r
- /**\r
- * The types of the rules that the eslint.lintFiles() and eslint.lintText() methods use for autofix.\r
- */\r
- fixTypes?: string[];\r
- /**\r
- * If false is present, the eslint.lintFiles() method doesn't interpret glob patterns.\r
- */\r
- globInputPaths?: boolean;\r
- /**\r
- * If false is present, the eslint.lintFiles() method doesn't respect `.eslintignore` files or ignorePatterns in\r
- * your configuration.\r
- */\r
- ignore?: boolean;\r
- /**\r
- * The path to a file ESLint uses instead of `$CWD/.eslintignore`.\r
- * If a path is present and the file doesn't exist, this constructor will throw an error.\r
- */\r
- ignorePath?: string;\r
- /**\r
- * Configuration object, overrides all configurations used with this instance.\r
- * You can use this option to define the settings that will be used even if your configuration files configure it.\r
- */\r
- overrideConfig?: Linter.ConfigOverride | null;\r
- /**\r
- * The path to a configuration file, overrides all configurations used with this instance.\r
- * The options.overrideConfig option is applied after this option is applied.\r
- */\r
- overrideConfigFile?: string | null;\r
- /**\r
- * The plugin implementations that ESLint uses for the plugins setting of your configuration.\r
- * This is a map-like object. Those keys are plugin IDs and each value is implementation.\r
- */\r
- plugins?: Record<string, Linter.Plugin> | null;\r
- /**\r
- * The severity to report unused eslint-disable directives.\r
- * If this option is a severity, it overrides the reportUnusedDisableDirectives setting in your configurations.\r
- */\r
- reportUnusedDisableDirectives?: Linter.SeverityString | null;\r
- /**\r
- * The path to a directory where plugins should be resolved from.\r
- * If null is present, ESLint loads plugins from the location of the configuration file that contains the plugin\r
- * setting.\r
- * If a path is present, ESLint loads all plugins from there.\r
- */\r
- resolvePluginsRelativeTo?: string | null;\r
- /**\r
- * An array of paths to directories to load custom rules from.\r
- */\r
- rulePaths?: string[];\r
- /**\r
- * If false is present, ESLint doesn't load configuration files (.eslintrc.* files).\r
- * Only the configuration of the constructor options is valid.\r
- */\r
- useEslintrc?: boolean;\r
- }\r
- interface DeprecatedRuleInfo {\r
- /**\r
- * The rule ID.\r
- */\r
- ruleId: string;\r
- /**\r
- * The rule IDs that replace this deprecated rule.\r
- */\r
- replacedBy: string[];\r
- }\r
- /**\r
- * The LintResult value is the information of the linting result of each file.\r
- */\r
- interface LintResult {\r
- /**\r
- * The number of errors. This includes fixable errors.\r
- */\r
- errorCount: number;\r
- /**\r
- * The absolute path to the file of this result. This is the string "<text>" if the file path is unknown (when you\r
- * didn't pass the options.filePath option to the eslint.lintText() method).\r
- */\r
- filePath: string;\r
- /**\r
- * The number of errors that can be fixed automatically by the fix constructor option.\r
- */\r
- fixableErrorCount: number;\r
- /**\r
- * The number of warnings that can be fixed automatically by the fix constructor option.\r
- */\r
- fixableWarningCount: number;\r
- /**\r
- * The array of LintMessage objects.\r
- */\r
- messages: Linter.LintMessage[];\r
- /**\r
- * The source code of the file that was linted, with as many fixes applied as possible.\r
- */\r
- output?: string;\r
- /**\r
- * The original source code text. This property is undefined if any messages didn't exist or the output\r
- * property exists.\r
- */\r
- source?: string;\r
- /**\r
- * The information about the deprecated rules that were used to check this file.\r
- */\r
- usedDeprecatedRules: DeprecatedRuleInfo[];\r
- /**\r
- * The number of warnings. This includes fixable warnings.\r
- */\r
- warningCount: number;\r
- }\r
- interface LintTextOptions {\r
- /**\r
- * The path to the file of the source code text. If omitted, the result.filePath becomes the string "<text>".\r
- */\r
- filePath?: string;\r
- /**\r
- * If true is present and the options.filePath is a file ESLint should ignore, this method returns a lint result\r
- * contains a warning message.\r
- */\r
- warnIgnored?: boolean;\r
- }\r
- /**\r
- * The LintMessage value is the information of each linting error.\r
- */\r
- interface LintMessage {\r
- /**\r
- * The 1-based column number of the begin point of this message.\r
- */\r
- column: number;\r
- /**\r
- * The 1-based column number of the end point of this message. This property is undefined if this message\r
- * is not a range.\r
- */\r
- endColumn: number | undefined;\r
- /**\r
- * The 1-based line number of the end point of this message. This property is undefined if this\r
- * message is not a range.\r
- */\r
- endLine: number | undefined;\r
- /**\r
- * The EditInfo object of autofix. This property is undefined if this message is not fixable.\r
- */\r
- fix: EditInfo | undefined;\r
- /**\r
- * The 1-based line number of the begin point of this message.\r
- */\r
- line: number;\r
- /**\r
- * The error message\r
- */\r
- message: string;\r
- /**\r
- * The rule name that generates this lint message. If this message is generated by the ESLint core rather than\r
- * rules, this is null.\r
- */\r
- ruleId: string | null;\r
- /**\r
- * The severity of this message. 1 means warning and 2 means error.\r
- */\r
- severity: 1 | 2;\r
- /**\r
- * The list of suggestions. Each suggestion is the pair of a description and an EditInfo object to fix code. API\r
- * users such as editor integrations can choose one of them to fix the problem of this message. This property is\r
- * undefined if this message doesn't have any suggestions.\r
- */\r
- suggestions: {\r
- desc: string;\r
- fix: EditInfo;\r
- }[] | undefined;\r
- }\r
- /**\r
- * The EditInfo value is information to edit text.\r
- *\r
- * This edit information means replacing the range of the range property by the text property value. It's like\r
- * sourceCodeText.slice(0, edit.range[0]) + edit.text + sourceCodeText.slice(edit.range[1]). Therefore, it's an add\r
- * if the range[0] and range[1] property values are the same value, and it's removal if the text property value is\r
- * empty string.\r
- */\r
- interface EditInfo {\r
- /**\r
- * The pair of 0-based indices in source code text to remove.\r
- */\r
- range: [\r
- number,\r
- number\r
- ];\r
- /**\r
- * The text to add.\r
- */\r
- text: string;\r
- }\r
- /**\r
- * The Formatter value is the object to convert the LintResult objects to text.\r
- */\r
- interface Formatter {\r
- /**\r
- * The method to convert the LintResult objects to text\r
- */\r
- format(results: LintResult[]): string;\r
- }\r
-}\r
-declare const _ESLint: typeof ESLintBase;\r
-/**\r
- * The ESLint class is the primary class to use in Node.js applications.\r
- * This class depends on the Node.js fs module and the file system, so you cannot use it in browsers.\r
- *\r
- * If you want to lint code on browsers, use the Linter class instead.\r
- *\r
- * @since 7.0.0\r
- */\r
-declare class ESLint extends _ESLint {\r
-}\r
-export { ESLint };\r
-//# sourceMappingURL=ESLint.d.ts.map\r
projects / dotfiles / .git / blobdiff