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 { IOptions } from "../rule/rule";
19 import { RuleWalker } from "./ruleWalker";
21 * @deprecated Prefer to manually maintain any contextual information.
23 * For example, imagine a `no-break` rule that warns on `break` in `for` but not in `switch`:
25 * function walk(ctx: Lint.WalkContext): void {
26 * let isInFor = false;
27 * ts.forEachChild(ctx.sourceFile, function cb(node: ts.Node): void {
28 * switch (node.kind) {
29 * case ts.SyntaxKind.Break:
31 * ctx.addFailureAtNode(node, "!");
34 * case ts.SyntaxKind.ForStatement: {
35 * const old = isInFor;
37 * ts.forEachChild(node, cb);
41 * case ts.SyntaxKind.SwitchStatement: {
42 * const old = isInFor;
44 * ts.forEachChild(node, cb);
49 * ts.forEachChild(node, cb);
54 export declare abstract class ScopeAwareRuleWalker<T> extends RuleWalker {
55 private readonly scopeStack;
56 constructor(sourceFile: ts.SourceFile, options: IOptions);
57 abstract createScope(node: ts.Node): T;
60 getCurrentDepth(): number;
63 protected visitNode(node: ts.Node): void;
64 protected isScopeBoundary(node: ts.Node): boolean;