@abaplint/core 2.99.11 → 2.100.0

package/build/abaplint.d.ts

@@ -1300,6 +1300,7 @@ export declare class CurrentScope {
     findVariable(name: string | undefined): TypedIdentifier | undefined;
     getDDIC(): DDIC;
     getDDICReferences(): IDDICReferences;
+    getMSAGReferences(): IMSAGReferences;
     getParentObj(): IObject;
     getName(): string;
     getType(): ScopeType;
@@ -3078,6 +3079,20 @@ declare class ImportNametab implements IStatement {
     getMatcher(): IStatementRunnable;
 }
 
+declare interface IMSAGReferences {
+    clear(obj: IObject): void;
+    addUsing(filename: string, token: Token, messageClass: string, number: string): void;
+    listByFilename(filename: string): {
+        token: Token;
+        messageClass: string;
+        number: string;
+    }[];
+    listByMessage(messageClass: string, number: string): {
+        filename: string;
+        token: Token;
+    }[];
+}
+
 declare class InboundService extends AbstractObject {
     getType(): string;
     getAllowedNaming(): {
@@ -3424,6 +3439,7 @@ export declare interface IRegistry {
     findIssuesObject(iobj: IObject): readonly Issue[];
     inErrorNamespace(name: string): boolean;
     getDDICReferences(): IDDICReferences;
+    getMSAGReferences(): IMSAGReferences;
     getConfig(): IConfiguration;
     setConfig(conf: IConfiguration): IRegistry;
     /** Get all objects, including dependencies */
@@ -3842,9 +3858,9 @@ export declare class MemoryFile extends AbstractFile {
 }
 
 declare class Message {
-    private readonly num;
-    private readonly msg;
-    constructor(num: string, msg: string);
+    private readonly number;
+    private readonly message;
+    constructor(number: string, message: string);
     getNumber(): string;
     getMessage(): string;
     getPlaceholderCount(): number;
@@ -4721,11 +4737,13 @@ export declare class Registry implements IRegistry {
     private readonly objects;
     private readonly objectsByType;
     private readonly dependencies;
-    private readonly references;
+    private readonly ddicReferences;
+    private readonly msagReferences;
     private conf;
     constructor(conf?: IConfiguration);
     static abaplintVersion(): string;
     getDDICReferences(): IDDICReferences;
+    getMSAGReferences(): IMSAGReferences;
     getObjects(): Generator<IObject, void, undefined>;
     getObjectsByType(type: string): Generator<IObject, void, undefined>;
     getFiles(): Generator<IFile, void, undefined>;

package/build/src/_imsag_references.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=_imsag_references.js.map

package/build/src/abap/5_syntax/_current_scope.js

@@ -324,6 +324,9 @@ class CurrentScope {
     getDDICReferences() {
         return this.reg.getDDICReferences();
     }
+    getMSAGReferences() {
+        return this.reg.getMSAGReferences();
+    }
     getParentObj() {
         return this.parentObj;
     }

package/build/src/abap/5_syntax/expressions/message_source.js

@@ -5,9 +5,26 @@ const Expressions = require("../../2_statements/expressions");
 const source_1 = require("./source");
 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;

package/build/src/abap/5_syntax/syntax.js

@@ -285,6 +285,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)) };

package/build/src/abap/types/message.js

@@ -2,21 +2,21 @@
 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;

package/build/src/ddic_references.js

@@ -48,10 +48,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) {

package/build/src/msag_references.js

@@ -0,0 +1,49 @@
+"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

package/build/src/objects/message_class.js

@@ -32,6 +32,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;

package/build/src/registry.js

@@ -7,6 +7,7 @@ const find_global_definitions_1 = require("./abap/5_syntax/global_definitions/fi
 const excludeHelper_1 = require("./utils/excludeHelper");
 const ddic_references_1 = require("./ddic_references");
 const rules_runner_1 = require("./rules_runner");
+const msag_references_1 = require("./msag_references");
 // todo, this should really be an instance in case there are multiple Registry'ies
 class ParsingPerformance {
     static clear() {
@@ -59,14 +60,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) {
@@ -154,7 +159,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;

package/build/src/rules/easy_to_find_messages.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EasyToFindMessages = exports.EasyToFindMessagesConf = void 0;
+const issue_1 = require("../issue");
+const _irule_1 = require("./_irule");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const position_1 = require("../position");
+const syntax_1 = require("../abap/5_syntax/syntax");
+const _abap_object_1 = require("../objects/_abap_object");
+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

package/build/src/rules/index.js

@@ -53,6 +53,7 @@ __exportStar(require("./definitions_top"), exports);
 __exportStar(require("./description_empty"), exports);
 __exportStar(require("./double_space"), exports);
 __exportStar(require("./downport"), exports);
+__exportStar(require("./easy_to_find_messages"), exports);
 __exportStar(require("./empty_line_in_statement"), exports);
 __exportStar(require("./empty_statement"), exports);
 __exportStar(require("./empty_structure"), exports);

package/build/src/rules/msag_consistency.js

@@ -17,6 +17,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,9 +1,10 @@
 {
     "name": "@abaplint/core",
-    "version": "2.99.11",
+    "version": "2.100.0",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",
+    "funding": "https://github.com/sponsors/larshp",
     "scripts": {
         "lint": "eslint src/**/*.ts test/**/*.ts --format unix",
         "lint:fix": "eslint src/**/*.ts test/**/*.ts --format unix --fix",
@@ -47,10 +48,10 @@
     },
     "homepage": "https://abaplint.org",
     "devDependencies": {
-        "@microsoft/api-extractor": "^7.34.8",
+        "@microsoft/api-extractor": "^7.34.9",
         "@types/chai": "^4.3.5",
         "@types/mocha": "^10.0.1",
-        "@types/node": "^20.1.2",
+        "@types/node": "^20.1.3",
         "chai": "^4.3.7",
         "eslint": "^8.40.0",
         "mocha": "^10.2.0",