@abaplint/core 2.117.3 → 2.118.0

package/build/src/abap/2_statements/expressions/sql_into_list.js

@@ -8,7 +8,7 @@ const wparen_left_1 = require("../../1_lexer/tokens/wparen_left");
 const version_1 = require("../../../version");
 class SQLIntoList extends combi_1.Expression {
     getRunnable() {
-        const intoList = (0, combi_1.seq)((0, combi_1.altPrio)((0, combi_1.tok)(wparen_left_1.WParenLeft), (0, combi_1.ver)(version_1.Version.v740sp02, (0, combi_1.tok)(wparen_leftw_1.WParenLeftW))), (0, combi_1.starPrio)((0, combi_1.seq)(_1.SQLTarget, ",")), _1.SQLTarget, ")");
+        const intoList = (0, combi_1.seq)((0, combi_1.altPrio)((0, combi_1.tok)(wparen_left_1.WParenLeft), (0, combi_1.ver)(version_1.Version.v740sp02, (0, combi_1.tok)(wparen_leftw_1.WParenLeftW), version_1.Version.OpenABAP)), (0, combi_1.starPrio)((0, combi_1.seq)(_1.SQLTarget, ",")), _1.SQLTarget, ")");
         return (0, combi_1.seq)("INTO", intoList);
     }
 }

package/build/src/registry.js

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

