@abaplint/core 2.120.74 → 2.120.76

package/build/src/rules/types_naming.js

@@ -53,6 +53,7 @@ class TypesNaming extends _abap_rule_1.ABAPRule {
     constructor() {
         super(...arguments);
         this.conf = new TypesNamingConf();
+        this.regex = new RegExp(this.conf.pattern, "i");
     }
     getMetadata() {
         return {
@@ -70,10 +71,10 @@ class TypesNaming extends _abap_rule_1.ABAPRule {
     }
     setConfig(conf) {
         this.conf = conf;
+        this.regex = new RegExp(this.conf.pattern, "i");
     }
     runParsed(file, obj) {
         const issues = [];
-        const testRegex = new RegExp(this.conf.pattern, "i");
         let nesting = 0;
         if (obj instanceof objects_1.TypePool) {
             return [];
@@ -102,7 +103,7 @@ class TypesNaming extends _abap_rule_1.ABAPRule {
                 continue;
             }
             const token = expr.getFirstToken();
-            if (testRegex.exec(token.getStr())) {
+            if (this.regex.exec(token.getStr())) {
                 continue;
             }
             else {

package/build/src/rules/use_message_class.js

@@ -40,7 +40,16 @@ const Expressions = __importStar(require("../abap/2_statements/expressions"));
 const Statements = __importStar(require("../abap/2_statements/statements"));
 const _basic_rule_config_1 = require("./_basic_rule_config");
 const _irule_1 = require("./_irule");
+const syntax_1 = require("../abap/5_syntax/syntax");
+const _typed_identifier_1 = require("../abap/types/_typed_identifier");
+const basic_1 = require("../abap/types/basic");
+const tokens_1 = require("../abap/1_lexer/tokens");
 class UseMessageClassConf extends _basic_rule_config_1.BasicRuleConfig {
+    constructor() {
+        super(...arguments);
+        /** Allow MESSAGE with an object reference, eg. an exception, like MESSAGE lx_error TYPE 'E' */
+        this.allowExceptions = true;
+    }
 }
 exports.UseMessageClassConf = UseMessageClassConf;
 class UseMessageClass extends _abap_rule_1.ABAPRule {
@@ -53,6 +62,9 @@ class UseMessageClass extends _abap_rule_1.ABAPRule {
             key: "use_message_class",
             title: "Use message class",
             shortDescription: `Define messages in SE91 instead of using inline text or variables`,
+            extendedInformation: `If allowExceptions is enabled, MESSAGE with an object reference is allowed, eg. MESSAGE lx_error TYPE 'E'.
+
+Void types are only allowed if the type name contains "CX_", as void class references cannot be distinguished from other void types.`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
             badExample: `MESSAGE 'Something went wrong' TYPE 'E'.`,
             goodExample: `MESSAGE e001(bc_msg).`,
@@ -64,13 +76,14 @@ class UseMessageClass extends _abap_rule_1.ABAPRule {
     setConfig(conf) {
         this.conf = conf;
     }
-    runParsed(file, _obj) {
+    runParsed(file, obj) {
         const structure = file.getStructure();
         if (structure === undefined) {
             return [];
         }
         const issues = [];
         const key = this.getMetadata().key;
+        let syntax = undefined;
         for (const statement of structure.findAllStatements(Statements.Message)) {
             // The parser populates MessageSource only for the class-based forms (e001(bc_msg) or ID/TYPE/NUMBER).
             // The text form (MESSAGE <source> TYPE <source>) uses MessageSourceSource directly with no MessageSource child.
@@ -78,10 +91,60 @@ class UseMessageClass extends _abap_rule_1.ABAPRule {
             if (statement.findDirectExpression(Expressions.MessageSource) !== undefined) {
                 continue;
             }
+            if (this.conf.allowExceptions === true) {
+                syntax !== null && syntax !== void 0 ? syntax : (syntax = new syntax_1.SyntaxLogic(this.reg, obj).run());
+                if (this.isObjectReference(statement, file, syntax)) {
+                    continue;
+                }
+            }
             issues.push(issue_1.Issue.atStatement(file, statement, "Use a message class (SE91) instead of inline text or variable", key, this.conf.severity));
         }
         return issues;
     }
+    isObjectReference(statement, file, syntax) {
+        var _a, _b;
+        const chain = (_b = (_a = statement.findDirectExpression(Expressions.MessageSourceSource)) === null || _a === void 0 ? void 0 : _a.findDirectExpression(Expressions.Source)) === null || _b === void 0 ? void 0 : _b.findDirectExpression(Expressions.FieldChain);
+        if (chain === undefined) {
+            return false;
+        }
+        let type = undefined;
+        for (const child of chain.getChildren()) {
+            const c = child.get();
+            if (c instanceof Expressions.ComponentName) {
+                type = type instanceof basic_1.StructureType ? type.getComponentByName(child.concatTokens()) : undefined;
+            }
+            else if (c instanceof Expressions.SourceField
+                || c instanceof Expressions.SourceFieldSymbol
+                || c instanceof Expressions.AttributeName) {
+                type = this.findType(child.getFirstToken().getStart(), file, syntax);
+            }
+            else if (c instanceof Expressions.ClassName
+                || c instanceof tokens_1.InstanceArrow
+                || c instanceof tokens_1.StaticArrow
+                || c instanceof tokens_1.Dash) {
+                continue;
+            }
+            else {
+                return false;
+            }
+            if (type === undefined) {
+                return false;
+            }
+        }
+        // void class references cannot be distinguished from other void types, guess based on the name
+        return type instanceof basic_1.ObjectReferenceType
+            || type instanceof basic_1.GenericObjectReferenceType
+            || (type instanceof basic_1.VoidType && /CX_/i.test(type.getVoided() || ""));
+    }
+    findType(start, file, syntax) {
+        const scope = syntax.spaghetti.lookupPosition(start, file.getFilename());
+        for (const r of (scope === null || scope === void 0 ? void 0 : scope.getData().references) || []) {
+            if (r.position.getStart().equals(start) && r.resolved instanceof _typed_identifier_1.TypedIdentifier) {
+                return r.resolved.getType();
+            }
+        }
+        return undefined;
+    }
 }
 exports.UseMessageClass = UseMessageClass;
 //# sourceMappingURL=use_message_class.js.map

package/build/src/rules/wrong_abapdoc_position.js

@@ -40,6 +40,8 @@ const _abap_rule_1 = require("./_abap_rule");
 const _basic_rule_config_1 = require("./_basic_rule_config");
 const _irule_1 = require("./_irule");
 const _statement_1 = require("../abap/2_statements/statements/_statement");
+const edit_helper_1 = require("../edit_helper");
+const position_1 = require("../position");
 class WrongAbapdocPositionConf extends _basic_rule_config_1.BasicRuleConfig {
 }
 exports.WrongAbapdocPositionConf = WrongAbapdocPositionConf;
@@ -59,10 +61,13 @@ elsewhere is silently ignored, leaving the declaration undocumented.
 The following positions are reported,
 * in front of a chained keyword, ie. before "CONSTANTS:" instead of after the colon,
 * in the middle of a statement, ie. between the parameters of a METHODS definition,
-* directly in front of ENDCLASS, ENDINTERFACE or a SECTION statement.
+* directly in front of ENDCLASS, ENDINTERFACE or a SECTION statement,
+* separated from its declaration by a blank line or a normal comment, the system reads both as the end of the block.
 
-Only checks ABAP Doc inside class definitions and interfaces.`,
-            tags: [_irule_1.RuleTag.SingleFile],
+Only checks ABAP Doc inside class definitions and interfaces, and directly in front of them.
+
+The quick fix for a blank line deletes the blank lines.`,
+            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
             badExample: `CLASS zcl_foo DEFINITION PUBLIC.
   PUBLIC SECTION.
     "! Navigation modes
@@ -88,6 +93,7 @@ ENDCLASS.`,
         this.conf = conf;
     }
     runParsed(file) {
+        var _a;
         const issues = [];
         const statements = file.getStatements();
         let definition = false;
@@ -102,7 +108,7 @@ ENDCLASS.`,
                 definition = false;
                 continue;
             }
-            else if (definition === false || this.isAbapdoc(statement) === false) {
+            else if (this.isAbapdoc(statement) === false) {
                 continue;
             }
             else if (this.isAbapdoc(statements[i - 1]) === true
@@ -110,19 +116,57 @@ ENDCLASS.`,
                 continue; // only report the first row of each block
             }
             let next = undefined;
-            for (let j = i + 1; j < statements.length; j++) {
-                if (statements[j].get() instanceof _statement_1.Comment) {
-                    continue;
+            let j = i + 1;
+            for (; j < statements.length; j++) {
+                if (!(statements[j].get() instanceof _statement_1.Comment)) {
+                    next = statements[j];
+                    break;
                 }
-                next = statements[j];
-                break;
             }
             if (next === undefined) {
                 continue;
             }
-            const message = this.check(statement, next);
+            else if (definition === false
+                && !(next.get() instanceof Statements.ClassDefinition)
+                && !(next.get() instanceof Statements.Interface)) {
+                continue;
+            }
+            // comments inside "next" are listed in front of it, only look at the rows above it
+            const nextRow = this.startRow(next);
+            const trailing = ((_a = statements[i - 1]) === null || _a === void 0 ? void 0 : _a.getEnd().getRow()) === statement.getStart().getRow();
+            let last = statement;
+            let separator = undefined;
+            let fix = undefined;
+            for (const s of trailing ? [] : statements.slice(i + 1, j)) {
+                if (s.getStart().getRow() >= nextRow) {
+                    break;
+                }
+                else if (s.getStart().getRow() > last.getEnd().getRow() + 1) {
+                    separator = "a blank line";
+                    if (this.isAbapdoc(s) === true) {
+                        fix = edit_helper_1.EditHelper.deleteRange(file, new position_1.Position(last.getEnd().getRow() + 1, 1), new position_1.Position(s.getStart().getRow(), 1));
+                    }
+                    break;
+                }
+                else if (this.isAbapdoc(s) === false) {
+                    separator = "a comment";
+                    break;
+                }
+                last = s;
+            }
+            if (separator === undefined && trailing === false && nextRow > last.getEnd().getRow() + 1) {
+                separator = "a blank line";
+                fix = edit_helper_1.EditHelper.deleteRange(file, new position_1.Position(last.getEnd().getRow() + 1, 1), new position_1.Position(nextRow, 1));
+            }
+            let message = this.check(statement, next);
+            if (message !== undefined) {
+                fix = undefined;
+            }
+            else if (separator !== undefined) {
+                message = "ABAP Doc is separated from its declaration by " + separator;
+            }
             if (message !== undefined) {
-                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
+                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity, fix));
             }
         }
         return issues;
@@ -131,6 +175,9 @@ ENDCLASS.`,
         return (statement === null || statement === void 0 ? void 0 : statement.get()) instanceof _statement_1.Comment
             && statement.getFirstToken().getStr().startsWith(`"!`);
     }
+    startRow(statement) {
+        return Math.min(statement.getStart().getRow(), ...statement.getPragmas().map(p => p.getRow()));
+    }
     check(abapdoc, next) {
         const type = next.get();
         if (type instanceof Statements.EndClass

package/build/src/rules/xml_consistency.js

@@ -41,6 +41,10 @@ const _abap_object_1 = require("../objects/_abap_object");
 const _basic_rule_config_1 = require("./_basic_rule_config");
 const fast_xml_parser_1 = require("fast-xml-parser");
 const severity_1 = require("../severity");
+const ABAPGIT_ATTRIBUTES = [
+    ["version", /<abapGit\b[^>]*\bversion="([^"]+)"/],
+    ["serializer_version", /<abapGit\b[^>]*\bserializer_version="([^"]+)"/],
+];
 class XMLConsistencyConf extends _basic_rule_config_1.BasicRuleConfig {
     constructor() {
         super(...arguments);
@@ -96,8 +100,8 @@ class XMLConsistency {
                 issues.push(issue_1.Issue.atRow(file, 1, "XML parser error: " + res.err.msg, this.getMetadata().key, this.conf.severity));
             }
             else {
-                for (const attribute of ["version", "serializer_version"]) {
-                    const value = (_a = xml.match(new RegExp(`<abapGit\\b[^>]*\\b${attribute}="([^"]+)"`))) === null || _a === void 0 ? void 0 : _a[1];
+                for (const [attribute, regex] of ABAPGIT_ATTRIBUTES) {
+                    const value = (_a = xml.match(regex)) === null || _a === void 0 ? void 0 : _a[1];
                     if (value !== undefined && value.match(/^v\d\.\d\.\d$/) === null) {
                         issues.push(issue_1.Issue.atRow(file, 1, `Unexpected abapGit ${attribute} "${value}"`, this.getMetadata().key, this.conf.severity));
                     }

package/build/src/utils/name_validator.js

@@ -2,12 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NameValidator = void 0;
 class NameValidator {
-    static violatesRule(name, pattern, params) {
+    /** compile the configured ignorePatterns, case insensitive */
+    static compileIgnorePatterns(params) {
+        return (params.ignorePatterns || []).map(ignored => new RegExp(ignored, "i"));
+    }
+    static violatesRule(name, pattern, params, ignorePatterns) {
         if (params.ignoreNames && params.ignoreNames.indexOf(name.toUpperCase()) >= 0) {
             return false;
         }
-        for (const ignored of params.ignorePatterns || []) {
-            if (new RegExp(ignored, "i").test(name)) {
+        for (const ignored of ignorePatterns) {
+            if (ignored.test(name)) {
                 return false;
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/core",
-    "version": "2.120.74",
+    "version": "2.120.76",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",