@abaplint/core 2.93.99 → 2.94.0

package/build/src/abap/1_lexer/lexer.js

@@ -3,15 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Lexer = void 0;
 const position_1 = require("../../position");
 const tokens_1 = require("./tokens");
-var Mode;
-(function (Mode) {
-    Mode[Mode["Normal"] = 0] = "Normal";
-    Mode[Mode["Ping"] = 1] = "Ping";
-    Mode[Mode["Str"] = 2] = "Str";
-    Mode[Mode["Template"] = 3] = "Template";
-    Mode[Mode["Comment"] = 4] = "Comment";
-    Mode[Mode["Pragma"] = 5] = "Pragma";
-})(Mode || (Mode = {}));
 class Buffer {
     constructor() {
         this.buf = "";
@@ -101,10 +92,18 @@ class Stream {
     }
 }
 class Lexer {
+    constructor() {
+        this.ModeNormal = 1;
+        this.ModePing = 2;
+        this.ModeStr = 3;
+        this.ModeTemplate = 4;
+        this.ModeComment = 5;
+        this.ModePragma = 6;
+    }
     run(file, virtual) {
         this.virtual = virtual;
         this.tokens = [];
-        this.m = Mode.Normal;
+        this.m = this.ModeNormal;
         this.process(file.getRaw());
         return { file, tokens: this.tokens };
     }
@@ -130,13 +129,13 @@ class Lexer {
                 pos = new position_1.VirtualPosition(this.virtual, pos.getRow(), pos.getCol());
             }
             let tok = undefined;
-            if (this.m === Mode.Comment) {
+            if (this.m === this.ModeComment) {
                 tok = new tokens_1.Comment(pos, s);
             }
-            else if (this.m === Mode.Ping || this.m === Mode.Str) {
+            else if (this.m === this.ModePing || this.m === this.ModeStr) {
                 tok = new tokens_1.StringToken(pos, s);
             }
-            else if (this.m === Mode.Template) {
+            else if (this.m === this.ModeTemplate) {
                 const first = s.charAt(0);
                 const last = s.charAt(s.length - 1);
                 if (first === "|" && last === "|") {
@@ -308,39 +307,39 @@ class Lexer {
             const ahead = this.stream.nextChar();
             const aahead = this.stream.nextNextChar();
             const prev = this.stream.prevChar();
-            if (ahead === "'" && this.m === Mode.Normal) {
+            if (ahead === "'" && this.m === this.ModeNormal) {
                 // start string
                 this.add();
-                this.m = Mode.Str;
+                this.m = this.ModeStr;
             }
             else if ((ahead === "|" || ahead === "}")
-                && this.m === Mode.Normal) {
+                && this.m === this.ModeNormal) {
                 // start template
                 this.add();
-                this.m = Mode.Template;
+                this.m = this.ModeTemplate;
             }
-            else if (ahead === "`" && this.m === Mode.Normal) {
+            else if (ahead === "`" && this.m === this.ModeNormal) {
                 // start ping
                 this.add();
-                this.m = Mode.Ping;
+                this.m = this.ModePing;
             }
-            else if (aahead === "##" && this.m === Mode.Normal) {
+            else if (aahead === "##" && this.m === this.ModeNormal) {
                 // start pragma
                 this.add();
-                this.m = Mode.Pragma;
+                this.m = this.ModePragma;
             }
             else if ((ahead === "\"" || (ahead === "*" && current === "\n"))
-                && this.m === Mode.Normal) {
+                && this.m === this.ModeNormal) {
                 // start comment
                 this.add();
-                this.m = Mode.Comment;
+                this.m = this.ModeComment;
             }
-            else if (this.m === Mode.Pragma && (ahead === "," || ahead === ":" || ahead === "." || ahead === " " || ahead === "\n")) {
+            else if (this.m === this.ModePragma && (ahead === "," || ahead === ":" || ahead === "." || ahead === " " || ahead === "\n")) {
                 // end of pragma
                 this.add();
-                this.m = Mode.Normal;
+                this.m = this.ModeNormal;
             }
-            else if (this.m === Mode.Ping
+            else if (this.m === this.ModePing
                 && buf.length > 1
                 && current === "`"
                 && aahead !== "``"
@@ -349,21 +348,21 @@ class Lexer {
                 // end of ping
                 this.add();
                 if (ahead === `"`) {
-                    this.m = Mode.Comment;
+                    this.m = this.ModeComment;
                 }
                 else {
-                    this.m = Mode.Normal;
+                    this.m = this.ModeNormal;
                 }
             }
-            else if (this.m === Mode.Template
+            else if (this.m === this.ModeTemplate
                 && buf.length > 1
                 && (current === "|" || current === "{")
                 && (prev !== "\\" || this.stream.prevPrevChar() === "\\\\")) {
                 // end of template
                 this.add();
-                this.m = Mode.Normal;
+                this.m = this.ModeNormal;
             }
-            else if (this.m === Mode.Str
+            else if (this.m === this.ModeStr
                 && current === "'"
                 && buf.length > 1
                 && aahead !== "''"
@@ -372,13 +371,13 @@ class Lexer {
                 // end of string
                 this.add();
                 if (ahead === "\"") {
-                    this.m = Mode.Comment;
+                    this.m = this.ModeComment;
                 }
                 else {
-                    this.m = Mode.Normal;
+                    this.m = this.ModeNormal;
                 }
             }
-            else if (this.m === Mode.Normal
+            else if (this.m === this.ModeNormal
                 && (ahead === " "
                     || ahead === ":"
                     || ahead === "."
@@ -396,21 +395,21 @@ class Lexer {
                     || ahead === "\n")) {
                 this.add();
             }
-            else if (ahead === "\n" && this.m !== Mode.Template) {
+            else if (ahead === "\n" && this.m !== this.ModeTemplate) {
                 this.add();
-                this.m = Mode.Normal;
+                this.m = this.ModeNormal;
             }
-            else if (this.m === Mode.Template && current === "\n") {
+            else if (this.m === this.ModeTemplate && current === "\n") {
                 this.add();
             }
             else if (current === ">"
                 && (prev === "-" || prev === "=")
                 && ahead !== " "
-                && this.m === Mode.Normal) {
+                && this.m === this.ModeNormal) {
                 // arrows
                 this.add();
             }
-            else if (this.m === Mode.Normal
+            else if (this.m === this.ModeNormal
                 && (buf === "."
                     || buf === ","
                     || buf === ":"

package/build/src/abap/flow/flow_graph.js

@@ -3,16 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowGraph = void 0;
 class FlowGraph {
     constructor(counter) {
-        this.label = "undefined";
         this.edges = {};
-        this.start = "start#" + counter;
-        this.end = "end#" + counter;
+        this.label = "undefined";
+        this.startNode = "start#" + counter;
+        this.endNode = "end#" + counter;
     }
     getStart() {
-        return this.start;
+        return this.startNode;
     }
     getEnd() {
-        return this.end;
+        return this.endNode;
     }
     addEdge(from, to) {
         if (this.edges[from] === undefined) {
@@ -38,6 +38,18 @@ class FlowGraph {
         }
         return list;
     }
+    listInto(to, skipStart = true) {
+        const ret = [];
+        for (const e of this.listEdges()) {
+            if (skipStart === true && e.from === this.getStart()) {
+                continue;
+            }
+            if (e.to === to) {
+                ret.push(e.from);
+            }
+        }
+        return ret;
+    }
     listNodes() {
         const set = new Set();
         for (const l of this.listEdges()) {
@@ -99,7 +111,7 @@ ${this.toTextEdges()}
         }
         return Array.from(set.values());
     }
-    /** removes all nodes containing "#" that have one ingoing and one outgoing edge */
+    /** removes all nodes containing "#" that have one in-going and one out-going edge */
     reduce() {
         for (const node of this.listNodes()) {
             if (node.includes("#") === false) {

package/build/src/abap/flow/statement_flow.js

@@ -31,6 +31,7 @@ class StatementFlow {
         }
         return ret.map(f => f.reduce());
     }
+    ////////////////////
     findBody(f) {
         var _a;
         return ((_a = f.findDirectStructure(Structures.Body)) === null || _a === void 0 ? void 0 : _a.getChildren()) || [];

package/build/src/registry.js

@@ -63,7 +63,7 @@ class Registry {
     }
     static abaplintVersion() {
         // magic, see build script "version.sh"
-        return "2.93.99";
+        return "2.94.0";
     }
     getDDICReferences() {
         return this.references;

package/build/src/rules/if_in_if.js

@@ -2,10 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IfInIf = exports.IfInIfConf = void 0;
 const issue_1 = require("../issue");
+const Statements = require("../abap/2_statements/statements");
 const Structures = require("../abap/3_structures/structures");
 const _abap_rule_1 = require("./_abap_rule");
 const _basic_rule_config_1 = require("./_basic_rule_config");
 const _irule_1 = require("./_irule");
+const edit_helper_1 = require("../edit_helper");
 class IfInIfConf extends _basic_rule_config_1.BasicRuleConfig {
 }
 exports.IfInIfConf = IfInIfConf;
@@ -22,7 +24,7 @@ class IfInIf extends _abap_rule_1.ABAPRule {
             extendedInformation: `
 Directly nested IFs without ELSE can be refactored to a single condition using AND.
 
-ELSE condtions with directly nested IF refactored to ELSEIF.
+ELSE condtions with directly nested IF refactored to ELSEIF, quickfixes are suggested for this case.
 
 https://docs.abapopenchecks.org/checks/01/
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-the-nesting-depth-low`,
@@ -48,12 +50,9 @@ IF condition1.
 ELSEIF condition2.
   ...
 ENDIF.`,
-            tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
+            tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
         };
     }
-    getMessage() {
-        return "IF in IF. Use IF cond1 AND cond2 instead";
-    }
     getConfig() {
         return this.conf;
     }
@@ -61,6 +60,7 @@ ENDIF.`,
         this.conf = conf;
     }
     runParsed(file, obj) {
+        var _a, _b;
         const issues = [];
         if (obj.getType() === "INTF") {
             return [];
@@ -69,6 +69,7 @@ ENDIF.`,
         if (stru === undefined) {
             return [];
         }
+        let fixed = false;
         let possible = stru.findAllStructures(Structures.If);
         possible = possible.concat(stru.findAllStructures(Structures.Else));
         for (const i of possible) {
@@ -94,8 +95,23 @@ ENDIF.`,
                     || nestedIf.findDirectStructures(Structures.Else).length > 0)) {
                 continue;
             }
+            let message = "IF in IF. Use IF cond1 AND cond2 instead";
+            let fix = undefined;
+            if (i.get() instanceof Structures.Else) {
+                message = "Change ELSE part to ELSEIF";
+                const els = i.findFirstStatement(Statements.Else);
+                const iff = (_a = i.findFirstStructure(Structures.If)) === null || _a === void 0 ? void 0 : _a.findDirectStatement(Statements.If);
+                const endif = (_b = i.findFirstStructure(Structures.If)) === null || _b === void 0 ? void 0 : _b.findDirectStatement(Statements.EndIf);
+                if (fixed === false && iff && els && endif) {
+                    const fix1 = edit_helper_1.EditHelper.deleteRange(file, els.getLastToken().getStart(), iff === null || iff === void 0 ? void 0 : iff.getFirstToken().getStart());
+                    const fix2 = edit_helper_1.EditHelper.deleteStatement(file, endif);
+                    fix = edit_helper_1.EditHelper.merge(fix1, fix2);
+                    // max one fix per file at a time
+                    fixed = true;
+                }
+            }
             const token = i.getFirstToken();
-            const issue = issue_1.Issue.atToken(file, token, this.getMessage(), this.getMetadata().key, this.conf.severity);
+            const issue = issue_1.Issue.atToken(file, token, message, this.getMetadata().key, this.conf.severity, fix);
             issues.push(issue);
         }
         return issues;

package/build/src/rules/index.js

@@ -151,6 +151,7 @@ __exportStar(require("./uncaught_exception"), exports);
 __exportStar(require("./unknown_types"), exports);
 __exportStar(require("./unnecessary_chaining"), exports);
 __exportStar(require("./unnecessary_pragma"), exports);
+__exportStar(require("./unnecessary_return"), exports);
 __exportStar(require("./unreachable_code"), exports);
 __exportStar(require("./unsecure_fae"), exports);
 __exportStar(require("./unused_ddic"), exports);

package/build/src/rules/unnecessary_return.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnnecessaryReturn = exports.UnnecessaryReturnConf = void 0;
+const issue_1 = require("../issue");
+const _abap_rule_1 = require("./_abap_rule");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const _irule_1 = require("./_irule");
+const Statements = require("../abap/2_statements/statements");
+const edit_helper_1 = require("../edit_helper");
+class UnnecessaryReturnConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.UnnecessaryReturnConf = UnnecessaryReturnConf;
+class UnnecessaryReturn extends _abap_rule_1.ABAPRule {
+    constructor() {
+        super(...arguments);
+        this.conf = new UnnecessaryReturnConf();
+    }
+    getMetadata() {
+        return {
+            key: "unnecessary_return",
+            title: "Unnecessary Return",
+            shortDescription: `Finds unnecessary RETURN statements`,
+            extendedInformation: `Finds unnecessary RETURN statements`,
+            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
+            badExample: `METHOD hello.
+  ...
+  RETURN.
+ENDMETHOD.`,
+            goodExample: `METHOD hello.
+  ...
+ENDMETHOD.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    runParsed(file) {
+        const issues = [];
+        const structure = file.getStructure();
+        if (structure === undefined) {
+            return [];
+        }
+        const statements = file.getStatements();
+        for (let i = 0; i < statements.length - 1; i++) {
+            const node = statements[i];
+            const next = statements[i + 1];
+            if (node.get() instanceof Statements.Return
+                && (next.get() instanceof Statements.EndMethod
+                    || next.get() instanceof Statements.EndForm
+                    || next.get() instanceof Statements.EndFunction)) {
+                const message = "Unnecessary RETURN";
+                const fix = edit_helper_1.EditHelper.deleteStatement(file, node);
+                issues.push(issue_1.Issue.atStatement(file, node, message, this.getMetadata().key, this.getConfig().severity, fix));
+            }
+        }
+        return issues;
+    }
+}
+exports.UnnecessaryReturn = UnnecessaryReturn;
+//# sourceMappingURL=unnecessary_return.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/core",
-    "version": "2.93.99",
+    "version": "2.94.0",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",
@@ -48,7 +48,7 @@
     "devDependencies": {
         "@microsoft/api-extractor": "^7.33.6",
         "@types/chai": "^4.3.4",
-        "@types/mocha": "^10.0.0",
+        "@types/mocha": "^10.0.1",
         "@types/node": "^18.11.9",
         "chai": "^4.3.7",
         "eslint": "^8.28.0",