Mark RuleWalker and ProgramAwareRuleWalker as deprecated (#4413)

palantir · Feb 23, 2019 · 4997ce7 · 4997ce7
1 parent 9785477
commit 4997ce7
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/src/language/walker/programAwareRuleWalker.ts b/src/language/walker/programAwareRuleWalker.ts
@@ -21,7 +21,13 @@ import { IOptions } from "../rule/rule";
 
 import { RuleWalker } from "./ruleWalker";
 
-export class ProgramAwareRuleWalker extends RuleWalker {
+/**
+ * @deprecated
+ * RuleWalker-based rules are slow,
+ * so it's generally preferable to use applyWithFunction instead of applyWithWalker.
+ * @see https://github.com/palantir/tslint/issues/2522
+ */
+export class ProgramAwareRuleWalker extends RuleWalker { // tslint:disable-line deprecation
     private readonly typeChecker: ts.TypeChecker;
 
     constructor(

diff --git a/src/language/walker/ruleWalker.ts b/src/language/walker/ruleWalker.ts
@@ -22,6 +22,12 @@ import { Fix, IOptions, Replacement, RuleFailure } from "../rule/rule";
 import { SyntaxWalker } from "./syntaxWalker";
 import { IWalker } from "./walker";
 
+/**
+ * @deprecated
+ * RuleWalker-based rules are slow,
+ * so it's generally preferable to use applyWithFunction instead of applyWithWalker.
+ * @see https://github.com/palantir/tslint/issues/2522
+ */
 export class RuleWalker extends SyntaxWalker implements IWalker {
     private readonly limit: number;
     private readonly options?: any[];

diff --git a/src/language/walker/scopeAwareRuleWalker.ts b/src/language/walker/scopeAwareRuleWalker.ts
@@ -56,7 +56,7 @@ import { RuleWalker } from "./ruleWalker";
  *     });
  * }
  */
-export abstract class ScopeAwareRuleWalker<T> extends RuleWalker {
+export abstract class ScopeAwareRuleWalker<T> extends RuleWalker { // tslint:disable-line deprecation
     private readonly scopeStack: T[];
 
     constructor(sourceFile: ts.SourceFile, options: IOptions) {