@abaplint/core 2.109.2 → 2.110.0

package/build/abaplint.d.ts

@@ -3221,10 +3221,14 @@ declare interface IMacroReferences {
     addReference(ref: IFilenameAndToken): void;
     listDefinitionsByFile(filename: string): Token[];
     listUsagesbyMacro(filename: string, token: Token): IFilenameAndToken[];
-    getDefinitionPosition(filename: string, token: Token): {
+    getDefinitionRange(filename: string, token: Token): {
         start: Position;
         end: Position;
     } | undefined;
+    findDefinitionByUsage(filename: string, token: Token): {
+        filename: string;
+        token: Token;
+    } | undefined;
     clear(filename: string): void;
 }
 

package/build/src/lsp/_lookup.js

@@ -12,6 +12,7 @@ const _reference_1 = require("../abap/5_syntax/_reference");
 const _builtin_1 = require("../abap/5_syntax/_builtin");
 const _scope_type_1 = require("../abap/5_syntax/_scope_type");
 const types_1 = require("../abap/types");
+const _statement_1 = require("../abap/2_statements/statements/_statement");
 class LSPLookup {
     static lookup(cursor, reg, obj) {
         var _a, _b;
@@ -128,6 +129,18 @@ class LSPLookup {
                 scope: bottomScope,
             };
         }
+        if (cursor.snode.get() instanceof _statement_1.MacroCall) {
+            const macroDefinition = reg.getMacroReferences().findDefinitionByUsage(cursor.identifier.getFilename(), cursor.snode.getFirstToken());
+            if (macroDefinition) {
+                return {
+                    hover: "Macro Call",
+                    definition: {
+                        uri: macroDefinition === null || macroDefinition === void 0 ? void 0 : macroDefinition.filename,
+                        range: _lsp_utils_1.LSPUtils.tokenToRange(macroDefinition.token),
+                    },
+                };
+            }
+        }
         if (hoverValue !== "") {
             return { hover: hoverValue, scope: bottomScope };
         }

package/build/src/lsp/references.js

@@ -30,6 +30,7 @@ class References {
         const locs = this.search(lookup.definitionId, lookup.scope);
         return locs.map(_lsp_utils_1.LSPUtils.identiferToLocation);
     }
+    ////////////////////////////////////////////
     // todo, cleanup this mehtod, some of the method parameters are not used anymore?
     search(identifier, node, exitAfterFound = false, removeDuplicates = true) {
         let ret = [];
@@ -57,7 +58,6 @@ class References {
             return ret;
         }
     }
-    ////////////////////////////////////////////
     removeDuplicates(arr) {
         const values = {};
         return arr.filter(item => {

package/build/src/macro_references.js

@@ -15,7 +15,7 @@ class MacroReferences {
         }
         this.definitions[ref.filename].push({ token: ref.token, start, end });
     }
-    getDefinitionPosition(filename, token) {
+    getDefinitionRange(filename, token) {
         for (const d of this.definitions[filename] || []) {
             if (d.token.getStart().equals(token.getStart())) {
                 return { start: d.start, end: d.end };
@@ -50,6 +50,22 @@ class MacroReferences {
         delete this.definitions[filename];
         delete this.references[filename];
     }
+    findDefinitionByUsage(filename, token) {
+        const tokenStr = token.getStr().toUpperCase();
+        for (const ref of this.references[filename] || []) {
+            if (ref.token.getStart().equals(token.getStart())) {
+                for (const d of this.definitions[ref.filename] || []) {
+                    if (d.token.getStr().toUpperCase() === tokenStr) {
+                        return {
+                            filename: ref.filename,
+                            token: d.token,
+                        };
+                    }
+                }
+            }
+        }
+        return undefined;
+    }
 }
 exports.MacroReferences = MacroReferences;
 //# sourceMappingURL=macro_references.js.map

package/build/src/registry.js

@@ -67,7 +67,7 @@ class Registry {
     }
     static abaplintVersion() {
         // magic, see build script "version.sh"
-        return "2.109.2";
+        return "2.110.0";
     }
     getDDICReferences() {
         return this.ddicReferences;

package/build/src/rules/index.js

@@ -31,7 +31,6 @@ __exportStar(require("./cds_legacy_view"), exports);
 __exportStar(require("./cds_parser_error"), exports);
 __exportStar(require("./chain_mainly_declarations"), exports);
 __exportStar(require("./change_if_to_case"), exports);
-__exportStar(require("./unused_macros"), exports);
 __exportStar(require("./check_abstract"), exports);
 __exportStar(require("./check_comments"), exports);
 __exportStar(require("./check_ddic"), exports);
@@ -93,6 +92,7 @@ __exportStar(require("./line_only_punc"), exports);
 __exportStar(require("./local_class_naming"), exports);
 __exportStar(require("./local_testclass_consistency"), exports);
 __exportStar(require("./local_variable_names"), exports);
+__exportStar(require("./macro_naming"), exports);
 __exportStar(require("./main_file_contents"), exports);
 __exportStar(require("./many_parentheses"), exports);
 __exportStar(require("./max_one_method_parameter_per_line"), exports);
@@ -170,6 +170,7 @@ __exportStar(require("./unnecessary_return"), exports);
 __exportStar(require("./unreachable_code"), exports);
 __exportStar(require("./unsecure_fae"), exports);
 __exportStar(require("./unused_ddic"), exports);
+__exportStar(require("./unused_macros"), exports);
 __exportStar(require("./unused_methods"), exports);
 __exportStar(require("./unused_types"), exports);
 __exportStar(require("./unused_variables"), exports);

package/build/src/rules/macro_naming.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MacroNaming = exports.MacroNamingConf = void 0;
+const issue_1 = require("../issue");
+const _abap_rule_1 = require("./_abap_rule");
+const Statements = require("../abap/2_statements/statements");
+const Expressions = require("../abap/2_statements/expressions");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const _irule_1 = require("./_irule");
+const objects_1 = require("../objects");
+class MacroNamingConf extends _basic_rule_config_1.BasicRuleConfig {
+    constructor() {
+        super(...arguments);
+        /** The pattern for macros, case insensitive */
+        this.pattern = "^_.+$";
+    }
+}
+exports.MacroNamingConf = MacroNamingConf;
+class MacroNaming extends _abap_rule_1.ABAPRule {
+    constructor() {
+        super(...arguments);
+        this.conf = new MacroNamingConf();
+    }
+    getMetadata() {
+        return {
+            key: "macro_naming",
+            title: "Macro naming conventions",
+            shortDescription: `Allows you to enforce a pattern for macro definitions`,
+            extendedInformation: `Use rule "avoid_use" to avoid macros alotogether.`,
+            tags: [_irule_1.RuleTag.Naming, _irule_1.RuleTag.SingleFile],
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    runParsed(file, obj) {
+        const issues = [];
+        const testRegex = new RegExp(this.conf.pattern, "i");
+        if (obj instanceof objects_1.TypePool) {
+            return [];
+        }
+        for (const stat of file.getStatements()) {
+            if (!(stat.get() instanceof Statements.Define)) {
+                continue;
+            }
+            const expr = stat.findDirectExpression(Expressions.MacroName);
+            if (expr === undefined) {
+                continue;
+            }
+            const token = expr.getFirstToken();
+            if (testRegex.exec(token.getStr())) {
+                continue;
+            }
+            else {
+                const message = "Bad macro name naming, expected \"" + this.conf.pattern + "\", got \"" + token.getStr() + "\"";
+                const issue = issue_1.Issue.atToken(file, token, message, this.getMetadata().key, this.conf.severity);
+                issues.push(issue);
+            }
+        }
+        return issues;
+    }
+}
+exports.MacroNaming = MacroNaming;
+//# sourceMappingURL=macro_naming.js.map

package/build/src/rules/rfc_error_handling.js

@@ -22,11 +22,9 @@ class RFCErrorHandling extends _abap_rule_1.ABAPRule {
             tags: [_irule_1.RuleTag.SingleFile],
             shortDescription: `Checks that exceptions 'system_failure' and 'communication_failure' are handled in RFC calls`,
             extendedInformation: `https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abenrfc_exception.htm`,
-            badExample: `
-CALL FUNCTION 'ZRFC'
+            badExample: `CALL FUNCTION 'ZRFC'
   DESTINATION lv_rfc.`,
-            goodExample: `
-CALL FUNCTION 'ZRFC'
+            goodExample: `CALL FUNCTION 'ZRFC'
   DESTINATION lv_rfc
   EXCEPTIONS
     system_failure        = 1 MESSAGE msg

package/build/src/rules/types_naming.js

@@ -11,7 +11,7 @@ const objects_1 = require("../objects");
 class TypesNamingConf extends _basic_rule_config_1.BasicRuleConfig {
     constructor() {
         super(...arguments);
-        /** The pattern for TYPES */
+        /** The pattern for TYPES, case insensitive */
         this.pattern = "^TY_.+$";
     }
 }

package/build/src/rules/unused_macros.js

@@ -61,7 +61,7 @@ foobar2.`,
                 const usages = references.listUsagesbyMacro(file.getFilename(), macroToken);
                 if (usages.length === 0 && ((_a = this.conf.skipNames) === null || _a === void 0 ? void 0 : _a.includes(macroToken.getStr().toUpperCase())) === false) {
                     const message = "Unused macro definition: " + macroToken.getStr();
-                    const pos = references.getDefinitionPosition(file.getFilename(), macroToken);
+                    const pos = references.getDefinitionRange(file.getFilename(), macroToken);
                     const fix = edit_helper_1.EditHelper.deleteRange(file, pos.start, pos.end);
                     result.push(issue_1.Issue.atToken(file, macroToken, message, this.getMetadata().key, this.conf.severity, fix));
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/core",
-    "version": "2.109.2",
+    "version": "2.110.0",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",
@@ -57,7 +57,7 @@
         "chai": "^4.4.1",
         "eslint": "^8.57.0",
         "mocha": "^10.4.0",
-        "c8": "^9.1.0",
+        "c8": "^10.1.2",
         "source-map-support": "^0.5.21",
         "ts-json-schema-generator": "=2.0.1",
         "typescript": "^5.4.5"