This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 889
[new rule] Space after branch #4112
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
/** | ||
* @license | ||
* Copyright 2018 Palantir Technologies, Inc. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import * as utils from "tsutils"; | ||
import * as ts from "typescript"; | ||
import * as Lint from "../index"; | ||
|
||
type Option = "never"; | ||
|
||
/* tslint:disable:object-literal-sort-keys */ | ||
export class Rule extends Lint.Rules.AbstractRule { | ||
public static metadata: Lint.IRuleMetadata = { | ||
ruleName: "space-after-branch", | ||
description: | ||
"Requires or restricts whitespace after branching keywords (`for`, `if`, `switch`, ...)", | ||
optionsDescription: Lint.Utils.dedent` | ||
By default one whitespace is allowed after branching keywords. | ||
Optional argument \`'never'\` checks that branching keywords are not followed by whitespace. | ||
`, | ||
options: { | ||
type: "array", | ||
items: { | ||
type: "string", | ||
enum: ["never"] | ||
}, | ||
maxLength: 1 | ||
}, | ||
optionExamples: [[true, "never"]], | ||
type: "style", | ||
typescriptOnly: false, | ||
hasFix: true | ||
}; | ||
/* tslint:enable:object-literal-sort-keys */ | ||
|
||
public static FAILURE_INVALID_SPACE = "invalid whitespace after keyword"; | ||
public static FAILURE_MISSING_SPACE = "missing whitespace after keyword"; | ||
|
||
public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] { | ||
const options = this.ruleArguments[0]; | ||
|
||
return this.applyWithWalker(new SpaceAfterBranchWalker(sourceFile, this.ruleName, options)); | ||
} | ||
} | ||
|
||
class SpaceAfterBranchWalker extends Lint.AbstractWalker<Option> { | ||
public walk(sourceFile: ts.SourceFile): void { | ||
utils.forEachToken(sourceFile, (node: ts.Node) => { | ||
switch (node.kind) { | ||
case ts.SyntaxKind.CatchKeyword: | ||
case ts.SyntaxKind.ForKeyword: | ||
case ts.SyntaxKind.IfKeyword: | ||
case ts.SyntaxKind.SwitchKeyword: | ||
case ts.SyntaxKind.WhileKeyword: | ||
case ts.SyntaxKind.WithKeyword: | ||
this.countSpaces(node); | ||
} | ||
}); | ||
} | ||
|
||
private countSpaces(node: ts.Node): void { | ||
const { text } = this.sourceFile; | ||
let currentIndex = node.end; | ||
let currentChar = text.charCodeAt(node.end); | ||
|
||
while (ts.isWhiteSpaceLike(currentChar)) { | ||
currentChar = text.charCodeAt(++currentIndex); | ||
} | ||
|
||
return this.validateRule(node.end, currentIndex); | ||
} | ||
|
||
private validateRule(start: number, end: number): void { | ||
if (this.options === "never") { | ||
if (start !== end) { | ||
this.addFailure( | ||
start, | ||
end, | ||
Rule.FAILURE_INVALID_SPACE, | ||
Lint.Replacement.deleteFromTo(start, end) | ||
); | ||
} | ||
} else { | ||
switch (end - start) { | ||
case 0: | ||
this.addFailure( | ||
end, | ||
end, | ||
Rule.FAILURE_MISSING_SPACE, | ||
Lint.Replacement.appendText(end, " ") | ||
); | ||
break; | ||
case 1: | ||
break; | ||
default: | ||
this.addFailure( | ||
start + 1, | ||
end, | ||
Rule.FAILURE_INVALID_SPACE, | ||
Lint.Replacement.deleteFromTo(start + 1, end) | ||
); | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
if (x = 2) {} | ||
~ [invalid] | ||
|
||
for (;;) { | ||
~ [invalid] | ||
const x = 1; | ||
} | ||
|
||
switch(v) {} | ||
|
||
while (true) { | ||
~~~ [invalid] | ||
z = 1; | ||
} | ||
|
||
with (z) {} | ||
~~~ [invalid] | ||
|
||
catch (error) { | ||
~ [invalid] | ||
} | ||
|
||
for(;;){} | ||
|
||
[_base]: %s whitespace after keyword | ||
[invalid]: _base % ('invalid') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"rules": { | ||
"space-after-branch": [true, "never"] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
if(x = 2) {} | ||
~nil [missing] | ||
|
||
for (;;) { | ||
const x = 1; | ||
} | ||
|
||
switch (v) {} | ||
~~ [invalid] | ||
|
||
while (true) { | ||
~~ [invalid] | ||
z = 1; | ||
} | ||
|
||
with (z) {} | ||
|
||
catch (error) { | ||
} | ||
|
||
[_base]: %s whitespace after keyword | ||
[missing]: _base % ('missing') | ||
[invalid]: _base % ('invalid') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"rules": { | ||
"space-after-branch": true | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
if(x = 2) {} | ||
~nil [missing] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same |
||
|
||
for (;;) { | ||
const x = 1; | ||
} | ||
|
||
switch (v) {} | ||
~~ [invalid] | ||
|
||
while (true) { | ||
~~ [invalid] | ||
z = 1; | ||
} | ||
|
||
with (z) {} | ||
|
||
catch (error) { | ||
} | ||
|
||
[_base]: %s whitespace after keyword | ||
[missing]: _base % ('missing') | ||
[invalid]: _base % ('invalid') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"rules": { | ||
"space-after-branch": [true] | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "nil" is weird