Fix lint and other small tweaks to recent PRs (palantir#4536)

skrobul · Feb 23, 2019 · 03a3bdd · 03a3bdd
1 parent bd4a048
commit 03a3bdd
Show file tree

Hide file tree

Showing 23 changed files with 41 additions and 34 deletions.
diff --git a/src/language/rule/rule.ts b/src/language/rule/rule.ts
@@ -96,7 +96,7 @@ export interface IRuleMetadata {
     codeExamples?: ICodeExample[];
 }
 
-export type RuleType = "functionality" | "maintainability" | "style" | "typescript" | "format";
+export type RuleType = "functionality" | "maintainability" | "style" | "typescript" | "formatting";
 
 export type RuleSeverity = "warning" | "error" | "off";
 

diff --git a/src/language/walker/programAwareRuleWalker.ts b/src/language/walker/programAwareRuleWalker.ts
@@ -27,7 +27,8 @@ import { RuleWalker } from "./ruleWalker";
  * 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
+// tslint:disable-next-line deprecation
+export class ProgramAwareRuleWalker extends RuleWalker {
     private readonly typeChecker: ts.TypeChecker;
 
     constructor(

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

diff --git a/src/rules/alignRule.ts b/src/rules/alignRule.ts
@@ -70,7 +70,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             maxLength: 5,
         },
         optionExamples: [[true, "parameters", "statements"]],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/arrowParensRule.ts b/src/rules/arrowParensRule.ts
@@ -41,7 +41,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             enum: [BAN_SINGLE_ARG_PARENS],
         },
         optionExamples: [true, [true, BAN_SINGLE_ARG_PARENS]],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/eoflineRule.ts b/src/rules/eoflineRule.ts
@@ -31,7 +31,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         options: null,
         optionExamples: [true],
         hasFix: true,
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/importSpacingRule.ts b/src/rules/importSpacingRule.ts
@@ -30,7 +30,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         optionsDescription: "Not configurable.",
         options: null,
         optionExamples: [true],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
 

diff --git a/src/rules/indentRule.ts b/src/rules/indentRule.ts
@@ -69,7 +69,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             [true, OPTION_USE_TABS, OPTION_INDENT_SIZE_2],
         ],
         hasFix: true,
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/jsdocFormatRule.ts b/src/rules/jsdocFormatRule.ts
@@ -51,7 +51,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             },
         },
         optionExamples: [true, [true, OPTION_CHECK_MULTILINE_START]],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/linebreakStyleRule.ts b/src/rules/linebreakStyleRule.ts
@@ -37,7 +37,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             enum: [OPTION_LINEBREAK_STYLE_LF, OPTION_LINEBREAK_STYLE_CRLF],
         },
         optionExamples: [[true, OPTION_LINEBREAK_STYLE_LF], [true, OPTION_LINEBREAK_STYLE_CRLF]],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
         hasFix: true,
     };

diff --git a/src/rules/maxLineLengthRule.ts b/src/rules/maxLineLengthRule.ts
@@ -77,7 +77,7 @@ export class Rule extends Lint.Rules.AbstractRule {
                 },
             ],
         ],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/newParensRule.ts b/src/rules/newParensRule.ts
@@ -28,7 +28,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         optionsDescription: "Not configurable.",
         options: null,
         optionExamples: [true],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/newlineBeforeReturnRule.ts b/src/rules/newlineBeforeReturnRule.ts
@@ -31,7 +31,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         optionsDescription: "Not configurable.",
         options: {},
         optionExamples: [true],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/noConsecutiveBlankLinesRule.ts b/src/rules/noConsecutiveBlankLinesRule.ts
@@ -44,7 +44,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             minimum: "1",
         },
         optionExamples: [true, [true, 2]],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/noIrregularWhitespaceRule.ts b/src/rules/noIrregularWhitespaceRule.ts
@@ -28,7 +28,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         optionsDescription: "Not configurable.",
         options: null,
         optionExamples: [true],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/noRestrictedGlobalsRule.ts b/src/rules/noRestrictedGlobalsRule.ts
@@ -15,8 +15,14 @@
  * limitations under the License.
  */
 
