Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

[new rule] Space after branch #4112

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/configs/all.ts
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,7 @@ export const rules = {
],
"return-undefined": true,
"semicolon": [true, "always"],
"space-after-branch": true,
"space-before-function-paren": [true, {
"anonymous": "never",
"asyncArrow": "always",
Expand Down
118 changes: 118 additions & 0 deletions src/rules/spaceAfterBranchRule.ts
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)
);
}
}
}
}
26 changes: 26 additions & 0 deletions test/rules/space-after-branch/never-space/test.ts.lint
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')
5 changes: 5 additions & 0 deletions test/rules/space-after-branch/never-space/tslint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"rules": {
"space-after-branch": [true, "never"]
}
}
23 changes: 23 additions & 0 deletions test/rules/space-after-branch/none/test.ts.lint
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
if(x = 2) {}
~nil [missing]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "nil" is weird


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')
5 changes: 5 additions & 0 deletions test/rules/space-after-branch/none/tslint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"rules": {
"space-after-branch": true
}
}
23 changes: 23 additions & 0 deletions test/rules/space-after-branch/one-space/test.ts.lint
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
if(x = 2) {}
~nil [missing]
Copy link
Contributor

Choose a reason for hiding this comment

The 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')
5 changes: 5 additions & 0 deletions test/rules/space-after-branch/one-space/tslint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"rules": {
"space-after-branch": [true]
}
}