#405, #400 Deprecated duplicate rules

Josh Goldberg · HamletDRC · commit e95cead4804d · 2017-12-18T11:36:23.000+01:00
closes #400. closes #405
diff --git a/README.md b/README.md
diff --git a/src/functionNameRule.ts b/src/functionNameRule.ts
@@ -31,7 +31,13 @@ export class Rule extends Lint.Rules.AbstractRule {
         commonWeaknessEnumeration: '398, 710'
     };
 
+    private static isWarningShown: boolean = false;
+
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        if (Rule.isWarningShown === false) {
+            console.warn('Warning: function-name rule is deprecated. Replace your usage with the TSLint variable-name rule.');
+            Rule.isWarningShown = true;
+        }
         return this.applyWithWalker(new FunctionNameRuleWalker(sourceFile, this.getOptions()));
     }
 }
diff --git a/src/missingJsdocRule.ts b/src/missingJsdocRule.ts
@@ -26,7 +26,13 @@ export class Rule extends Lint.Rules.AbstractRule {
 
     public static FAILURE_STRING: string = 'File missing JSDoc comment at the top-level: ';
 
+    private static isWarningShown: boolean = false;
+
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        if (Rule.isWarningShown === false) {
+            console.warn('Warning: missing-jsdoc rule is deprecated. Replace your usage with the TSLint file-header rule.');
+            Rule.isWarningShown = true;
+        }
         return this.applyWithWalker(new MissingJSDocWalker(sourceFile, this.getOptions()));
     }
 }
diff --git a/src/noDuplicateCaseRule.ts b/src/noDuplicateCaseRule.ts
@@ -26,7 +26,14 @@ export class Rule extends Lint.Rules.AbstractRule {
 
     public static FAILURE_STRING: string = 'Duplicate case found in switch statement: ';
 
+    private static isWarningShown: boolean = false;
+
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        if (Rule.isWarningShown === false) {
+            console.warn('Warning: no-duplicate-case rule is deprecated. ' +
+                'Replace your usage with the TSLint no-duplicate-switch-case rule.');
+            Rule.isWarningShown = true;
+        }
         return this.applyWithWalker(new NoDuplicateCaseRuleWalker(sourceFile, this.getOptions()));
     }
 
diff --git a/src/noEmptyInterfacesRule.ts b/src/noEmptyInterfacesRule.ts
@@ -27,7 +27,13 @@ export class Rule extends Lint.Rules.AbstractRule {
 
     public static FAILURE_STRING: string = 'Do not declare empty interfaces: ';
 
+    private static isWarningShown: boolean = false;
+
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        if (Rule.isWarningShown === false) {
+            console.warn('Warning: no-empty-interfaces rule is deprecated. Replace your usage with the TSLint no-empty-interface rule.');
+            Rule.isWarningShown = true;
+        }
         return this.applyWithWalker(new NoEmptyInterfacesRuleWalker(sourceFile, this.getOptions()));
     }
 
diff --git a/src/noReservedKeywordsRule.ts b/src/noReservedKeywordsRule.ts
@@ -50,7 +50,13 @@ export class Rule extends Lint.Rules.AbstractRule {
         'from', 'of'
     ];
 
+    private static isWarningShown: boolean = false;
+
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        if (Rule.isWarningShown === false) {
+            console.warn('Warning: no-reserved-keywords rule is deprecated. Replace your usage with the TSLint variable-name rule.');
+            Rule.isWarningShown = true;
+        }
         const walker: Lint.RuleWalker = new BannedTermWalker(
             sourceFile,
             this.getOptions(),
diff --git a/src/noUnnecessaryFieldInitializationRule.ts b/src/noUnnecessaryFieldInitializationRule.ts
@@ -28,7 +28,14 @@ export class Rule extends Lint.Rules.AbstractRule {
         commonWeaknessEnumeration: '398, 710'
     };
 
+    private static isWarningShown: boolean = false;
+
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        if (Rule.isWarningShown === false) {
+            console.warn('Warning: no-unnecessary-field-initialization rule is deprecated. ' +
+                'Replace your usage with the TSLint no-unnecessary-initializer rule.');
+            Rule.isWarningShown = true;
+        }
         return this.applyWithWalker(new UnnecessaryFieldInitializationRuleWalker(sourceFile, this.getOptions()));
     }
 }
