3 * Copyright 2013 Palantir Technologies, Inc.
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 import * as ts from "typescript";
18 import { IWalker, WalkContext } from "../walker";
19 import { IOptions, IRule, IRuleMetadata, RuleFailure, RuleSeverity } from "./rule";
20 export declare type NoInfer<T> = T & {
23 export declare abstract class AbstractRule implements IRule {
24 private readonly options;
25 static metadata: IRuleMetadata;
27 protected readonly ruleArguments: any[];
28 protected readonly ruleSeverity: RuleSeverity;
29 constructor(options: IOptions);
30 getOptions(): IOptions;
31 abstract apply(sourceFile: ts.SourceFile): RuleFailure[];
32 applyWithWalker(walker: IWalker): RuleFailure[];
34 protected applyWithFunction(sourceFile: ts.SourceFile, walkFn: (ctx: WalkContext) => void): RuleFailure[];
35 protected applyWithFunction<T>(sourceFile: ts.SourceFile, walkFn: (ctx: WalkContext<T>) => void, options: NoInfer<T>): RuleFailure[];
36 protected applyWithFunction<T, U>(sourceFile: ts.SourceFile, walkFn: (ctx: WalkContext<T>, programOrChecker: U) => void, options: NoInfer<T>, checker: NoInfer<U>): RuleFailure[];
39 * Failures will be filtered based on `tslint:disable` comments by tslint.
40 * This method now does nothing.
42 protected filterFailures(failures: RuleFailure[]): RuleFailure[];