UNPKG

1.33 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2017 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 { Fix, RuleFailure } from "../rule/rule";
19export declare class WalkContext<T = undefined> {
20 readonly sourceFile: ts.SourceFile;
21 readonly ruleName: string;
22 readonly options: T;
23 readonly failures: RuleFailure[];
24 constructor(sourceFile: ts.SourceFile, ruleName: string, options: T);
25 /** Add a failure with any arbitrary span. Prefer `addFailureAtNode` if possible. */
26 addFailureAt(start: number, width: number, failure: string, fix?: Fix): void;
27 addFailure(start: number, end: number, failure: string, fix?: Fix): void;
28 /** Add a failure using a node's span. */
29 addFailureAtNode(node: ts.Node, failure: string, fix?: Fix): void;
30}