diff --git a/src/preferArrayLiteralRule.ts b/src/preferArrayLiteralRule.ts
@@ -28,7 +28,13 @@ export class Rule extends Lint.Rules.AbstractRule {
     public static GENERICS_FAILURE_STRING: string = 'Replace generic-typed Array with array literal: ';
     public static CONSTRUCTOR_FAILURE_STRING: string = 'Replace Array constructor with an array literal: ';
 
+    private static isWarningShown: boolean = false;
+
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        if (Rule.isWarningShown === false) {
+            console.warn('Warning: prefer-array-literal rule is deprecated. Replace your usage with the TSLint array-type rule.');
+            Rule.isWarningShown = true;
+        }
         return this.applyWithWalker(new NoGenericArrayWalker(sourceFile, this.getOptions()));
     }
 }
diff --git a/src/preferTypeCastRule.ts b/src/preferTypeCastRule.ts
@@ -27,7 +27,14 @@ export class Rule extends Lint.Rules.AbstractRule {
         commonWeaknessEnumeration: '398, 710'
     };
 
+    private static isWarningShown: boolean = false;
+
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        if (Rule.isWarningShown === false) {
+            console.warn('Warning: prefer-type-cast rule is deprecated. ' +
+                'Replace your usage with the TSLint no-angle-bracket-type-assertion rule.');
+            Rule.isWarningShown = true;
+        }
         return this.applyWithWalker(new PreferTypeCastRuleWalker(sourceFile, this.getOptions()));
     }
 }
diff --git a/src/promiseMustCompleteRule.ts b/src/promiseMustCompleteRule.ts
@@ -28,7 +28,14 @@ export class Rule extends Lint.Rules.AbstractRule {
 
     public static FAILURE_STRING: string = 'A Promise was found that appears to not have resolve or reject invoked on all code paths';
 
+    private static isWarningShown: boolean = false;
+
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        if (Rule.isWarningShown === false) {
+            console.warn('Warning: promise-must-complete rule is deprecated. ' +
+                'Replace your usage with the TSLint no-floating-promises rule.');
+            Rule.isWarningShown = true;
+        }
         return this.applyWithWalker(new PromiseAnalyzer(sourceFile, this.getOptions()));
     }
 }
diff --git a/src/reactTsxCurlySpacingRule.ts b/src/reactTsxCurlySpacingRule.ts
@@ -23,7 +23,14 @@ export class Rule extends Lint.Rules.AbstractRule {
         group: 'Whitespace'
     };
 
+    private static isWarningShown: boolean = false;
+
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        if (Rule.isWarningShown === false) {
+            console.warn('Warning: react-tsx-curly-spacing rule is deprecated. ' +
+                'Replace your usage with the tslint-react jsx-curly-spacing rule.');
+            Rule.isWarningShown = true;
+        }
         return this.applyWithWalker(new TsxCurlySpacingWalker(sourceFile, this.getOptions()));
     }
 }
diff --git a/src/validTypeofRule.ts b/src/validTypeofRule.ts
@@ -27,7 +27,13 @@ export class Rule extends Lint.Rules.AbstractRule {
 
     public static VALID_TERMS: string[] = [ 'undefined', 'object', 'boolean', 'number', 'string', 'function', 'symbol' ];
 
+    private static isWarningShown: boolean = false;
+
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        if (Rule.isWarningShown === false) {
+            console.warn('Warning: valid-typeof rule is deprecated. Replace your usage with the TSLint typeof-compare rule.');
+            Rule.isWarningShown = true;
+        }
         return this.applyWithWalker(new ValidTypeofRuleWalker(sourceFile, this.getOptions()));
     }
 

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,13 @@ export class Rule extends Lint.Rules.AbstractRule {`
`31`	`31`	`commonWeaknessEnumeration: '398, 710'`
`32`	`32`	`};`
`33`	`33`
	`34`	`+ private static isWarningShown: boolean = false;`
	`35`	`+`
`34`	`36`	`public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {`
	`37`	`+ if (Rule.isWarningShown === false) {`
	`38`	`+ console.warn('Warning: function-name rule is deprecated. Replace your usage with the TSLint variable-name rule.');`
	`39`	`+ Rule.isWarningShown = true;`
	`40`	`+ }`
`35`	`41`	`return this.applyWithWalker(new FunctionNameRuleWalker(sourceFile, this.getOptions()));`
`36`	`42`	`}`
`37`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,13 @@ export class Rule extends Lint.Rules.AbstractRule {`
`26`	`26`
`27`	`27`	`public static FAILURE_STRING: string = 'File missing JSDoc comment at the top-level: ';`
`28`	`28`
	`29`	`+ private static isWarningShown: boolean = false;`
	`30`	`+`
