@abaplint/core 2.92.2 → 2.93.0

package/build/abaplint.d.ts

@@ -572,6 +572,10 @@ declare class CDSAggregate extends Expression {
     getRunnable(): IStatementRunnable;
 }
 
+declare class CDSAnnotate extends Expression {
+    getRunnable(): IStatementRunnable;
+}
+
 declare class CDSAnnotation extends Expression {
     getRunnable(): IStatementRunnable;
 }
@@ -649,12 +653,17 @@ declare class CDSJoin extends Expression {
 }
 
 declare class CDSMetadataExtension extends AbstractObject {
+    private parserError;
+    private parsedData;
     getType(): string;
     getAllowedNaming(): {
         maxLength: number;
         allowNamespace: boolean;
     };
+    hasParserError(): boolean | undefined;
+    parse(): IParseResult;
     getDescription(): string | undefined;
+    findSourceFile(): IFile | undefined;
 }
 
 declare class CDSName extends Expression {
@@ -2015,6 +2024,7 @@ export { Expressions }
 declare namespace ExpressionsCDS {
     export {
         CDSAggregate,
+        CDSAnnotate,
         CDSAnnotationArray,
         CDSAnnotationObject,
         CDSAnnotationSimple,
@@ -3985,6 +3995,7 @@ declare namespace Objects {
         BusinessFunctionAssignment,
         BusinessFunctionSetAssignment,
         BusinessObjectModel,
+        ParsedMetadataExtension,
         CDSMetadataExtension,
         ChangeDocument,
         ChapterOfBookStructure,
@@ -4229,6 +4240,10 @@ declare type ParsedDataDefinition = {
     tree: ExpressionNode | undefined;
 };
 
+declare type ParsedMetadataExtension = {
+    tree: ExpressionNode | undefined;
+};
+
 declare class PassByValue extends Expression {
     getRunnable(): IStatementRunnable;
 }

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

@@ -36,7 +36,10 @@ class FieldChain {
             if (current === undefined) {
                 break;
             }
-            if (current.get() instanceof tokens_1.Dash) {
+            if (current.get() instanceof tokens_1.DashW) {
+                throw new Error("Ending with dash");
+            }
+            else if (current.get() instanceof tokens_1.Dash) {
                 if (context instanceof basic_1.UnknownType) {
                     throw new Error("Not a structure, type unknown, FieldChain");
                 }

package/build/src/cds/cds_lexer.js

@@ -22,13 +22,25 @@ class Stream {
         return this.buffer.length;
     }
 }
+var Mode;
+(function (Mode) {
+    Mode[Mode["Default"] = 0] = "Default";
+    Mode[Mode["String"] = 1] = "String";
+    Mode[Mode["SingleLineComment"] = 2] = "SingleLineComment";
+    Mode[Mode["MultiLineComment"] = 3] = "MultiLineComment";
+})(Mode || (Mode = {}));
 class Result {
     constructor() {
         this.result = [];
     }
-    add(text, row, col) {
+    add(text, row, col, mode) {
         if (text.length > 0) {
-            this.result.push(new tokens_1.Identifier(new position_1.Position(row, col), text));
+            if (mode === Mode.SingleLineComment) {
+                this.result.push(new tokens_1.Comment(new position_1.Position(row, col), text));
+            }
+            else {
+                this.result.push(new tokens_1.Identifier(new position_1.Position(row, col), text));
+            }
         }
         return "";
     }
@@ -36,13 +48,6 @@ class Result {
         return this.result;
     }
 }
-var Mode;
-(function (Mode) {
-    Mode[Mode["Default"] = 0] = "Default";
-    Mode[Mode["String"] = 1] = "String";
-    Mode[Mode["SingleLineComment"] = 2] = "SingleLineComment";
-    Mode[Mode["MultiLineComment"] = 3] = "MultiLineComment";
-})(Mode || (Mode = {}));
 class CDSLexer {
     static run(file) {
         const result = new Result();
@@ -61,7 +66,7 @@ class CDSLexer {
             if (mode === Mode.String) {
                 build += next;
                 if (next === "'") {
-                    build = result.add(build, row, col);
+                    build = result.add(build, row, col, mode);
                     mode = Mode.Default;
                 }
                 continue;
@@ -69,20 +74,24 @@ class CDSLexer {
             // single line comment handling
             if (mode === Mode.SingleLineComment) {
                 if (next === "\n") {
+                    build = result.add(build, row, col, mode);
                     mode = Mode.Default;
                 }
                 else {
+                    build += next;
                     continue;
                 }
             }
             else if (mode === Mode.Default && next === "/" && nextNext === "/") {
                 mode = Mode.SingleLineComment;
-                build = result.add(build, row, col);
+                build = result.add(build, row, col, mode);
+                build += next;
                 continue;
             }
             else if (mode === Mode.Default && next === "-" && nextNext === "-") {
                 mode = Mode.SingleLineComment;
-                build = result.add(build, row, col);
+                build = result.add(build, row, col, mode);
+                build += next;
                 continue;
             }
             // multi line comment handling
@@ -97,7 +106,7 @@ class CDSLexer {
             }
             else if (mode === Mode.Default && next === "/" && nextNext === "*") {
                 mode = Mode.MultiLineComment;
-                build = result.add(build, row, col);
+                build = result.add(build, row, col, mode);
                 continue;
             }
             switch (next) {
@@ -106,10 +115,10 @@ class CDSLexer {
                     build += next;
                     break;
                 case " ":
-                    build = result.add(build, row, col);
+                    build = result.add(build, row, col, mode);
                     break;
                 case "\n":
-                    build = result.add(build, row, col);
+                    build = result.add(build, row, col, mode);
                     row++;
                     col = 0;
                     break;
@@ -130,15 +139,15 @@ class CDSLexer {
                 case "-":
                 case "*":
                 case "/":
-                    build = result.add(build, row, col);
-                    result.add(next, row, col);
+                    build = result.add(build, row, col, mode);
+                    result.add(next, row, col, mode);
                     break;
                 default:
                     build += next;
                     break;
             }
         }
-        result.add(build, row, col);
+        result.add(build, row, col, mode);
         return result.get();
     }
 }

package/build/src/cds/cds_parser.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CDSParser = void 0;
+const tokens_1 = require("../abap/1_lexer/tokens");
 const combi_1 = require("../abap/2_statements/combi");
 const nodes_1 = require("../abap/nodes");
 const version_1 = require("../version");
@@ -12,7 +13,8 @@ class CDSParser {
         if (file === undefined) {
             return undefined;
         }
-        const tokens = cds_lexer_1.CDSLexer.run(file);
+        let tokens = cds_lexer_1.CDSLexer.run(file);
+        tokens = tokens.filter(t => !(t instanceof tokens_1.Comment));
         // console.dir(tokens);
         let res = combi_1.Combi.run(new Expressions.CDSDefineView(), tokens, version_1.defaultVersion);
         if (res === undefined || !(res[0] instanceof nodes_1.ExpressionNode)) {
@@ -21,6 +23,9 @@ class CDSParser {
         if (res === undefined || !(res[0] instanceof nodes_1.ExpressionNode)) {
             res = combi_1.Combi.run(new Expressions.CDSDefineProjection(), tokens, version_1.defaultVersion);
         }
+        if (res === undefined || !(res[0] instanceof nodes_1.ExpressionNode)) {
+            res = combi_1.Combi.run(new Expressions.CDSAnnotate(), tokens, version_1.defaultVersion);
+        }
         if (res === undefined || !(res[0] instanceof nodes_1.ExpressionNode)) {
             return undefined;
         }

package/build/src/cds/expressions/cds_annotate.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CDSAnnotate = void 0;
+const _1 = require(".");
+const combi_1 = require("../../abap/2_statements/combi");
+class CDSAnnotate extends combi_1.Expression {
+    getRunnable() {
+        return (0, combi_1.seq)((0, combi_1.star)(_1.CDSAnnotation), "ANNOTATE", (0, combi_1.alt)("ENTITY", "VIEW"), _1.CDSName, "WITH", (0, combi_1.str)("{"), (0, combi_1.plus)((0, combi_1.seq)(_1.CDSElement, ";")), (0, combi_1.str)("}"), (0, combi_1.opt)(";"));
+    }
+}
+exports.CDSAnnotate = CDSAnnotate;
+//# sourceMappingURL=cds_annotate.js.map

package/build/src/cds/expressions/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./cds_aggregate"), exports);
 __exportStar(require("./cds_aggregate"), exports);
+__exportStar(require("./cds_annotate"), exports);
 __exportStar(require("./cds_annotation_array"), exports);
 __exportStar(require("./cds_annotation_object"), exports);
 __exportStar(require("./cds_annotation_simple"), exports);

package/build/src/objects/cds_metadata_extension.js

@@ -1,8 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CDSMetadataExtension = void 0;
+const cds_parser_1 = require("../cds/cds_parser");
 const _abstract_object_1 = require("./_abstract_object");
 class CDSMetadataExtension extends _abstract_object_1.AbstractObject {
+    constructor() {
+        super(...arguments);
+        this.parserError = undefined;
+        this.parsedData = undefined;
+    }
     getType() {
         return "DDLX";
     }
@@ -12,10 +18,31 @@ class CDSMetadataExtension extends _abstract_object_1.AbstractObject {
             allowNamespace: true,
         };
     }
+    hasParserError() {
+        return this.parserError;
+    }
+    parse() {
+        if (this.isDirty() === false) {
+            return { updated: false, runtime: 0 };
+        }
+        const start = Date.now();
+        this.parsedData = {
+            tree: undefined,
+        };
+        this.parsedData.tree = new cds_parser_1.CDSParser().parse(this.findSourceFile());
+        if (this.parsedData.tree === undefined) {
+            this.parserError = true;
+        }
+        this.dirty = false;
+        return { updated: true, runtime: Date.now() - start };
+    }
     getDescription() {
         // todo
         return undefined;
     }
+    findSourceFile() {
+        return this.getFiles().find(f => f.getFilename().endsWith(".asddlxs") || f.getFilename().endsWith(".acds"));
+    }
 }
 exports.CDSMetadataExtension = CDSMetadataExtension;
 //# sourceMappingURL=cds_metadata_extension.js.map

package/build/src/objects/data_definition.js

@@ -52,7 +52,7 @@ class DataDefinition extends _abstract_object_1.AbstractObject {
         super.setDirty();
     }
     findSourceFile() {
-        return this.getFiles().find(f => f.getFilename().endsWith(".asddls"));
+        return this.getFiles().find(f => f.getFilename().endsWith(".asddls") || f.getFilename().endsWith(".acds"));
     }
     hasParserError() {
         return this.parserError;

package/build/src/registry.js

@@ -67,7 +67,7 @@ class Registry {
     }
     static abaplintVersion() {
         // magic, see build script "version.sh"
-        return "2.92.2";
+        return "2.93.0";
     }
     getDDICReferences() {
         return this.references;

package/build/src/rules/cds_comment_style.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CDSCommentStyle = exports.CDSCommentStyleConf = 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 cds_lexer_1 = require("../cds/cds_lexer");
+const tokens_1 = require("../abap/1_lexer/tokens");
+class CDSCommentStyleConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.CDSCommentStyleConf = CDSCommentStyleConf;
+class CDSCommentStyle {
+    constructor() {
+        this.conf = new CDSCommentStyleConf();
+    }
+    getMetadata() {
+        return {
+            key: "cds_comment_style",
+            title: "CDS Comment Style",
+            shortDescription: `Check for obsolete comment style`,
+            extendedInformation: `Check for obsolete comment style
+
+https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abencds_general_syntax_rules.htm`,
+            tags: [_irule_1.RuleTag.SingleFile],
+            badExample: "-- this is a comment",
+            goodExample: "// this is a comment",
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    initialize(_reg) {
+        return this;
+    }
+    run(object) {
+        const issues = [];
+        if ((object.getType() === "DDLS" && object instanceof objects_1.DataDefinition) ||
+            (object.getType() === "DDLX" && object instanceof objects_1.CDSMetadataExtension)) {
+            const file = object.findSourceFile();
+            if (file === undefined) {
+                return issues;
+            }
+            const tokens = cds_lexer_1.CDSLexer.run(file);
+            for (const t of tokens) {
+                if (t instanceof tokens_1.Comment && t.getStr().startsWith("--")) {
+                    issues.push(issue_1.Issue.atToken(file, t, `Use "//" for comments instead of "--"`, this.getMetadata().key, this.getConfig().severity));
+                }
+            }
+        }
+        return issues;
+    }
+}
+exports.CDSCommentStyle = CDSCommentStyle;
+//# sourceMappingURL=cds_comment_style.js.map

package/build/src/rules/cds_parser_error.js

@@ -16,8 +16,8 @@ class CDSParserError {
         return {
             key: "cds_parser_error",
             title: "CDS Parser Error",
-            shortDescription: `CDS parsing, experimental`,
-            extendedInformation: ``,
+            shortDescription: `CDS parsing`,
+            extendedInformation: `Parses CDS and issues parser errors`,
             tags: [_irule_1.RuleTag.Syntax],
         };
     }
@@ -30,11 +30,12 @@ class CDSParserError {
     initialize(_reg) {
         return this;
     }
-    run(o) {
+    run(object) {
         const issues = [];
-        if (o.getType() === "DDLS" && o instanceof objects_1.DataDefinition) {
-            const hasError = o.hasParserError();
-            const file = o.findSourceFile();
+        if ((object.getType() === "DDLS" && object instanceof objects_1.DataDefinition) ||
+            (object.getType() === "DDLX" && object instanceof objects_1.CDSMetadataExtension)) {
+            const hasError = object.hasParserError();
+            const file = object.findSourceFile();
             if (hasError === true && file) {
                 issues.push(issue_1.Issue.atRow(file, 1, "CDS Parser error", this.getMetadata().key, this.getConfig().severity));
             }

package/build/src/rules/change_if_to_case.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangeIfToCase = exports.ChangeIfToCaseConf = void 0;
+const issue_1 = require("../issue");
+const Expressions = require("../abap/2_statements/expressions");
+const Statements = require("../abap/2_statements/statements");
+const Structures = require("../abap/3_structures/structures");
+const _abap_rule_1 = require("./_abap_rule");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const _irule_1 = require("./_irule");
+class ChangeIfToCaseConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.ChangeIfToCaseConf = ChangeIfToCaseConf;
+class ChangeIfToCase extends _abap_rule_1.ABAPRule {
+    constructor() {
+        super(...arguments);
+        this.conf = new ChangeIfToCaseConf();
+    }
+    getMetadata() {
+        return {
+            key: "change_if_to_case",
+            title: "Change IF to CASE",
+            shortDescription: `Finds IF constructs that can be changed to CASE`,
+            // eslint-disable-next-line max-len
+            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-case-to-else-if-for-multiple-alternative-conditions`,
+            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
+            badExample: `IF l_fcat-fieldname EQ 'FOO'.
+ELSEIF l_fcat-fieldname = 'BAR'
+    OR l_fcat-fieldname = 'MOO'.
+ENDIF.`,
+            goodExample: `CASE l_fcat-fieldname.
+  WHEN 'FOO.
+  WHEN 'BAR' OR MOO.
+ENDCASE.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    runParsed(file) {
+        var _a;
+        const issues = [];
+        const stru = file.getStructure();
+        if (stru === undefined) {
+            return issues;
+        }
+        for (const i of stru.findAllStructuresRecursive(Structures.If)) {
+            const conds = [];
+            const ifStatement = i.findDirectStatement(Statements.If);
+            if (ifStatement === undefined) {
+                continue;
+            }
+            conds.push(ifStatement === null || ifStatement === void 0 ? void 0 : ifStatement.findDirectExpression(Expressions.Cond));
+            for (const ei of i.findDirectStructures(Structures.ElseIf)) {
+                conds.push((_a = ei.findDirectStatement(Statements.ElseIf)) === null || _a === void 0 ? void 0 : _a.findDirectExpression(Expressions.Cond));
+            }
+            if (conds.length === 1) {
+                continue;
+            }
+            const issue = this.analyze(conds);
+            if (issue === true) {
+                const message = "Change IF to CASE";
+                issues.push(issue_1.Issue.atStatement(file, ifStatement, message, this.getMetadata().key, this.getConfig().severity));
+            }
+        }
+        return issues;
+    }
+    analyze(conds) {
+        var _a, _b, _c, _d, _e;
+        const tuples = [];
+        for (const c of conds) {
+            if (c === undefined) {
+                continue;
+            }
+            if (c.findFirstExpression(Expressions.CondSub)) {
+                return false;
+            }
+            else if (c.findDirectTokenByText("AND") || c.findDirectTokenByText("EQUIV")) {
+                return false;
+            }
+            for (const compare of c.findAllExpressions(Expressions.Compare)) {
+                const op = (_a = compare.findDirectExpression(Expressions.CompareOperator)) === null || _a === void 0 ? void 0 : _a.concatTokens().toUpperCase();
+                if (compare.getChildren().length !== 3) {
+                    return false;
+                }
+                else if (op !== "=" && op !== "EQ") {
+                    return false;
+                }
+                const left = (_c = (_b = compare.getChildren()[0]) === null || _b === void 0 ? void 0 : _b.concatTokens()) === null || _c === void 0 ? void 0 : _c.toUpperCase();
+                const right = (_e = (_d = compare.getChildren()[2]) === null || _d === void 0 ? void 0 : _d.concatTokens()) === null || _e === void 0 ? void 0 : _e.toUpperCase();
+                tuples.push({ left, right });
+            }
+        }
+        if (tuples.length === 1) {
+            return false;
+        }
+        let chain = "";
+        if (tuples[0].left === tuples[1].left) {
+            chain = tuples[0].left;
+        }
+        else if (tuples[0].left === tuples[1].right) {
+            chain = tuples[0].left;
+        }
+        else if (tuples[0].right === tuples[1].right) {
+            chain = tuples[0].right;
+        }
+        else if (tuples[0].right === tuples[1].left) {
+            chain = tuples[0].right;
+        }
+        else {
+            return false;
+        }
+        for (const t of tuples) {
+            if (t.left !== chain && t.right !== chain) {
+                return false;
+            }
+        }
+        return true;
+    }
+}
+exports.ChangeIfToCase = ChangeIfToCase;
+//# sourceMappingURL=change_if_to_case.js.map

package/build/src/rules/constant_classes.js

@@ -24,7 +24,7 @@ class ConstantClasses {
             title: "Validate constant classes",
             shortDescription: `Checks that a class contains exactly the constants corresponding to a domain's fixed values.`,
             extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-enumeration-classes-to-constants-interfaces`,
-            tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Experimental],
+            tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Experimental],
         };
     }
     initialize(reg) {

package/build/src/rules/index.js

@@ -24,21 +24,21 @@ __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_parser_error"), exports);
+__exportStar(require("./cds_comment_style"), exports);
 __exportStar(require("./cds_legacy_view"), exports);
+__exportStar(require("./cds_parser_error"), exports);
 __exportStar(require("./chain_mainly_declarations"), exports);
+__exportStar(require("./change_if_to_case"), exports);
 __exportStar(require("./check_abstract"), exports);
 __exportStar(require("./check_comments"), exports);
 __exportStar(require("./check_ddic"), exports);
 __exportStar(require("./check_include"), exports);
 __exportStar(require("./check_subrc"), exports);
-__exportStar(require("./no_external_form_calls"), exports);
 __exportStar(require("./check_syntax"), exports);
-__exportStar(require("./classic_exceptions_overlap"), exports);
 __exportStar(require("./check_text_elements"), exports);
 __exportStar(require("./check_transformation_exists"), exports);
-__exportStar(require("./superfluous_value"), exports);
 __exportStar(require("./class_attribute_names"), exports);
+__exportStar(require("./classic_exceptions_overlap"), exports);
 __exportStar(require("./cloud_types"), exports);
 __exportStar(require("./colon_missing_space"), exports);
 __exportStar(require("./commented_code"), exports);
@@ -102,6 +102,7 @@ __exportStar(require("./nesting"), exports);
 __exportStar(require("./newline_between_methods"), exports);
 __exportStar(require("./no_aliases"), exports);
 __exportStar(require("./no_chained_assignment"), exports);
+__exportStar(require("./no_external_form_calls"), exports);
 __exportStar(require("./no_inline_in_optional_branches"), exports);
 __exportStar(require("./no_public_attributes"), exports);
 __exportStar(require("./no_yoda_conditions"), exports);
@@ -140,6 +141,7 @@ __exportStar(require("./sql_escape_host_variables"), exports);
 __exportStar(require("./start_at_tab"), exports);
 __exportStar(require("./static_call_via_instance"), exports);
 __exportStar(require("./superclass_final"), exports);
+__exportStar(require("./superfluous_value"), exports);
 __exportStar(require("./sy_modification"), exports);
 __exportStar(require("./tabl_enhancement_category"), exports);
 __exportStar(require("./try_without_catch"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/core",
-    "version": "2.92.2",
+    "version": "2.93.0",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",
@@ -50,7 +50,7 @@
         "@types/mocha": "^9.1.1",
         "@types/node": "^18.7.13",
         "chai": "^4.3.6",
-        "eslint": "^8.22.0",
+        "eslint": "^8.23.0",
         "mocha": "^10.0.0",
         "c8": "^7.12.0",
         "source-map-support": "^0.5.21",