@abaplint/cli 2.109.2 → 2.110.0

package/build/cli.js

@@ -41676,6 +41676,7 @@ const _reference_1 = __webpack_require__(/*! ../abap/5_syntax/_reference */ "./n
 const _builtin_1 = __webpack_require__(/*! ../abap/5_syntax/_builtin */ "./node_modules/@abaplint/core/build/src/abap/5_syntax/_builtin.js");
 const _scope_type_1 = __webpack_require__(/*! ../abap/5_syntax/_scope_type */ "./node_modules/@abaplint/core/build/src/abap/5_syntax/_scope_type.js");
 const types_1 = __webpack_require__(/*! ../abap/types */ "./node_modules/@abaplint/core/build/src/abap/types/index.js");
+const _statement_1 = __webpack_require__(/*! ../abap/2_statements/statements/_statement */ "./node_modules/@abaplint/core/build/src/abap/2_statements/statements/_statement.js");
 class LSPLookup {
     static lookup(cursor, reg, obj) {
         var _a, _b;
@@ -41792,6 +41793,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 };
         }
@@ -43263,6 +43276,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 = [];
@@ -43290,7 +43304,6 @@ class References {
             return ret;
         }
     }
-    ////////////////////////////////////////////
     removeDuplicates(arr) {
         const values = {};
         return arr.filter(item => {
@@ -43740,7 +43753,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 };
@@ -43775,6 +43788,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
@@ -51745,7 +51774,7 @@ class Registry {
     }
     static abaplintVersion() {
         // magic, see build script "version.sh"
-        return "2.109.2";
+        return "2.110.0";
     }
     getDDICReferences() {
         return this.ddicReferences;
@@ -62487,7 +62516,6 @@ __exportStar(__webpack_require__(/*! ./cds_legacy_view */ "./node_modules/@abapl
 __exportStar(__webpack_require__(/*! ./cds_parser_error */ "./node_modules/@abaplint/core/build/src/rules/cds_parser_error.js"), exports);
 __exportStar(__webpack_require__(/*! ./chain_mainly_declarations */ "./node_modules/@abaplint/core/build/src/rules/chain_mainly_declarations.js"), exports);
 __exportStar(__webpack_require__(/*! ./change_if_to_case */ "./node_modules/@abaplint/core/build/src/rules/change_if_to_case.js"), exports);
-__exportStar(__webpack_require__(/*! ./unused_macros */ "./node_modules/@abaplint/core/build/src/rules/unused_macros.js"), exports);
 __exportStar(__webpack_require__(/*! ./check_abstract */ "./node_modules/@abaplint/core/build/src/rules/check_abstract.js"), exports);
 __exportStar(__webpack_require__(/*! ./check_comments */ "./node_modules/@abaplint/core/build/src/rules/check_comments.js"), exports);
 __exportStar(__webpack_require__(/*! ./check_ddic */ "./node_modules/@abaplint/core/build/src/rules/check_ddic.js"), exports);
@@ -62549,6 +62577,7 @@ __exportStar(__webpack_require__(/*! ./line_only_punc */ "./node_modules/@abapli
 __exportStar(__webpack_require__(/*! ./local_class_naming */ "./node_modules/@abaplint/core/build/src/rules/local_class_naming.js"), exports);
 __exportStar(__webpack_require__(/*! ./local_testclass_consistency */ "./node_modules/@abaplint/core/build/src/rules/local_testclass_consistency.js"), exports);
 __exportStar(__webpack_require__(/*! ./local_variable_names */ "./node_modules/@abaplint/core/build/src/rules/local_variable_names.js"), exports);
+__exportStar(__webpack_require__(/*! ./macro_naming */ "./node_modules/@abaplint/core/build/src/rules/macro_naming.js"), exports);
 __exportStar(__webpack_require__(/*! ./main_file_contents */ "./node_modules/@abaplint/core/build/src/rules/main_file_contents.js"), exports);
 __exportStar(__webpack_require__(/*! ./many_parentheses */ "./node_modules/@abaplint/core/build/src/rules/many_parentheses.js"), exports);
 __exportStar(__webpack_require__(/*! ./max_one_method_parameter_per_line */ "./node_modules/@abaplint/core/build/src/rules/max_one_method_parameter_per_line.js"), exports);
@@ -62626,6 +62655,7 @@ __exportStar(__webpack_require__(/*! ./unnecessary_return */ "./node_modules/@ab
 __exportStar(__webpack_require__(/*! ./unreachable_code */ "./node_modules/@abaplint/core/build/src/rules/unreachable_code.js"), exports);
 __exportStar(__webpack_require__(/*! ./unsecure_fae */ "./node_modules/@abaplint/core/build/src/rules/unsecure_fae.js"), exports);
 __exportStar(__webpack_require__(/*! ./unused_ddic */ "./node_modules/@abaplint/core/build/src/rules/unused_ddic.js"), exports);
+__exportStar(__webpack_require__(/*! ./unused_macros */ "./node_modules/@abaplint/core/build/src/rules/unused_macros.js"), exports);
 __exportStar(__webpack_require__(/*! ./unused_methods */ "./node_modules/@abaplint/core/build/src/rules/unused_methods.js"), exports);
 __exportStar(__webpack_require__(/*! ./unused_types */ "./node_modules/@abaplint/core/build/src/rules/unused_types.js"), exports);
 __exportStar(__webpack_require__(/*! ./unused_variables */ "./node_modules/@abaplint/core/build/src/rules/unused_variables.js"), exports);
@@ -63962,6 +63992,83 @@ exports.LocalVariableNames = LocalVariableNames;
 
 /***/ }),
 
+/***/ "./node_modules/@abaplint/core/build/src/rules/macro_naming.js":
+/*!*********************************************************************!*\
+  !*** ./node_modules/@abaplint/core/build/src/rules/macro_naming.js ***!
+  \*********************************************************************/
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.MacroNaming = exports.MacroNamingConf = void 0;
+const issue_1 = __webpack_require__(/*! ../issue */ "./node_modules/@abaplint/core/build/src/issue.js");
+const _abap_rule_1 = __webpack_require__(/*! ./_abap_rule */ "./node_modules/@abaplint/core/build/src/rules/_abap_rule.js");
+const Statements = __webpack_require__(/*! ../abap/2_statements/statements */ "./node_modules/@abaplint/core/build/src/abap/2_statements/statements/index.js");
+const Expressions = __webpack_require__(/*! ../abap/2_statements/expressions */ "./node_modules/@abaplint/core/build/src/abap/2_statements/expressions/index.js");
+const _basic_rule_config_1 = __webpack_require__(/*! ./_basic_rule_config */ "./node_modules/@abaplint/core/build/src/rules/_basic_rule_config.js");
+const _irule_1 = __webpack_require__(/*! ./_irule */ "./node_modules/@abaplint/core/build/src/rules/_irule.js");
+const objects_1 = __webpack_require__(/*! ../objects */ "./node_modules/@abaplint/core/build/src/objects/index.js");
+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
+
+/***/ }),
+
 /***/ "./node_modules/@abaplint/core/build/src/rules/main_file_contents.js":
 /*!***************************************************************************!*\
   !*** ./node_modules/@abaplint/core/build/src/rules/main_file_contents.js ***!
@@ -69111,11 +69218,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
@@ -71222,7 +71327,7 @@ const objects_1 = __webpack_require__(/*! ../objects */ "./node_modules/@abaplin
 class TypesNamingConf extends _basic_rule_config_1.BasicRuleConfig {
     constructor() {
         super(...arguments);
-        /** The pattern for TYPES */
+        /** The pattern for TYPES, case insensitive */
         this.pattern = "^TY_.+$";
     }
 }
@@ -72436,7 +72541,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/cli",
-    "version": "2.109.2",
+    "version": "2.110.0",
     "description": "abaplint - Command Line Interface",
     "funding": "https://github.com/sponsors/larshp",
     "bin": {
@@ -38,7 +38,7 @@
     },
     "homepage": "https://abaplint.org",
     "devDependencies": {
-        "@abaplint/core": "^2.109.2",
+        "@abaplint/core": "^2.110.0",
         "@types/chai": "^4.3.16",
         "@types/glob": "^8.1.0",
         "@types/minimist": "^1.2.5",
@@ -55,7 +55,7 @@
         "mocha": "^10.4.0",
         "progress": "^2.0.3",
         "typescript": "^5.4.5",
-        "webpack": "^5.91.0",
+        "webpack": "^5.92.0",
         "webpack-cli": "^5.1.4",
         "xml-js": "^1.6.11"
     },