UNPKG

2.27 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2013 Palantir Technologies, Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17import * as ts from "typescript";
18import { findConfiguration, findConfigurationPath, getRulesDirectories, IConfigurationFile, loadConfigurationFromPath } from "./configuration";
19import { ILinterOptions, LintResult } from "./index";
20import { RuleFailure } from "./language/rule/rule";
21/**
22 * Linter that can lint multiple files in consecutive runs.
23 */
24export declare class Linter {
25 private readonly options;
26 private program?;
27 static VERSION: string;
28 static findConfiguration: typeof findConfiguration;
29 static findConfigurationPath: typeof findConfigurationPath;
30 static getRulesDirectories: typeof getRulesDirectories;
31 static loadConfigurationFromPath: typeof loadConfigurationFromPath;
32 private failures;
33 private fixes;
34 /**
35 * Creates a TypeScript program object from a tsconfig.json file path and optional project directory.
36 */
37 static createProgram(configFile: string, projectDirectory?: string): ts.Program;
38 /**
39 * Returns a list of source file names from a TypeScript program. This includes all referenced
40 * files and excludes declaration (".d.ts") files.
41 */
42 static getFileNames(program: ts.Program): string[];
43 constructor(options: ILinterOptions, program?: ts.Program | undefined);
44 lint(fileName: string, source: string, configuration?: IConfigurationFile): void;
45 getResult(): LintResult;
46 private getAllFailures;
47 private applyAllFixes;
48 protected applyFixes(sourceFilePath: string, source: string, fixableFailures: RuleFailure[]): string;
49 private updateProgram;
50 private applyRule;
51 private getEnabledRules;
52 private getSourceFile;
53}