diff options
Diffstat (limited to 'node_modules/tslint/lib/configuration.d.ts')
-rw-r--r-- | node_modules/tslint/lib/configuration.d.ts | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/node_modules/tslint/lib/configuration.d.ts b/node_modules/tslint/lib/configuration.d.ts new file mode 100644 index 000000000..ede434408 --- /dev/null +++ b/node_modules/tslint/lib/configuration.d.ts @@ -0,0 +1,104 @@ +import { IOptions, RuleSeverity } from "./language/rule/rule"; +export interface IConfigurationFile { + /** + * The severity that is applied to rules in _this_ config with `severity === "default"`. + * Not inherited. + */ + defaultSeverity?: RuleSeverity; + /** + * An array of config files whose rules are inherited by this config file. + */ + extends: string[]; + /** + * Rules that are used to lint to JavaScript files. + */ + jsRules: Map<string, Partial<IOptions>>; + /** + * Other linter options, currently for testing. Not publicly supported. + */ + linterOptions?: { + typeCheck?: boolean; + }; + /** + * Directories containing custom rules. Resolved using node module semantics. + */ + rulesDirectory: string[]; + /** + * Rules that are used to lint TypeScript files. + */ + rules: Map<string, Partial<IOptions>>; +} +export interface IConfigurationLoadResult { + path?: string; + results?: IConfigurationFile; +} +export declare const CONFIG_FILENAME = "tslint.json"; +export declare const DEFAULT_CONFIG: IConfigurationFile; +export declare const EMPTY_CONFIG: IConfigurationFile; +/** + * Searches for a TSLint configuration and returns the data from the config. + * @param configFile A path to a config file, this can be null if the location of a config is not known + * @param inputFilePath A path containing the current file being linted. This is the starting location + * of the search for a configuration. + * @returns Load status for a TSLint configuration object + */ +export declare function findConfiguration(configFile: string | null, inputFilePath: string): IConfigurationLoadResult; +/** + * Searches for a TSLint configuration and returns the path to it. + * Could return undefined if not configuration is found. + * @param suppliedConfigFilePath A path to an known config file supplied by a user. Pass null here if + * the location of the config file is not known and you want to search for one. + * @param inputFilePath A path to the current file being linted. This is the starting location + * of the search for a configuration. + * @returns An absolute path to a tslint.json file + * or undefined if neither can be found. + */ +export declare function findConfigurationPath(suppliedConfigFilePath: string | null, inputFilePath: string): string | undefined; +/** + * Used Node semantics to load a configuration file given configFilePath. + * For example: + * '/path/to/config' will be treated as an absolute path + * './path/to/config' will be treated as a relative path + * 'path/to/config' will attempt to load a to/config file inside a node module named path + * @param configFilePath The configuration to load + * @param originalFilePath The entry point configuration file + * @returns a configuration object for TSLint loaded from the file at configFilePath + */ +export declare function loadConfigurationFromPath(configFilePath?: string, originalFilePath?: string | undefined): IConfigurationFile; +export declare function extendConfigurationFile(targetConfig: IConfigurationFile, nextConfigSource: IConfigurationFile): IConfigurationFile; +export declare function getRelativePath(directory?: string | null, relativeTo?: string): string | undefined; +export declare function useAsPath(directory: string): boolean; +/** + * @param directories A path(s) to a directory of custom rules + * @param relativeTo A path that directories provided are relative to. + * For example, if the directories come from a tslint.json file, this path + * should be the path to the tslint.json file. + * @return An array of absolute paths to directories potentially containing rules + */ +export declare function getRulesDirectories(directories?: string | string[], relativeTo?: string): string[]; +export interface RawConfigFile { + extends?: string | string[]; + linterOptions?: IConfigurationFile["linterOptions"]; + rulesDirectory?: string | string[]; + defaultSeverity?: string; + rules?: RawRulesConfig; + jsRules?: RawRulesConfig; +} +export interface RawRulesConfig { + [key: string]: RawRuleConfig; +} +export declare type RawRuleConfig = null | undefined | boolean | any[] | { + severity?: RuleSeverity | "warn" | "none" | "default"; + options?: any; +}; +/** + * Parses a config file and normalizes legacy config settings + * + * @param configFile The raw object read from the JSON of a config file + * @param configFileDir The directory of the config file + */ +export declare function parseConfigFile(configFile: RawConfigFile, configFileDir?: string): IConfigurationFile; +/** + * Fills in default values for `IOption` properties and outputs an array of `IOption` + */ +export declare function convertRuleOptions(ruleConfiguration: Map<string, Partial<IOptions>>): IOptions[]; |