@abaplint/cli 2.99.11 → 2.100.0

package/build/cli.js

@@ -20687,6 +20687,9 @@ class CurrentScope {
     getDDICReferences() {
         return this.reg.getDDICReferences();
     }
+    getMSAGReferences() {
+        return this.reg.getMSAGReferences();
+    }
     getParentObj() {
         return this.parentObj;
     }
@@ -24242,9 +24245,26 @@ const Expressions = __webpack_require__(/*! ../../2_statements/expressions */ ".
 const source_1 = __webpack_require__(/*! ./source */ "./node_modules/@abaplint/core/build/src/abap/5_syntax/expressions/source.js");
 class MessageSource {
     runSyntax(node, scope, filename) {
+        var _a, _b, _c, _d;
         for (const f of node.findDirectExpressions(Expressions.Source)) {
             new source_1.Source().runSyntax(f, scope, filename);
         }
+        if (node.getFirstToken().getStr().toUpperCase() === "ID") {
+            const id = (_a = node.findExpressionAfterToken("ID")) === null || _a === void 0 ? void 0 : _a.concatTokens();
+            const number = (_b = node.findDirectExpression(Expressions.MessageNumber)) === null || _b === void 0 ? void 0 : _b.concatTokens();
+            if ((id === null || id === void 0 ? void 0 : id.startsWith("'")) && number) {
+                const messageClass = id.substring(1, id.length - 1).toUpperCase();
+                scope.getMSAGReferences().addUsing(filename, node.getFirstToken(), messageClass, number);
+            }
+        }
+        else {
+            const typeAndNumber = (_c = node.findDirectExpression(Expressions.MessageTypeAndNumber)) === null || _c === void 0 ? void 0 : _c.concatTokens();
+            const messageNumber = typeAndNumber === null || typeAndNumber === void 0 ? void 0 : typeAndNumber.substring(1);
+            const messageClass = (_d = node.findDirectExpression(Expressions.MessageClass)) === null || _d === void 0 ? void 0 : _d.concatTokens().toUpperCase();
+            if (messageNumber && messageClass) {
+                scope.getMSAGReferences().addUsing(filename, node.getFirstToken(), messageClass, messageNumber);
+            }
+        }
     }
 }
 exports.MessageSource = MessageSource;
@@ -31953,6 +31973,7 @@ class SyntaxLogic {
         }
         this.issues = [];
         this.reg.getDDICReferences().clear(this.object);
+        this.reg.getMSAGReferences().clear(this.object);
         if (this.object instanceof objects_1.Program && this.object.isInclude()) {
             // todo, show some kind of error?
             return { issues: [], spaghetti: this.scope.pop(new position_1.Position(Number.MAX_SAFE_INTEGER, Number.MAX_SAFE_INTEGER)) };
@@ -35987,21 +36008,21 @@ exports.InterfaceDefinition = InterfaceDefinition;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.Message = void 0;
 class Message {
-    constructor(num, msg) {
-        this.num = num;
-        if (this.num === undefined) {
-            this.num = "";
+    constructor(number, message) {
+        this.number = number;
+        if (this.number === undefined) {
+            this.number = "";
         }
-        this.msg = msg;
-        if (this.msg === undefined) {
-            this.msg = "";
+        this.message = message;
+        if (this.message === undefined) {
+            this.message = "";
         }
     }
     getNumber() {
-        return this.num;
+        return this.number;
     }
     getMessage() {
-        return this.msg;
+        return this.message;
     }
     getPlaceholderCount() {
         return (this.getMessage().match(/&/g) || []).length;
@@ -38316,10 +38337,11 @@ class DDICReferences {
                 }
             }
         }
-        const newName = obj.getName().toUpperCase();
-        const newType = obj.getType();
-        if ((_b = this.nameTypeIndex[newName]) === null || _b === void 0 ? void 0 : _b[newType]) {
-            this.nameTypeIndex[newName][newType] = [];
+        // remove from name + type index
+        const name = obj.getName().toUpperCase();
+        const type = obj.getType();
+        if ((_b = this.nameTypeIndex[name]) === null || _b === void 0 ? void 0 : _b[type]) {
+            this.nameTypeIndex[name][type] = [];
         }
     }
     listByFilename(filename, line) {
@@ -41084,6 +41106,65 @@ exports.Symbols = Symbols;
 
 /***/ }),
 
+/***/ "./node_modules/@abaplint/core/build/src/msag_references.js":
+/*!******************************************************************!*\
+  !*** ./node_modules/@abaplint/core/build/src/msag_references.js ***!
+  \******************************************************************/
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.MSAGReferences = void 0;
+class MSAGReferences {
+    constructor() {
+        this.nameNumberIndex = {};
+        this.filenameIndex = {};
+    }
+    addUsing(filename, token, messageClass, number) {
+        if (this.filenameIndex[filename] === undefined) {
+            this.filenameIndex[filename] = [];
+        }
+        this.filenameIndex[filename].push({
+            token: token,
+            messageClass: messageClass,
+            number: number,
+        });
+        if (this.nameNumberIndex[messageClass] === undefined) {
+            this.nameNumberIndex[messageClass] = {};
+        }
+        if (this.nameNumberIndex[messageClass][number] === undefined) {
+            this.nameNumberIndex[messageClass][number] = [];
+        }
+        this.nameNumberIndex[messageClass][number].push({
+            filename: filename,
+            token: token,
+        });
+    }
+    clear(obj) {
+        for (const file of obj.getFiles()) {
+            const filename = file.getFilename();
+            for (const fIndex of this.filenameIndex[filename] || []) {
+                // this should be okay for performance, each message should be referenced less than 10 times typically
+                this.nameNumberIndex[fIndex.messageClass][fIndex.number] =
+                    this.nameNumberIndex[fIndex.messageClass][fIndex.number].filter(i => i.filename !== filename);
+            }
+            delete this.filenameIndex[filename];
+        }
+    }
+    listByFilename(filename) {
+        return this.filenameIndex[filename] || [];
+    }
+    listByMessage(messageClass, number) {
+        var _a;
+        return ((_a = this.nameNumberIndex[messageClass]) === null || _a === void 0 ? void 0 : _a[number]) || [];
+    }
+}
+exports.MSAGReferences = MSAGReferences;
+//# sourceMappingURL=msag_references.js.map
+
+/***/ }),
+
 /***/ "./node_modules/@abaplint/core/build/src/objects/_abap_object.js":
 /*!***********************************************************************!*\
   !*** ./node_modules/@abaplint/core/build/src/objects/_abap_object.js ***!
@@ -44597,6 +44678,7 @@ class MessageClass extends _abstract_object_1.AbstractObject {
         return msg ? msg : [];
     }
     getByNumber(num) {
+        // todo, optimize performance,
         for (const message of this.getMessages()) {
             if (message.getNumber() === num) {
                 return message;
@@ -47558,6 +47640,7 @@ const find_global_definitions_1 = __webpack_require__(/*! ./abap/5_syntax/global
 const excludeHelper_1 = __webpack_require__(/*! ./utils/excludeHelper */ "./node_modules/@abaplint/core/build/src/utils/excludeHelper.js");
 const ddic_references_1 = __webpack_require__(/*! ./ddic_references */ "./node_modules/@abaplint/core/build/src/ddic_references.js");
 const rules_runner_1 = __webpack_require__(/*! ./rules_runner */ "./node_modules/@abaplint/core/build/src/rules_runner.js");
+const msag_references_1 = __webpack_require__(/*! ./msag_references */ "./node_modules/@abaplint/core/build/src/msag_references.js");
 // todo, this should really be an instance in case there are multiple Registry'ies
 class ParsingPerformance {
     static clear() {
@@ -47610,14 +47693,18 @@ class Registry {
         this.objectsByType = {};
         this.dependencies = {};
         this.conf = conf ? conf : config_1.Config.getDefault();
-        this.references = new ddic_references_1.DDICReferences();
+        this.ddicReferences = new ddic_references_1.DDICReferences();
+        this.msagReferences = new msag_references_1.MSAGReferences();
     }
     static abaplintVersion() {
         // magic, see build script "version.sh"
-        return "2.99.11";
+        return "2.100.0";
     }
     getDDICReferences() {
-        return this.references;
+        return this.ddicReferences;
+    }
+    getMSAGReferences() {
+        return this.msagReferences;
     }
     *getObjects() {
         for (const name in this.objects) {
@@ -47705,7 +47792,8 @@ class Registry {
         const obj = this.find(file.getObjectName(), file.getObjectType());
         obj.removeFile(file);
         if (obj.getFiles().length === 0) {
-            this.references.clear(obj);
+            this.ddicReferences.clear(obj);
+            this.msagReferences.clear(obj);
             this.removeObject(obj);
         }
         return this;
@@ -54911,6 +54999,88 @@ exports.Downport = Downport;
 
 /***/ }),
 
+/***/ "./node_modules/@abaplint/core/build/src/rules/easy_to_find_messages.js":
+/*!******************************************************************************!*\
+  !*** ./node_modules/@abaplint/core/build/src/rules/easy_to_find_messages.js ***!
+  \******************************************************************************/
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.EasyToFindMessages = exports.EasyToFindMessagesConf = void 0;
+const issue_1 = __webpack_require__(/*! ../issue */ "./node_modules/@abaplint/core/build/src/issue.js");
+const _irule_1 = __webpack_require__(/*! ./_irule */ "./node_modules/@abaplint/core/build/src/rules/_irule.js");
+const _basic_rule_config_1 = __webpack_require__(/*! ./_basic_rule_config */ "./node_modules/@abaplint/core/build/src/rules/_basic_rule_config.js");
+const position_1 = __webpack_require__(/*! ../position */ "./node_modules/@abaplint/core/build/src/position.js");
+const syntax_1 = __webpack_require__(/*! ../abap/5_syntax/syntax */ "./node_modules/@abaplint/core/build/src/abap/5_syntax/syntax.js");
+const _abap_object_1 = __webpack_require__(/*! ../objects/_abap_object */ "./node_modules/@abaplint/core/build/src/objects/_abap_object.js");
+class EasyToFindMessagesConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.EasyToFindMessagesConf = EasyToFindMessagesConf;
+class EasyToFindMessages {
+    constructor() {
+        this.conf = new EasyToFindMessagesConf();
+    }
+    getMetadata() {
+        return {
+            key: "easy_to_find_messages",
+            title: "Easy to find messages",
+            shortDescription: `Make messages easy to find`,
+            extendedInformation: `All messages must be statically referenced exactly once
+
+Only MESSAGE and RAISE statments are counted as static references
+
+Also see rule "message_exists"
+
+https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#make-messages-easy-to-find`,
+            tags: [_irule_1.RuleTag.Styleguide],
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    initialize(reg) {
+        this.msagReferences = reg.getMSAGReferences();
+        // the SyntaxLogic builds the references
+        for (const obj of reg.getObjects()) {
+            if (obj instanceof _abap_object_1.ABAPObject) {
+                new syntax_1.SyntaxLogic(reg, obj).run();
+            }
+        }
+        return this;
+    }
+    run(object) {
+        const issues = [];
+        if (object.getType() === "MSAG") {
+            const msag = object;
+            for (const message of msag.getMessages()) {
+                const where = this.msagReferences.listByMessage(msag.getName().toUpperCase(), message.getNumber());
+                if (where.length === 0) {
+                    const text = `Message ${message.getNumber()} not statically referenced`;
+                    const position = new position_1.Position(1, 1);
+                    const issue = issue_1.Issue.atPosition(object.getFiles()[0], position, text, this.getMetadata().key, this.conf.severity);
+                    issues.push(issue);
+                }
+                else if (where.length >= 2) {
+                    const text = `Message ${message.getNumber()} referenced more than once`;
+                    const position = new position_1.Position(1, 1);
+                    const issue = issue_1.Issue.atPosition(object.getFiles()[0], position, text, this.getMetadata().key, this.conf.severity);
+                    issues.push(issue);
+                }
+            }
+        }
+        return issues;
+    }
+}
+exports.EasyToFindMessages = EasyToFindMessages;
+//# sourceMappingURL=easy_to_find_messages.js.map
+
+/***/ }),
+
 /***/ "./node_modules/@abaplint/core/build/src/rules/empty_line_in_statement.js":
 /*!********************************************************************************!*\
   !*** ./node_modules/@abaplint/core/build/src/rules/empty_line_in_statement.js ***!
@@ -57519,6 +57689,7 @@ __exportStar(__webpack_require__(/*! ./definitions_top */ "./node_modules/@abapl
 __exportStar(__webpack_require__(/*! ./description_empty */ "./node_modules/@abaplint/core/build/src/rules/description_empty.js"), exports);
 __exportStar(__webpack_require__(/*! ./double_space */ "./node_modules/@abaplint/core/build/src/rules/double_space.js"), exports);
 __exportStar(__webpack_require__(/*! ./downport */ "./node_modules/@abaplint/core/build/src/rules/downport.js"), exports);
+__exportStar(__webpack_require__(/*! ./easy_to_find_messages */ "./node_modules/@abaplint/core/build/src/rules/easy_to_find_messages.js"), exports);
 __exportStar(__webpack_require__(/*! ./empty_line_in_statement */ "./node_modules/@abaplint/core/build/src/rules/empty_line_in_statement.js"), exports);
 __exportStar(__webpack_require__(/*! ./empty_statement */ "./node_modules/@abaplint/core/build/src/rules/empty_statement.js"), exports);
 __exportStar(__webpack_require__(/*! ./empty_structure */ "./node_modules/@abaplint/core/build/src/rules/empty_structure.js"), exports);
@@ -59990,6 +60161,7 @@ class MSAGConsistency {
             key: "msag_consistency",
             title: "MSAG consistency check",
             shortDescription: `Checks the validity of messages in message classes`,
+            extendedInformation: `Message numbers must be 3 digits, and message text must not be empty`,
         };
     }
     getDescription(reason) {

package/package.json

@@ -1,7 +1,8 @@
 {
     "name": "@abaplint/cli",
-    "version": "2.99.11",
+    "version": "2.100.0",
     "description": "abaplint - Command Line Interface",
+    "funding": "https://github.com/sponsors/larshp",
     "bin": {
         "abaplint": "./abaplint"
     },
@@ -37,12 +38,12 @@
     },
     "homepage": "https://abaplint.org",
     "devDependencies": {
-        "@abaplint/core": "^2.99.11",
+        "@abaplint/core": "^2.100.0",
         "@types/chai": "^4.3.5",
         "@types/glob": "^7.2.0",
         "@types/minimist": "^1.2.2",
         "@types/mocha": "^10.0.1",
-        "@types/node": "^20.1.2",
+        "@types/node": "^20.1.3",
         "@types/progress": "^2.0.5",
         "chai": "^4.3.7",
         "chalk": "^5.2.0",