-import { isBindingElement, isComputedPropertyName, isIdentifier, isPropertyAccessExpression } from "tsutils";
+import {
+    isBindingElement,
+    isComputedPropertyName,
+    isIdentifier,
+    isPropertyAccessExpression,
+} from "tsutils";
 import * as ts from "typescript";
+
 import * as Lint from "../index";
 
 export class Rule extends Lint.Rules.TypedRule {
@@ -50,14 +56,7 @@ export class Rule extends Lint.Rules.TypedRule {
             type: "list",
             items: { type: "string" },
         },
-        optionExamples: [
-            [
-                true,
-                "name",
-                "length",
-                "event",
-            ],
-        ],
+        optionExamples: [[true, "name", "length", "event"]],
         type: "functionality",
         typescriptOnly: false,
         requiresTypeInfo: true,
@@ -69,12 +68,18 @@ export class Rule extends Lint.Rules.TypedRule {
     }
 
     public applyWithProgram(sourceFile: ts.SourceFile, program: ts.Program): Lint.RuleFailure[] {
-        const bannedList = this.ruleArguments.length > 0 ? this.ruleArguments : ["event", "name", "length"];
+        const bannedList =
+            this.ruleArguments.length > 0 ? this.ruleArguments : ["event", "name", "length"];
         const bannedGlobals = new Set(bannedList);
         if (sourceFile.isDeclarationFile) {
             return [];
         } else {
-            return this.applyWithFunction(sourceFile, walk, bannedGlobals, program.getTypeChecker());
+            return this.applyWithFunction(
+                sourceFile,
+                walk,
+                bannedGlobals,
+                program.getTypeChecker(),
+            );
         }
     }
 }
@@ -113,7 +118,7 @@ function walk(ctx: Lint.WalkContext<Set<string>>, checker: ts.TypeChecker): void
             return;
         }
 
-        const isAmbientGlobal = declarations.some((decl) => decl.getSourceFile().isDeclarationFile);
+        const isAmbientGlobal = declarations.some(decl => decl.getSourceFile().isDeclarationFile);
 
         if (isAmbientGlobal) {
             ctx.addFailureAtNode(node, Rule.FAILURE_STRING(node.text));

diff --git a/src/rules/noTrailingWhitespaceRule.ts b/src/rules/noTrailingWhitespaceRule.ts
@@ -62,7 +62,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             },
         },
         optionExamples: [true, [true, OPTION_IGNORE_COMMENTS], [true, OPTION_IGNORE_JSDOC]],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/numberLiteralFormatRule.ts b/src/rules/numberLiteralFormatRule.ts
@@ -35,7 +35,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             Helps keep a consistent style with numeric literals.
             Non-standard literals are more difficult to scan through and can be a symptom of typos.
         `,
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/quotemarkRule.ts b/src/rules/quotemarkRule.ts
@@ -79,7 +79,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             [true, OPTION_SINGLE, OPTION_AVOID_ESCAPE, OPTION_AVOID_TEMPLATE],
             [true, OPTION_SINGLE, OPTION_JSX_DOUBLE],
         ],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/semicolonRule.ts b/src/rules/semicolonRule.ts
@@ -76,7 +76,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             [true, OPTION_ALWAYS, OPTION_IGNORE_INTERFACES],
             [true, OPTION_ALWAYS, OPTION_IGNORE_BOUND_CLASS_METHODS],
         ],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/trailingCommaRule.ts b/src/rules/trailingCommaRule.ts
@@ -128,7 +128,7 @@ export class Rule extends Lint.Rules.AbstractRule {
                 },
             ],
         ],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/typedefWhitespaceRule.ts b/src/rules/typedefWhitespaceRule.ts
@@ -90,7 +90,7 @@ export class Rule extends Lint.Rules.AbstractRule {
                 },
             ],
         ],
-        type: "format",
+        type: "formatting",
         typescriptOnly: true,
         hasFix: true,
     };

diff --git a/src/rules/whitespaceRule.ts b/src/rules/whitespaceRule.ts
@@ -75,7 +75,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             maxLength: 11,
         },
         optionExamples: [[true, "check-branch", "check-operator", "check-typecast"]],
-        type: "format",
+        type: "formatting",
         typescriptOnly: false,
         hasFix: true,
     };