Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 23304x 23304x 23304x 23304x 23304x 23304x 23304x 23304x 23304x 23304x 23304x 23304x 1x 11653x 11653x 11653x 11653x 11653x 34821x 34821x 34821x 34821x 34821x 34821x 34821x 34821x 34821x 11653x 11653x 19x 19x 11653x 11653x 23434x 23434x 11653x 11653x 240x 240x 240x 11653x 11653x 292x 292x 292x 1492x 3x 3x 1489x 1489x 1489x 1492x 1492x 1492x 1492x 1406x 1406x 1489x 1489x 1489x 292x 292x 292x 292x 292x 292x 19x 18x 18x 19x 292x 292x 292x 11653x 11653x 292x 292x 292x 292x 292x 292x 1429x 1429x 1291x 1429x 83x 83x 55x 55x 55x 1429x 114x 10x 114x 59x 59x 45x 114x 2x 2x 2x 2x 2x 45x 45x 45x 45x 282x 282x 282x 11653x 11653x 1489x 1489x 1489x 1489x 6432x 1489x 1489x 1489x 4943x 4943x 4943x 6432x 6432x 6432x 5x 5x 5x 5x 5x 5x 5x 4943x 4943x 4943x 6432x 6432x 6432x 5x 5x 5x 5x 4x 4x 5x 4943x 4943x 4943x 1489x 1489x 1489x 11653x 11653x 10x 10x 1x 1x 1x 1x 10x 10x 11653x 11653x 1406x 1406x 1406x 1406x 175x 175x 175x 1231x 1406x 4828x 1231x 1231x 1231x 3597x 3597x 3597x 4828x 4828x 4828x 1195x 1195x 1195x 1195x 2402x 2402x 4828x 8x 8x 8x 8x 8x 8x 2394x 2394x 2394x 1223x 1223x 11653x 11653x | import {Issue} from "../issue";
import {ABAPRule} from "./_abap_rule";
import {BasicRuleConfig} from "./_basic_rule_config";
import {AbstractToken} from "../abap/1_lexer/tokens/abstract_token";
import {ParenLeftW, Comment, WParenRightW, WParenRight} from "../abap/1_lexer/tokens";
import {TokenNode, StatementNode, TokenNodeRegex} from "../abap/nodes";
import {Unknown, MacroContent, MacroCall, NativeSQL} from "../abap/2_statements/statements/_statement";
import {Events, MethodDef} from "../abap/2_statements/statements";
import {Position} from "../position";
import {EditHelper} from "../edit_helper";
import {IRuleMetadata, RuleTag} from "./_irule";
import {ABAPFile} from "../abap/abap_file";
export class DoubleSpaceConf extends BasicRuleConfig {
/** Check for double space after keywords */
public keywords: boolean = true;
/** list of keywords to skip, case insensitive */
public skipKeywords?: string[] = ["CHANGING", "EXPORTING", "OTHERS"];
/** Check for double space after start parenthesis */
public startParen: boolean = true;
/** Check for double space before end parenthesis */
public endParen: boolean = true;
/** Check for double space after colon/chaining operator */
public afterColon: boolean = true;
}
export class DoubleSpace extends ABAPRule {
private conf = new DoubleSpaceConf();
public getMetadata(): IRuleMetadata {
return {
key: "double_space",
title: "Double space",
shortDescription: `Checks that only a single space follows certain common statements.`,
tags: [RuleTag.Whitespace, RuleTag.Quickfix, RuleTag.SingleFile],
badExample: `DATA foo TYPE i.`,
goodExample: `DATA foo TYPE i.`,
};
}
private getMessage(): string {
return "Remove double space";
}
public getConfig() {
return this.conf;
}
public setConfig(conf: DoubleSpaceConf) {
this.conf = conf;
if (this.conf.skipKeywords === undefined) {
this.conf.skipKeywords = new DoubleSpaceConf().skipKeywords;
}
}
public runParsed(file: ABAPFile) {
let issues: Issue[] = [];
for (const s of file.getStatements()) {
if (s.get() instanceof NativeSQL) {
continue;
}
if (this.conf.keywords === true
&& !(s.get() instanceof Unknown)
&& !(s.get() instanceof MethodDef)
&& !(s.get() instanceof MacroCall)
&& !(s.get() instanceof Events)
&& !(s.get() instanceof MacroContent)) {
issues = issues.concat(this.checkKeywords(s, file));
}
issues = issues.concat(this.checkParen(s, file));
}
issues = issues.concat(this.checkAfterColon(file));
// remove issues with the same starting position
const uniqueIssues: Issue[] = [];
for (const issue of issues) {
if (uniqueIssues.findIndex(i => i.getStart().equals(issue.getStart())) === -1) {
uniqueIssues.push(issue);
}
}
return uniqueIssues;
}
private checkAfterColon(file: ABAPFile): Issue[] {
const issues: Issue[] = [];
let cPosition: Position | undefined = undefined;
if (this.conf.afterColon !== true) {
return [];
}
for (const s of file.getStatements()) {
const colon = s.getColon();
if (colon === undefined) {
continue;
} else if (cPosition !== undefined && cPosition.getCol() === colon.getCol()) {
continue;
}
cPosition = colon.getStart();
for (const t of s.getTokens()) {
if (t.getRow() !== cPosition.getRow()) {
return [];
} else if (t.getCol() < cPosition.getCol()) {
continue;
}
if (t.getCol() > cPosition.getCol() + 2) {
const issueStartPos = new Position(cPosition.getRow(), cPosition.getCol() + 2);
const issueEndPos = new Position(t.getRow(), t.getCol());
const fix = EditHelper.deleteRange(file, issueStartPos, issueEndPos);
issues.push(Issue.atRange(file, issueStartPos, issueEndPos, this.getMessage(), this.getMetadata().key, this.conf.severity, fix));
}
break;
}
}
return issues;
}
private checkParen(s: StatementNode, file: ABAPFile): Issue[] {
const issues: Issue[] = [];
let prev: AbstractToken | undefined = undefined;
for (const t of s.getTokens()) {
if (prev === undefined) {
prev = t;
continue;
}
if (this.getConfig().startParen === true
&& prev.getRow() === t.getRow()
&& prev instanceof ParenLeftW
&& !(t instanceof Comment)
&& prev.getEnd().getCol() + 1 < t.getCol()) {
const issueStartPos = new Position(prev.getRow(), prev.getCol() + 2);
const issueEndPos = new Position(t.getRow(), t.getCol());
const fix = EditHelper.deleteRange(file, issueStartPos, issueEndPos);
if (this.pragmaInRange(s.getPragmas(), issueStartPos, issueEndPos) === false) {
issues.push(Issue.atRange(file, issueStartPos, issueEndPos, this.getMessage(), this.getMetadata().key, this.conf.severity, fix));
}
}
if (this.getConfig().endParen === true
&& prev.getRow() === t.getRow()
&& !(prev instanceof ParenLeftW)
&& (t instanceof WParenRightW || t instanceof WParenRight)
&& prev.getEnd().getCol() + 1 < t.getCol()) {
const issueStartPos = new Position(prev.getEnd().getRow(), prev.getEnd().getCol() + 1);
const issueEndPos = new Position(t.getRow(), t.getCol());
const fix = EditHelper.deleteRange(file, issueStartPos, issueEndPos);
if (this.pragmaInRange(s.getPragmas(), issueStartPos, issueEndPos) === false) {
issues.push(Issue.atRange(file, issueStartPos, issueEndPos, this.getMessage(), this.getMetadata().key, this.conf.severity, fix));
}
}
prev = t;
}
return issues;
}
private pragmaInRange(pragmas: readonly AbstractToken[], start: Position, end: Position): boolean {
let ret = false;
for (const p of pragmas) {
if (p.getStart().isBetween(start, end)) {
ret = true;
}
}
return ret;
}
private checkKeywords(s: StatementNode, file: ABAPFile): Issue[] {
const issues: Issue[] = [];
let prev: TokenNode | undefined = undefined;
if (s.getColon() !== undefined || s.getPragmas().length > 0) {
// for chained statments just give up
return [];
}
for (const n of s.getTokenNodes()) {
if (prev === undefined) {
prev = n;
continue;
}
const upper = prev.get().getStr().toUpperCase();
if (prev instanceof TokenNodeRegex
|| upper === "("
|| upper === ")"
|| this.getConfig().skipKeywords!.some(e => e.toUpperCase() === upper)) {
// not a keyword, continue
prev = n;
continue;
}
if (prev.get().getStart().getRow() === n.get().getStart().getRow()
&& prev.get().getEnd().getCol() + 1 < n.get().getStart().getCol()) {
const issueStartPos = new Position(prev.get().getEnd().getRow(), prev.get().getEnd().getCol() + 1);
const issueEndPos = new Position(n.get().getRow(), n.get().getCol());
const fix = EditHelper.deleteRange(file, issueStartPos, issueEndPos);
issues.push(Issue.atRange(file, issueStartPos, issueEndPos, this.getMessage(), this.getMetadata().key, this.conf.severity, fix));
return issues;
}
prev = n;
}
return [];
}
} |