@abaplint/core 2.93.0 → 2.93.3

package/adhoc/lexer_performance.ts

@@ -0,0 +1,17 @@
+import {MemoryFile} from "../src";
+import {Lexer} from "../src/abap/1_lexer/lexer";
+import * as fs from "fs";
+
+console.log("========================");
+const file = new MemoryFile("abapgit.abap", fs.readFileSync("./lexer_performance.abap", "utf-8"));
+
+let total = 0;
+for (let i = 0; i < 10; i++) {
+  const before = Date.now();
+  const result = Lexer.run(file);
+  const runtime = Date.now() - before;
+  console.log("Runtime: " + runtime + "ms");
+  total += runtime;
+  console.log("Tokens: " + result.tokens.length);
+}
+console.log("Total: " + total);

package/build/abaplint.d.ts

@@ -4488,7 +4488,6 @@ export declare class Registry implements IRegistry {
     private readonly dependencies;
     private readonly references;
     private conf;
-    private issues;
     constructor(conf?: IConfiguration);
     static abaplintVersion(): string;
     getDDICReferences(): IDDICReferences;
@@ -4519,8 +4518,6 @@ export declare class Registry implements IRegistry {
     parseAsync(input?: IRunInput): Promise<this>;
     private parsePrivate;
     private isDirty;
-    private runRules;
-    private excludeIssues;
     private findOrCreate;
     private removeObject;
     private find;
@@ -4602,6 +4599,14 @@ declare class RollbackEntities implements IStatement {
     getMatcher(): IStatementRunnable;
 }
 
+export declare class RulesRunner {
+    private readonly reg;
+    constructor(reg: IRegistry);
+    objectsToCheck(objects: Iterable<IObject>): readonly IObject[];
+    runRules(objects: Iterable<IObject>, input?: IRunInput): readonly Issue[];
+    excludeIssues(issues: Issue[]): Issue[];
+}
+
 declare enum RuleTag {
     Experimental = "Experimental",
     DeprecationCandidate = "DeprecationCandidate",
@@ -5516,6 +5521,7 @@ declare class StructureNode extends AbstractNode<StructureNode | StatementNode>
     findAllStatements(type: new () => IStatement): StatementNode[];
     findAllStatementNodes(): StatementNode[];
     findAllStructuresRecursive(type: new () => IStructure): StructureNode[];
+    findAllStructuresMulti(type: (new () => IStructure)[]): StructureNode[];
     findAllStructures(type: new () => IStructure): StructureNode[];
     findDirectStructure(type: new () => IStructure): StructureNode | undefined;
     findFirstStructure(type: new () => IStructure): StructureNode | undefined;

package/build/adhoc/lexer_performance.d.ts

@@ -0,0 +1 @@
+export {};

package/build/adhoc/lexer_performance.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const src_1 = require("../src");
+const lexer_1 = require("../src/abap/1_lexer/lexer");
+const fs = require("fs");
+console.log("========================");
+const file = new src_1.MemoryFile("abapgit.abap", fs.readFileSync("./lexer_performance.abap", "utf-8"));
+let total = 0;
+for (let i = 0; i < 10; i++) {
+    const before = Date.now();
+    const result = lexer_1.Lexer.run(file);
+    const runtime = Date.now() - before;
+    console.log("Runtime: " + runtime + "ms");
+    total += runtime;
+    console.log("Tokens: " + result.tokens.length);
+}
+console.log("Total: " + total);
+//# sourceMappingURL=lexer_performance.js.map

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

@@ -318,7 +318,7 @@ class Lexer {
                 && buf.length > 1
                 && current === "`"
                 && aahead !== "``"
-                && (buf.match(/`/g) || []).length % 2 === 0
+                && (buf.split("`").length - 1) % 2 === 0
                 && ahead !== "`") {
                 // end of ping
                 this.add();
@@ -341,7 +341,7 @@ class Lexer {
                 && current === "'"
                 && buf.length > 1
                 && aahead !== "''"
-                && (buf.match(/'/g) || []).length % 2 === 0
+                && (buf.split("'").length - 1) % 2 === 0
                 && ahead !== "'") {
                 // end of string
                 this.add();

package/build/src/abap/nodes/structure_node.js

@@ -174,6 +174,30 @@ class StructureNode extends _abstract_node_1.AbstractNode {
         }
         return ret;
     }
+    findAllStructuresMulti(type) {
+        const ret = [];
+        for (const t of type) {
+            if (this.get() instanceof t) {
+                return [this];
+            }
+        }
+        for (const child of this.getChildren()) {
+            if (child instanceof statement_node_1.StatementNode) {
+                continue;
+            }
+            let found = false;
+            for (const t of type) {
+                if (this.get() instanceof t) {
+                    ret.push(child);
+                    found = true;
+                }
+            }
+            if (found === false) {
+                ret.push(...child.findAllStructuresMulti(type));
+            }
+        }
+        return ret;
+    }
     findAllStructures(type) {
         const ret = [];
         if (this.get() instanceof type) {

package/build/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Severity = exports.Visibility = exports.Info = exports.Rename = exports.PrettyPrinter = exports.Position = exports.CurrentScope = exports.ABAPFile = exports.SpaghettiScope = exports.SyntaxLogic = exports.ABAPObject = exports.Tokens = exports.ExpressionsCDS = exports.CDSParser = exports.LanguageServerTypes = exports.DDLParser = exports.applyEditList = exports.applyEditSingle = exports.SpaghettiScopeNode = exports.AbstractFile = exports.Token = exports.ScopeType = exports.BasicTypes = exports.TypedIdentifier = exports.AbstractType = exports.VirtualPosition = exports.Comment = exports.Unknown = exports.Empty = exports.Identifier = exports.Nodes = exports.Types = exports.Expressions = exports.Statements = exports.Structures = exports.Objects = exports.ArtifactsRules = exports.ArtifactsObjects = exports.ArtifactsABAP = exports.BuiltIn = exports.MethodLengthStats = exports.LanguageServer = exports.Registry = exports.ReferenceType = exports.Version = exports.Config = exports.Issue = exports.MemoryFile = void 0;
+exports.Severity = exports.Visibility = exports.Info = exports.Rename = exports.PrettyPrinter = exports.Position = exports.CurrentScope = exports.ABAPFile = exports.RulesRunner = exports.SpaghettiScope = exports.SyntaxLogic = exports.ABAPObject = exports.Tokens = exports.ExpressionsCDS = exports.CDSParser = exports.LanguageServerTypes = exports.DDLParser = exports.applyEditList = exports.applyEditSingle = exports.SpaghettiScopeNode = exports.AbstractFile = exports.Token = exports.ScopeType = exports.BasicTypes = exports.TypedIdentifier = exports.AbstractType = exports.VirtualPosition = exports.Comment = exports.Unknown = exports.Empty = exports.Identifier = exports.Nodes = exports.Types = exports.Expressions = exports.Statements = exports.Structures = exports.Objects = exports.ArtifactsRules = exports.ArtifactsObjects = exports.ArtifactsABAP = exports.BuiltIn = exports.MethodLengthStats = exports.LanguageServer = exports.Registry = exports.ReferenceType = exports.Version = exports.Config = exports.Issue = exports.MemoryFile = void 0;
 const issue_1 = require("./issue");
 Object.defineProperty(exports, "Issue", { enumerable: true, get: function () { return issue_1.Issue; } });
 const config_1 = require("./config");
@@ -92,4 +92,6 @@ const ddl_parser_1 = require("./ddl/ddl_parser");
 Object.defineProperty(exports, "DDLParser", { enumerable: true, get: function () { return ddl_parser_1.DDLParser; } });
 const cds_parser_1 = require("./cds/cds_parser");
 Object.defineProperty(exports, "CDSParser", { enumerable: true, get: function () { return cds_parser_1.CDSParser; } });
+const rules_runner_1 = require("./rules_runner");
+Object.defineProperty(exports, "RulesRunner", { enumerable: true, get: function () { return rules_runner_1.RulesRunner; } });
 //# sourceMappingURL=index.js.map

package/build/src/objects/_unknown_object.js

@@ -26,7 +26,7 @@ class UnknownObject extends _abstract_object_1.AbstractObject {
         const pos = new position_1.Position(1, 1);
         const file = this.getFiles()[0];
         const message = "Unknown object type, currently not supported in abaplint, open issue on github";
-        const issue = issue_1.Issue.atPosition(file, pos, message, "registry_add", severity_1.Severity.Error);
+        const issue = issue_1.Issue.atPosition(file, pos, message, "parser_error", severity_1.Severity.Error);
         return [issue];
     }
 }

package/build/src/registry.js

@@ -3,13 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Registry = void 0;
 const config_1 = require("./config");
 const artifacts_objects_1 = require("./artifacts_objects");
-const artifacts_rules_1 = require("./artifacts_rules");
-const skip_logic_1 = require("./skip_logic");
-const _abap_object_1 = require("./objects/_abap_object");
 const find_global_definitions_1 = require("./abap/5_syntax/global_definitions/find_global_definitions");
-const syntax_1 = require("./abap/5_syntax/syntax");
 const excludeHelper_1 = require("./utils/excludeHelper");
 const ddic_references_1 = require("./ddic_references");
+const rules_runner_1 = require("./rules_runner");
 // todo, this should really be an instance in case there are multiple Registry'ies
 class ParsingPerformance {
     static clear() {
@@ -61,13 +58,12 @@ class Registry {
         this.objects = {};
         this.objectsByType = {};
         this.dependencies = {};
-        this.issues = [];
         this.conf = conf ? conf : config_1.Config.getDefault();
         this.references = new ddic_references_1.DDICReferences();
     }
     static abaplintVersion() {
         // magic, see build script "version.sh"
-        return "2.93.0";
+        return "2.93.3";
     }
     getDDICReferences() {
         return this.references;
@@ -245,14 +241,14 @@ class Registry {
         if (this.isDirty() === true) {
             this.parse();
         }
-        return this.runRules(input);
+        return new rules_runner_1.RulesRunner(this).runRules(this.getObjects(), input);
     }
     // todo, this will be changed to async sometime
     findIssuesObject(iobj) {
         if (this.isDirty() === true) {
             this.parse();
         }
-        return this.runRules(undefined, iobj);
+        return new rules_runner_1.RulesRunner(this).runRules([iobj]);
     }
     // todo, this will be changed to async sometime
     parse() {
@@ -260,10 +256,8 @@ class Registry {
             return this;
         }
         ParsingPerformance.clear();
-        this.issues = [];
         for (const o of this.getObjects()) {
             this.parsePrivate(o);
-            this.issues.push(...o.getParsingIssues());
         }
         new find_global_definitions_1.FindGlobalDefinitions(this).run();
         return this;
@@ -275,11 +269,9 @@ class Registry {
         }
         ParsingPerformance.clear();
         (_a = input === null || input === void 0 ? void 0 : input.progress) === null || _a === void 0 ? void 0 : _a.set(this.getObjectCount(false), "Lexing and parsing");
-        this.issues = [];
         for (const o of this.getObjects()) {
             await ((_b = input === null || input === void 0 ? void 0 : input.progress) === null || _b === void 0 ? void 0 : _b.tick("Lexing and parsing(" + this.conf.getVersion() + ") - " + o.getType() + " " + o.getName()));
             this.parsePrivate(o);
-            this.issues.push(...o.getParsingIssues());
         }
         if ((input === null || input === void 0 ? void 0 : input.outputPerformance) === true) {
             ParsingPerformance.output();
@@ -303,91 +295,6 @@ class Registry {
         }
         return false;
     }
-    runRules(input, iobj) {
-        var _a, _b, _c, _d, _e, _f;
-        const rulePerformance = {};
-        const issues = this.issues.slice(0);
-        const objects = iobj ? [iobj] : this.getObjects();
-        const rules = this.conf.getEnabledRules();
-        const skipLogic = new skip_logic_1.SkipLogic(this);
-        (_a = input === null || input === void 0 ? void 0 : input.progress) === null || _a === void 0 ? void 0 : _a.set(iobj ? 1 : this.getObjectCount(false), "Run Syntax");
-        const check = [];
-        for (const obj of objects) {
-            (_b = input === null || input === void 0 ? void 0 : input.progress) === null || _b === void 0 ? void 0 : _b.tick("Run Syntax - " + obj.getName());
-            if (skipLogic.skip(obj) || this.isDependency(obj)) {
-                continue;
-            }
-            if (obj instanceof _abap_object_1.ABAPObject) {
-                new syntax_1.SyntaxLogic(this, obj).run();
-            }
-            check.push(obj);
-        }
-        (_c = input === null || input === void 0 ? void 0 : input.progress) === null || _c === void 0 ? void 0 : _c.set(rules.length, "Initialize Rules");
-        for (const rule of rules) {
-            (_d = input === null || input === void 0 ? void 0 : input.progress) === null || _d === void 0 ? void 0 : _d.tick("Initialize Rules - " + rule.getMetadata().key);
-            if (rule.initialize === undefined) {
-                throw new Error(rule.getMetadata().key + " missing initialize method");
-            }
-            rule.initialize(this);
-            rulePerformance[rule.getMetadata().key] = 0;
-        }
-        (_e = input === null || input === void 0 ? void 0 : input.progress) === null || _e === void 0 ? void 0 : _e.set(check.length, "Finding Issues");
-        for (const obj of check) {
-            (_f = input === null || input === void 0 ? void 0 : input.progress) === null || _f === void 0 ? void 0 : _f.tick("Finding Issues - " + obj.getType() + " " + obj.getName());
-            for (const rule of rules) {
-                const before = Date.now();
-                issues.push(...rule.run(obj));
-                const runtime = Date.now() - before;
-                rulePerformance[rule.getMetadata().key] = rulePerformance[rule.getMetadata().key] + runtime;
-            }
-        }
-        if ((input === null || input === void 0 ? void 0 : input.outputPerformance) === true) {
-            const perf = [];
-            for (const p in rulePerformance) {
-                if (rulePerformance[p] > 100) { // ignore rules if it takes less than 100ms
-                    perf.push({ name: p, time: rulePerformance[p] });
-                }
-            }
-            perf.sort((a, b) => { return b.time - a.time; });
-            for (const p of perf) {
-                process.stderr.write("\t" + p.time + "ms\t" + p.name + "\n");
-            }
-        }
-        return this.excludeIssues(issues);
-    }
-    excludeIssues(issues) {
-        var _a;
-        const ret = issues;
-        const globalNoIssues = this.conf.getGlobal().noIssues || [];
-        const globalNoIssuesPatterns = globalNoIssues.map(x => new RegExp(x, "i"));
-        if (globalNoIssuesPatterns.length > 0) {
-            for (let i = ret.length - 1; i >= 0; i--) {
-                const filename = ret[i].getFilename();
-                if (excludeHelper_1.ExcludeHelper.isExcluded(filename, globalNoIssuesPatterns)) {
-                    ret.splice(i, 1);
-                }
-            }
-        }
-        // exclude issues, as now we know both the filename and issue key
-        for (const rule of artifacts_rules_1.ArtifactsRules.getRules()) {
-            const key = rule.getMetadata().key;
-            const ruleExclude = (_a = this.conf.readByKey(key, "exclude")) !== null && _a !== void 0 ? _a : [];
-            if (ruleExclude.length === 0) {
-                continue;
-            }
-            const ruleExcludePatterns = ruleExclude.map(x => new RegExp(x, "i"));
-            for (let i = ret.length - 1; i >= 0; i--) {
-                if (ret[i].getKey() !== key) {
-                    continue;
-                }
-                const filename = ret[i].getFilename();
-                if (excludeHelper_1.ExcludeHelper.isExcluded(filename, ruleExcludePatterns)) {
-                    ret.splice(i, 1);
-                }
-            }
-        }
-        return ret;
-    }
     findOrCreate(name, type) {
         try {
             return this.find(name, type);

package/build/src/rules/begin_end_names.js

@@ -24,11 +24,11 @@ class BeginEndNames extends _abap_rule_1.ABAPRule {
             shortDescription: `Check BEGIN OF and END OF names match, plus there must be statements between BEGIN and END`,
             tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
             badExample: `DATA: BEGIN OF stru,
-      field TYPE i,
-    END OF structure_not_the_same.`,
+        field TYPE i,
+      END OF structure_not_the_same.`,
             goodExample: `DATA: BEGIN OF stru,
-      field TYPE i,
-    END OF stru.`,
+        field TYPE i,
+      END OF stru.`,
         };
     }
     getConfig() {

package/build/src/rules/cds_comment_style.js

@@ -21,6 +21,8 @@ class CDSCommentStyle {
             shortDescription: `Check for obsolete comment style`,
             extendedInformation: `Check for obsolete comment style
 
+Comments starting with "--" are considered obsolete
+
 https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abencds_general_syntax_rules.htm`,
             tags: [_irule_1.RuleTag.SingleFile],
             badExample: "-- this is a comment",

package/build/src/rules/cds_legacy_view.js

@@ -24,7 +24,7 @@ class CDSLegacyView {
 https://blogs.sap.com/2021/10/16/a-new-generation-of-cds-views-how-to-migrate-your-cds-views-to-cds-view-entities/
 
 v755 and up`,
-            tags: [_irule_1.RuleTag.SingleFile],
+            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Upport],
         };
     }
     getConfig() {

package/build/src/rules/change_if_to_case.js

@@ -29,8 +29,8 @@ ELSEIF l_fcat-fieldname = 'BAR'
     OR l_fcat-fieldname = 'MOO'.
 ENDIF.`,
             goodExample: `CASE l_fcat-fieldname.
-  WHEN 'FOO.
-  WHEN 'BAR' OR MOO.
+  WHEN 'FOO'.
+  WHEN 'BAR' OR 'MOO'.
 ENDCASE.`,
         };
     }

package/build/src/rules/definitions_top.js

@@ -56,16 +56,15 @@ https://docs.abapopenchecks.org/checks/17/`,
         if (containsUnknown === true) {
             return [];
         }
-        const routines = structure.findAllStructures(Structures.Form).concat(structure.findAllStructures(Structures.Method));
+        const routines = structure.findAllStructuresMulti([Structures.Form, Structures.Method]);
         for (const r of routines) {
             // one fix per routine
             this.fixed = false;
             this.mode = DEFINITION;
             this.moveTo = (_a = r.getFirstStatement()) === null || _a === void 0 ? void 0 : _a.getLastToken().getEnd();
-            if (this.reg.getConfig().getVersion() !== version_1.Version.v702) {
-                if (r.findFirstExpression(Expressions.InlineData)) {
-                    continue;
-                }
+            if (this.reg.getConfig().getVersion() !== version_1.Version.v702
+                && r.findFirstExpression(Expressions.InlineData)) {
+                continue;
             }
             const found = this.walk(r, file);
             if (found) {
@@ -79,20 +78,23 @@ https://docs.abapopenchecks.org/checks/17/`,
         var _a, _b, _c, _d, _e, _f;
         let previous = undefined;
         for (const c of r.getChildren()) {
-            if (c instanceof nodes_1.StatementNode && c.get() instanceof _statement_1.Comment) {
-                continue;
-            }
-            else if (c instanceof nodes_1.StatementNode && c.get() instanceof Statements.Form) {
-                continue;
-            }
-            else if (c instanceof nodes_1.StatementNode && c.get() instanceof Statements.MethodImplementation) {
-                continue;
+            const get = c.get();
+            if (c instanceof nodes_1.StatementNode) {
+                if (get instanceof _statement_1.Comment) {
+                    continue;
+                }
+                else if (get instanceof Statements.Form) {
+                    continue;
+                }
+                else if (get instanceof Statements.MethodImplementation) {
+                    continue;
+                }
             }
             if (c instanceof nodes_1.StructureNode
-                && (c.get() instanceof Structures.Data
-                    || c.get() instanceof Structures.Types
-                    || c.get() instanceof Structures.Constants
-                    || c.get() instanceof Structures.Statics)) {
+                && (get instanceof Structures.Data
+                    || get instanceof Structures.Types
+                    || get instanceof Structures.Constants
+                    || get instanceof Structures.Statics)) {
                 if (this.mode === AFTER) {
                     // These are chained structured statements
                     let fix = undefined;
@@ -118,11 +120,11 @@ https://docs.abapopenchecks.org/checks/17/`,
                 }
             }
             else if (c instanceof nodes_1.StatementNode
-                && (c.get() instanceof Statements.Data
-                    || c.get() instanceof Statements.Type
-                    || c.get() instanceof Statements.Constant
-                    || c.get() instanceof Statements.Static
-                    || c.get() instanceof Statements.FieldSymbol)) {
+                && (get instanceof Statements.Data
+                    || get instanceof Statements.Type
+                    || get instanceof Statements.Constant
+                    || get instanceof Statements.Static
+                    || get instanceof Statements.FieldSymbol)) {
                 if (this.mode === AFTER) {
                     // only one fix per routine, as it reorders a lot
                     let fix = undefined;
@@ -136,11 +138,11 @@ https://docs.abapopenchecks.org/checks/17/`,
                     this.moveTo = c.getLastToken().getEnd();
                 }
             }
-            else if (c instanceof nodes_1.StructureNode && c.get() instanceof Structures.Define) {
+            else if (c instanceof nodes_1.StructureNode && get instanceof Structures.Define) {
                 this.mode = IGNORE;
                 return undefined;
             }
-            else if (c instanceof nodes_1.StatementNode && c.get() instanceof _statement_1.Unknown) {
+            else if (c instanceof nodes_1.StatementNode && get instanceof _statement_1.Unknown) {
                 this.mode = IGNORE;
                 return undefined;
             }