From 2ee96bcf484428409f4a711069c6bf7e5b6f5c54 Mon Sep 17 00:00:00 2001 From: Cameron McAteer Date: Fri, 6 Jan 2017 15:07:12 -0500 Subject: [PATCH] Added "check-preblock" option to whitespace rule Also added fixes for inserting spaces and updated tests --- src/rules/whitespaceRule.ts | 22 +++++-- test/rules/whitespace/all/test.js.lint | 17 +++++ test/rules/whitespace/all/test.ts.fix | 85 +++++++++++++++++++++++++ test/rules/whitespace/all/test.ts.lint | 23 ++++++- test/rules/whitespace/all/tslint.json | 2 + test/rules/whitespace/none/test.ts.lint | 14 ++++ 6 files changed, 157 insertions(+), 6 deletions(-) create mode 100644 test/rules/whitespace/all/test.ts.fix diff --git a/src/rules/whitespaceRule.ts b/src/rules/whitespaceRule.ts index 57d980b6d42..f1d1b8141be 100644 --- a/src/rules/whitespaceRule.ts +++ b/src/rules/whitespaceRule.ts @@ -26,6 +26,7 @@ const OPTION_MODULE = "check-module"; const OPTION_SEPARATOR = "check-separator"; const OPTION_TYPE = "check-type"; const OPTION_TYPECAST = "check-typecast"; +const OPTION_PREBLOCK = "check-preblock"; export class Rule extends Lint.Rules.AbstractRule { /* tslint:disable:object-literal-sort-keys */ @@ -42,13 +43,14 @@ export class Rule extends Lint.Rules.AbstractRule { * \`"check-module"\` checks for whitespace in import & export statements. * \`"check-separator"\` checks for whitespace after separator tokens (\`,\`/\`;\`). * \`"check-type"\` checks for whitespace before a variable type specification. - * \`"check-typecast"\` checks for whitespace between a typecast and its target.`, + * \`"check-typecast"\` checks for whitespace between a typecast and its target. + * \`"check-preblock"\` checks for whitespace before the opening brace of a block`, options: { type: "array", items: { type: "string", enum: ["check-branch", "check-decl", "check-operator", "check-module", - "check-separator", "check-type", "check-typecast"], + "check-separator", "check-type", "check-typecast", "check-preblock"], }, minLength: 0, maxLength: 7, @@ -87,7 +89,7 @@ class WhitespaceWalker extends Lint.SkippableTokenAwareRuleWalker { if (tokenKind === ts.SyntaxKind.WhitespaceTrivia || tokenKind === ts.SyntaxKind.NewLineTrivia) { prevTokenShouldBeFollowedByWhitespace = false; } else if (prevTokenShouldBeFollowedByWhitespace) { - this.addFailureAt(startPos, 1, Rule.FAILURE_STRING); + this.addMissingWhitespaceErrorAt(startPos); prevTokenShouldBeFollowedByWhitespace = false; } @@ -153,6 +155,13 @@ class WhitespaceWalker extends Lint.SkippableTokenAwareRuleWalker { super.visitBinaryExpression(node); } + protected visitBlock(block: ts.Block) { + if (this.hasOption(OPTION_PREBLOCK)) { + this.checkForTrailingWhitespace(block.getFullStart()); + } + super.visitBlock(block); + } + // check for spaces between ternary operator symbols public visitConditionalExpression(node: ts.ConditionalExpression) { if (this.hasOption(OPTION_OPERATOR)) { @@ -260,7 +269,12 @@ class WhitespaceWalker extends Lint.SkippableTokenAwareRuleWalker { if (nextTokenType !== ts.SyntaxKind.WhitespaceTrivia && nextTokenType !== ts.SyntaxKind.NewLineTrivia && nextTokenType !== ts.SyntaxKind.EndOfFileToken) { - this.addFailureAt(position, 1, Rule.FAILURE_STRING); + this.addMissingWhitespaceErrorAt(position); } } + + private addMissingWhitespaceErrorAt(position: number) { + const fix = this.createFix(this.appendText(position, " ")); + this.addFailureAt(position, 1, Rule.FAILURE_STRING, fix); + } } diff --git a/test/rules/whitespace/all/test.js.lint b/test/rules/whitespace/all/test.js.lint index 314a6cd2fe8..3eaf444b901 100644 --- a/test/rules/whitespace/all/test.js.lint +++ b/test/rules/whitespace/all/test.js.lint @@ -86,3 +86,20 @@ export function each(obj, iterator, context) { export {each as forEach}; import "libE"; + +function foobar(){} + ~ [missing whitespace] + +function foorbar() +{} + +if (){ + ~ [missing whitespace] + // +} else{} + ~ [missing whitespace] + +if () +{} +else +{} diff --git a/test/rules/whitespace/all/test.ts.fix b/test/rules/whitespace/all/test.ts.fix new file mode 100644 index 00000000000..9804d7a84fd --- /dev/null +++ b/test/rules/whitespace/all/test.ts.fix @@ -0,0 +1,85 @@ +import ast = AST; +module M { + export var ast = AST; + + var x: number; + + var y = (x === 10) ? 1 : 2; + + var zz = (y === 4); + + var z = y; + + var a, b; + + switch (x) { + case 1: break; + default: break; + } + + for (x = 1; x < 2; ++x) { + goto: console.log("hi"); + } + + while (i < 1) { + ++i; + } + + var q; + q.forEach(() => 3); + q.forEach(() => { + return 3; + }); + + var r: () => string; + var s: new () => string; + var a = "10"; + var a = "10"; +} + +var a; + +export = a; + +a.then(() => { + return 1; +}).if(() => { + return 1; +}); + +var name = "something"; +var test = ` + +