`29`	`31`	`public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {`
	`32`	`+ if (Rule.isWarningShown === false) {`
	`33`	`+ console.warn('Warning: missing-jsdoc rule is deprecated. Replace your usage with the TSLint file-header rule.');`
	`34`	`+ Rule.isWarningShown = true;`
	`35`	`+ }`
`30`	`36`	`return this.applyWithWalker(new MissingJSDocWalker(sourceFile, this.getOptions()));`
`31`	`37`	`}`
`32`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,14 @@ export class Rule extends Lint.Rules.AbstractRule {`
`28`	`28`	`commonWeaknessEnumeration: '398, 710'`
`29`	`29`	`};`
`30`	`30`
	`31`	`+ private static isWarningShown: boolean = false;`
	`32`	`+`
`31`	`33`	`public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {`
	`34`	`+ if (Rule.isWarningShown === false) {`
	`35`	`+ console.warn('Warning: no-unnecessary-field-initialization rule is deprecated. ' +`
	`36`	`+ 'Replace your usage with the TSLint no-unnecessary-initializer rule.');`
	`37`	`+ Rule.isWarningShown = true;`
	`38`	`+ }`
`32`	`39`	`return this.applyWithWalker(new UnnecessaryFieldInitializationRuleWalker(sourceFile, this.getOptions()));`
`33`	`40`	`}`
`34`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,13 @@ export class Rule extends Lint.Rules.AbstractRule {`
`28`	`28`	`public static GENERICS_FAILURE_STRING: string = 'Replace generic-typed Array with array literal: ';`
`29`	`29`	`public static CONSTRUCTOR_FAILURE_STRING: string = 'Replace Array constructor with an array literal: ';`
`30`	`30`
	`31`	`+ private static isWarningShown: boolean = false;`
	`32`	`+`
`31`	`33`	`public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {`
	`34`	`+ if (Rule.isWarningShown === false) {`
	`35`	`+ console.warn('Warning: prefer-array-literal rule is deprecated. Replace your usage with the TSLint array-type rule.');`
	`36`	`+ Rule.isWarningShown = true;`
	`37`	`+ }`
`32`	`38`	`return this.applyWithWalker(new NoGenericArrayWalker(sourceFile, this.getOptions()));`
`33`	`39`	`}`
`34`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,14 @@ export class Rule extends Lint.Rules.AbstractRule {`
`27`	`27`	`commonWeaknessEnumeration: '398, 710'`
`28`	`28`	`};`
`29`	`29`
	`30`	`+ private static isWarningShown: boolean = false;`
	`31`	`+`
`30`	`32`	`public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {`
	`33`	`+ if (Rule.isWarningShown === false) {`
	`34`	`+ console.warn('Warning: prefer-type-cast rule is deprecated. ' +`
	`35`	`+ 'Replace your usage with the TSLint no-angle-bracket-type-assertion rule.');`
	`36`	`+ Rule.isWarningShown = true;`
	`37`	`+ }`
`31`	`38`	`return this.applyWithWalker(new PreferTypeCastRuleWalker(sourceFile, this.getOptions()));`
`32`	`39`	`}`
`33`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,14 @@ export class Rule extends Lint.Rules.AbstractRule {`
`23`	`23`	`group: 'Whitespace'`
`24`	`24`	`};`
`25`	`25`
	`26`	`+ private static isWarningShown: boolean = false;`
	`27`	`+`
`26`	`28`	`public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {`
	`29`	`+ if (Rule.isWarningShown === false) {`
	`30`	`+ console.warn('Warning: react-tsx-curly-spacing rule is deprecated. ' +`
	`31`	`+ 'Replace your usage with the tslint-react jsx-curly-spacing rule.');`
	`32`	`+ Rule.isWarningShown = true;`
	`33`	`+ }`
`27`	`34`	`return this.applyWithWalker(new TsxCurlySpacingWalker(sourceFile, this.getOptions()));`
`28`	`35`	`}`
`29`	`36`	`}`