package/build/src/rules/cds_association_name.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CDSAssociationName = exports.CDSAssociationNameConf = void 0;
+const issue_1 = require("../issue");
+const _irule_1 = require("./_irule");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const objects_1 = require("../objects");
+const expressions_1 = require("../cds/expressions");
+class CDSAssociationNameConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.CDSAssociationNameConf = CDSAssociationNameConf;
+class CDSAssociationName {
+    constructor() {
+        this.conf = new CDSAssociationNameConf();
+    }
+    getMetadata() {
+        return {
+            key: "cds_association_name",
+            title: "CDS Association Name",
+            shortDescription: `CDS association names should start with an underscore`,
+            extendedInformation: `By convention, CDS association names must start with an underscore character.
+
+https://help.sap.com/docs/abap-cloud/abap-data-models/cds-associations`,
+            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Naming],
+            badExample: `define view entity test as select from source
+  association [1..1] to target as Assoc on Assoc.id = source.id
+{ key id }`,
+            goodExample: `define view entity test as select from source
+  association [1..1] to target as _Assoc on _Assoc.id = source.id
+{ key id }`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    initialize(_reg) {
+        return this;
+    }
+    run(o) {
+        if (o.getType() !== "DDLS" || !(o instanceof objects_1.DataDefinition)) {
+            return [];
+        }
+        const tree = o.getTree();
+        if (tree === undefined) {
+            return [];
+        }
+        const file = o.findSourceFile();
+        if (file === undefined) {
+            return [];
+        }
+        const issues = [];
+        for (const assoc of tree.findAllExpressions(expressions_1.CDSAssociation)) {
+            const asExpr = assoc.findFirstExpression(expressions_1.CDSAs);
+            if (asExpr === undefined) {
+                continue;
+            }
+            const nameExpr = asExpr.findDirectExpression(expressions_1.CDSName);
+            if (nameExpr === undefined) {
+                continue;
+            }
+            const name = nameExpr.getFirstToken().getStr();
+            if (!name.startsWith("_")) {
+                const token = nameExpr.getFirstToken();
+                const message = `CDS association name "${name}" should start with an underscore`;
+                issues.push(issue_1.Issue.atToken(file, token, message, this.getMetadata().key, this.getConfig().severity));
+            }
+        }
+        return issues;
+    }
+}
+exports.CDSAssociationName = CDSAssociationName;
+//# sourceMappingURL=cds_association_name.js.map

package/build/src/rules/cds_field_order.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CDSFieldOrder = exports.CDSFieldOrderConf = void 0;
+const issue_1 = require("../issue");
+const _irule_1 = require("./_irule");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const objects_1 = require("../objects");
+const expressions_1 = require("../cds/expressions");
+class CDSFieldOrderConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.CDSFieldOrderConf = CDSFieldOrderConf;
+class CDSFieldOrder {
+    constructor() {
+        this.conf = new CDSFieldOrderConf();
+    }
+    getMetadata() {
+        return {
+            key: "cds_field_order",
+            title: "CDS Field Order",
+            shortDescription: `Checks that CDS key fields are listed first and associations last in the field list`,
+            tags: [_irule_1.RuleTag.SingleFile],
+            badExample: `define view entity test as select from source
+  association [1..1] to target as _Assoc on _Assoc.id = source.id
+{
+  field1,
+  key id,
+  _Assoc
+}`,
+            goodExample: `define view entity test as select from source
+  association [1..1] to target as _Assoc on _Assoc.id = source.id
+{
+  key id,
+  field1,
+  _Assoc
+}`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    initialize(_reg) {
+        return this;
+    }
+    run(o) {
+        if (o.getType() !== "DDLS" || !(o instanceof objects_1.DataDefinition)) {
+            return [];
+        }
+        const tree = o.getTree();
+        if (tree === undefined) {
+            return [];
+        }
+        const file = o.findSourceFile();
+        if (file === undefined) {
+            return [];
+        }
+        const issues = [];
+        const associationNames = this.getAssociationNames(tree);
+        for (const select of tree.findAllExpressions(expressions_1.CDSSelect)) {
+            const elements = select.findDirectExpressions(expressions_1.CDSElement);
+            if (elements.length === 0) {
+                continue;
+            }
+            let seenNonKey = false;
+            let seenAssociation = false;
+            for (const element of elements) {
+                const isKey = element.findDirectTokenByText("KEY") !== undefined;
+                const isAssoc = this.isAssociationElement(element, associationNames);
+                if (isKey && seenNonKey) {
+                    const message = "Key fields must be listed before non-key fields";
+                    issues.push(issue_1.Issue.atToken(file, element.getFirstToken(), message, this.getMetadata().key, this.getConfig().severity));
+                }
+                if (!isAssoc && seenAssociation) {
+                    const message = "Associations must be listed last in the field list";
+                    issues.push(issue_1.Issue.atToken(file, element.getFirstToken(), message, this.getMetadata().key, this.getConfig().severity));
+                }
+                if (!isKey) {
+                    seenNonKey = true;
+                }
+                if (isAssoc) {
+                    seenAssociation = true;
+                }
+            }
+        }
+        return issues;
+    }
+    getAssociationNames(tree) {
+        const names = new Set();
+        for (const assoc of tree.findAllExpressions(expressions_1.CDSAssociation)) {
+            const relation = assoc.findDirectExpression(expressions_1.CDSRelation);
+            if (relation === undefined) {
+                continue;
+            }
+            const asNode = relation.findDirectExpression(expressions_1.CDSAs);
+            if (asNode) {
+                const nameNode = asNode.findDirectExpression(expressions_1.CDSName);
+                if (nameNode) {
+                    names.add(nameNode.getFirstToken().getStr().toUpperCase());
+                }
+            }
+            else {
+                const name = relation.getFirstToken().getStr();
+                names.add(name.toUpperCase());
+            }
+        }
+        return names;
+    }
+    isAssociationElement(element, associationNames) {
+        const tokens = element.concatTokens().replace(/^(KEY|VIRTUAL)\s+/i, "").trim();
+        const name = tokens.split(/[\s.,:(]+/)[0];
+        return associationNames.has(name.toUpperCase());
+    }
+}
+exports.CDSFieldOrder = CDSFieldOrder;
+//# sourceMappingURL=cds_field_order.js.map

package/build/src/rules/cds_naming.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CDSNaming = exports.CDSNamingConf = void 0;
+const issue_1 = require("../issue");
+const _irule_1 = require("./_irule");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const objects_1 = require("../objects");
+const expressions_1 = require("../cds/expressions");
+const cds_name_1 = require("../cds/expressions/cds_name");
+class CDSNamingConf extends _basic_rule_config_1.BasicRuleConfig {
+    constructor() {
+        super(...arguments);
+        /** Expected prefix for basic interface views */
+        this.basicInterfaceView = "ZI_";
+        /** Expected prefix for composite interface views */
+        this.compositeInterfaceView = "ZI_";
+        /** Expected prefix for consumption views */
+        this.consumptionView = "ZC_";
+        /** Expected prefix for basic restricted reuse views */
+        this.basicRestrictedReuseView = "ZR_";
+        /** Expected prefix for composite restricted reuse views */
+        this.compositeRestrictedReuseView = "ZR_";
+        /** Expected prefix for private views */
+        this.privateView = "ZP_";
+        /** Expected prefix for remote API views */
+        this.remoteAPIView = "ZA_";
+        /** Expected prefix for view extends */
+        this.viewExtend = "ZX_";
+        /** Expected prefix for extension include views */
+        this.extensionIncludeView = "ZE_";
+        /** Expected prefix for derivation functions */
+        this.derivationFunction = "ZF_";
+        /** Expected prefix for abstract entities */
+        this.abstractEntity = "ZD_";
+    }
+}
+exports.CDSNamingConf = CDSNamingConf;
+class CDSNaming {
+    constructor() {
+        this.conf = new CDSNamingConf();
+    }
+    getMetadata() {
+        return {
+            key: "cds_naming",
+            title: "CDS Naming",
+            shortDescription: `Checks CDS naming conventions based on the VDM prefix rules`,
+            extendedInformation: `Validates that CDS entity names follow the expected prefix conventions:
+I_ for interface views, C_ for consumption views, R_ for restricted reuse views,
+P_ for private views, A_ for remote API views, X_ for view extends,
+E_ for extension include views, F_ for derivation functions, D_ for abstract entities.
+
+Names must also start with Z after the prefix (custom namespace).
+
+https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/ee6ff9b281d8448f96b4fe6c89f2bdc8/8a8cee943ef944fe8936f4cc60ba9bc1.html`,
+            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Naming],
+            badExample: `define view entity ZMY_VIEW as select from source { key id }`,
+            goodExample: `define view entity ZI_MY_VIEW as select from source { key id }`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    initialize(_reg) {
+        return this;
+    }
+    run(o) {
+        if (o.getType() !== "DDLS" || !(o instanceof objects_1.DataDefinition)) {
+            return [];
+        }
+        const tree = o.getTree();
+        if (tree === undefined) {
+            return [];
+        }
+        const file = o.findSourceFile();
+        if (file === undefined) {
+            return [];
+        }
+        const name = this.getCDSName(tree);
+        if (name === undefined) {
+            return [];
+        }
+        const nameStr = name.toUpperCase();
+        const allowedPrefixes = this.getAllowedPrefixes(tree);
+        if (allowedPrefixes.length === 0) {
+            return [];
+        }
+        const matched = allowedPrefixes.some(p => nameStr.startsWith(p.toUpperCase()));
+        if (!matched) {
+            const prefixList = [...new Set(allowedPrefixes)].join(", ");
+            const message = `CDS name "${name}" should have one of the expected prefixes: ${prefixList}`;
+            return [issue_1.Issue.atRow(file, 1, message, this.getMetadata().key, this.getConfig().severity)];
+        }
+        return [];
+    }
+    getCDSName(tree) {
+        const nameNodes = tree.findDirectExpressions(cds_name_1.CDSName);
+        if (nameNodes.length > 0) {
+            return nameNodes[0].getFirstToken().getStr();
+        }
+        return undefined;
+    }
+    getAllowedPrefixes(tree) {
+        const root = tree.get();
+        if (root instanceof expressions_1.CDSExtendView) {
+            return [this.conf.viewExtend];
+        }
+        if (root instanceof expressions_1.CDSDefineAbstract) {
+            return [this.conf.abstractEntity];
+        }
+        if (root instanceof expressions_1.CDSDefineTableFunction) {
+            return [this.conf.derivationFunction];
+        }
+        if (root instanceof expressions_1.CDSDefineView || root instanceof expressions_1.CDSDefineProjection || root instanceof expressions_1.CDSDefineCustom) {
+            return [
+                this.conf.basicInterfaceView,
+                this.conf.compositeInterfaceView,
+                this.conf.consumptionView,
+                this.conf.basicRestrictedReuseView,
+                this.conf.compositeRestrictedReuseView,
+                this.conf.privateView,
+                this.conf.remoteAPIView,
+                this.conf.extensionIncludeView,
+            ];
+        }
+        return [];
+    }
+}
+exports.CDSNaming = CDSNaming;
+//# sourceMappingURL=cds_naming.js.map

package/build/src/rules/index.js

@@ -28,8 +28,11 @@ __exportStar(require("./avoid_use"), exports);
 __exportStar(require("./begin_end_names"), exports);
 __exportStar(require("./begin_single_include"), exports);
 __exportStar(require("./call_transaction_authority_check"), exports);
+__exportStar(require("./cds_association_name"), exports);
 __exportStar(require("./cds_comment_style"), exports);
+__exportStar(require("./cds_field_order"), exports);
 __exportStar(require("./cds_legacy_view"), exports);
+__exportStar(require("./cds_naming"), exports);
 __exportStar(require("./cds_parser_error"), exports);
 __exportStar(require("./chain_mainly_declarations"), exports);
 __exportStar(require("./change_if_to_case"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/core",
-    "version": "2.117.3",
+    "version": "2.118.0",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",
@@ -63,7 +63,7 @@
         "typescript": "^5.9.3"
     },
     "dependencies": {
-        "fast-xml-parser": "^5.5.5",
+        "fast-xml-parser": "^5.5.7",
         "json5": "^2.2.3",
         "vscode-languageserver-types": "^3.17.5"
     }