@abaplint/core 2.120.0 → 2.120.1

package/build/src/rules/change_if_to_case.js

@@ -62,17 +62,17 @@ class ChangeIfToCase extends _abap_rule_1.ABAPRule {
             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
-
+            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-case-to-else-if-for-multiple-alternative-conditions
+
 If the first comparison is a boolean compare, no issue is reported.`,
             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'.
+            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'.
+            goodExample: `CASE l_fcat-fieldname.
+  WHEN 'FOO'.
+  WHEN 'BAR' OR 'MOO'.
 ENDCASE.`,
         };
     }

package/build/src/rules/check_abstract.js

@@ -23,8 +23,8 @@ class CheckAbstract extends _abap_rule_1.ABAPRule {
         return {
             key: "check_abstract",
             title: "Check abstract methods and classes",
-            shortDescription: `Checks abstract methods and classes:
-- class defined as abstract and final,
+            shortDescription: `Checks abstract methods and classes:
+- class defined as abstract and final,
 - non-abstract class contains abstract methods`,
             extendedInformation: `If a class defines only constants, use an interface instead`,
             tags: [_irule_1.RuleTag.SingleFile],

package/build/src/rules/check_comments.js

@@ -28,11 +28,11 @@ class CheckComments extends _abap_rule_1.ABAPRule {
         return {
             key: "check_comments",
             title: "Check Comments",
-            shortDescription: `
+            shortDescription: `
 Various checks for comment usage.`,
-            extendedInformation: `
-Detects end of line comments. Comments starting with "#EC" or "##" are ignored
-
+            extendedInformation: `
+Detects end of line comments. Comments starting with "#EC" or "##" are ignored
+
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#put-comments-before-the-statement-they-relate-to`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
             badExample: `WRITE 2. " descriptive comment`,

package/build/src/rules/check_include.js

@@ -23,10 +23,10 @@ class CheckInclude {
             key: "check_include",
             title: "Check INCLUDEs",
             shortDescription: `Checks INCLUDE statements`,
-            extendedInformation: `
-* Reports unused includes
-* Errors if the includes are not found
-* Error if including a main program
+            extendedInformation: `
+* Reports unused includes
+* Errors if the includes are not found
+* Error if including a main program
 * Skips ZX* includes`,
             tags: [_irule_1.RuleTag.Syntax],
         };

package/build/src/rules/check_subrc.js

@@ -69,14 +69,14 @@ class CheckSubrc extends _abap_rule_1.ABAPRule {
             key: "check_subrc",
             title: "Check sy-subrc",
             shortDescription: `Check sy-subrc`,
-            extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
-
-If sy-dbcnt is checked after database statements, it is considered okay.
-
-"SELECT SINGLE @abap_true FROM " is considered as an existence check, also "SELECT COUNT( * )" is considered okay
-
-If IS ASSIGNED is checked after assigning, it is considered okay.
-
+            extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
+
+If sy-dbcnt is checked after database statements, it is considered okay.
+
+"SELECT SINGLE @abap_true FROM " is considered as an existence check, also "SELECT COUNT( * )" is considered okay
+
+If IS ASSIGNED is checked after assigning, it is considered okay.
+
 FIND statement with MATCH COUNT is considered okay if subrc is not checked`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
             pseudoComment: "EC CI_SUBRC",

package/build/src/rules/class_attribute_names.js

@@ -37,13 +37,13 @@ class ClassAttributeNames extends _abap_rule_1.ABAPRule {
             title: "Class attributes naming",
             shortDescription: `Allows you to enforce a pattern, such as a prefix, for class variable names.`,
             tags: [_irule_1.RuleTag.Naming, _irule_1.RuleTag.SingleFile],
-            badExample: `CLASS zcl_foo DEFINITION PUBLIC.
-  PUBLIC SECTION.
-    DATA counter TYPE i.
+            badExample: `CLASS zcl_foo DEFINITION PUBLIC.
+  PUBLIC SECTION.
+    DATA counter TYPE i.
 ENDCLASS.`,
-            goodExample: `CLASS zcl_foo DEFINITION PUBLIC.
-  PUBLIC SECTION.
-    DATA mv_counter TYPE i.
+            goodExample: `CLASS zcl_foo DEFINITION PUBLIC.
+  PUBLIC SECTION.
+    DATA mv_counter TYPE i.
 ENDCLASS.`,
         };
     }

package/build/src/rules/classic_exceptions_overlap.js

@@ -54,17 +54,17 @@ class ClassicExceptionsOverlap extends _abap_rule_1.ABAPRule {
             shortDescription: `Find overlapping classic exceptions`,
             extendedInformation: `When debugging its typically good to know exactly which exception is caught`,
             tags: [_irule_1.RuleTag.SingleFile],
-            badExample: `CALL FUNCTION 'SOMETHING'
-  EXCEPTIONS
-    system_failure        = 1 MESSAGE lv_message
-    communication_failure = 1 MESSAGE lv_message
-    resource_failure      = 1
+            badExample: `CALL FUNCTION 'SOMETHING'
+  EXCEPTIONS
+    system_failure        = 1 MESSAGE lv_message
+    communication_failure = 1 MESSAGE lv_message
+    resource_failure      = 1
     OTHERS                = 1.`,
-            goodExample: `CALL FUNCTION 'SOMETHING'
-  EXCEPTIONS
-    system_failure        = 1 MESSAGE lv_message
-    communication_failure = 2 MESSAGE lv_message
-    resource_failure      = 3
+            goodExample: `CALL FUNCTION 'SOMETHING'
+  EXCEPTIONS
+    system_failure        = 1 MESSAGE lv_message
+    communication_failure = 2 MESSAGE lv_message
+    resource_failure      = 3
     OTHERS                = 4.`,
         };
     }

package/build/src/rules/clear_exporting_parameters.js

@@ -0,0 +1,254 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClearExportingParameters = exports.ClearExportingParametersConf = void 0;
+const issue_1 = require("../issue");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const _irule_1 = require("./_irule");
+const syntax_1 = require("../abap/5_syntax/syntax");
+const _abap_object_1 = require("../objects/_abap_object");
+const _scope_type_1 = require("../abap/5_syntax/_scope_type");
+const objects_1 = require("../objects");
+const _reference_1 = require("../abap/5_syntax/_reference");
+const basic_1 = require("../abap/types/basic");
+const _statement_1 = require("../abap/2_statements/statements/_statement");
+const edit_helper_1 = require("../edit_helper");
+const Expressions = __importStar(require("../abap/2_statements/expressions"));
+class ClearExportingParametersConf extends _basic_rule_config_1.BasicRuleConfig {
+    constructor() {
+        super(...arguments);
+        /** Skip specific parameter names, case insensitive
+         * @uniqueItems true
+         */
+        this.skipNames = [];
+    }
+}
+exports.ClearExportingParametersConf = ClearExportingParametersConf;
+class ClearExportingParameters {
+    constructor() {
+        this.conf = new ClearExportingParametersConf();
+    }
+    getMetadata() {
+        return {
+            key: "clear_exporting_parameters",
+            title: "Clear EXPORTING parameters",
+            shortDescription: `Checks that EXPORTING parameters passed by reference are cleared or assigned before they are read`,
+            extendedInformation: `An EXPORTING parameter passed by reference behaves like a CHANGING parameter: it is not
+initialized when the method is called, so it can still contain a value supplied by the caller. Clear or overwrite it
+before reading it, so a leftover value is not accidentally used.
+
+https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#clear-or-overwrite-exporting-reference-parameters
+
+https://help.sap.com/doc/abapdocu_latest_index_htm/latest/en-US/abenref_transf_output_param_guidl.htm
+
+Note: EXPORTING parameters passed by VALUE are always initialized and are therefore not reported.
+Reading and writing the parameter in the same statement (e.g. "ev_result = ev_result + 1") is reported,
+as the source is evaluated before the parameter is assigned.
+Objects containing parser or syntax errors are not reported.
+
+Only class and interface method implementations are checked, function module parameters are currently not supported.`,
+            tags: [_irule_1.RuleTag.Styleguide],
+            badExample: `CLASS lcl DEFINITION.
+  PUBLIC SECTION.
+    METHODS foo EXPORTING ev_result TYPE i.
+ENDCLASS.
+CLASS lcl IMPLEMENTATION.
+  METHOD foo.
+    ev_result = ev_result + 1.
+  ENDMETHOD.
+ENDCLASS.`,
+            goodExample: `CLASS lcl DEFINITION.
+  PUBLIC SECTION.
+    METHODS foo EXPORTING ev_result TYPE i.
+ENDCLASS.
+CLASS lcl IMPLEMENTATION.
+  METHOD foo.
+    CLEAR ev_result.
+    ev_result = ev_result + 1.
+  ENDMETHOD.
+ENDCLASS.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+        if (this.conf.skipNames === undefined) {
+            this.conf.skipNames = [];
+        }
+    }
+    initialize(reg) {
+        this.reg = reg;
+        return this;
+    }
+    run(obj) {
+        if (!(obj instanceof _abap_object_1.ABAPObject) || obj instanceof objects_1.Interface) {
+            return [];
+        }
+        for (const file of obj.getABAPFiles()) {
+            for (const statement of file.getStatements()) {
+                if (statement.get() instanceof _statement_1.Unknown) {
+                    return []; // contains parser errors
+                }
+            }
+        }
+        const syntax = new syntax_1.SyntaxLogic(this.reg, obj).run();
+        if (syntax.issues.length > 0) {
+            return []; // contains syntax errors
+        }
+        const issues = [];
+        this.traverse(syntax.spaghetti.getTop(), obj, issues);
+        return issues;
+    }
+    traverse(node, obj, issues) {
+        if (node.getIdentifier().stype === _scope_type_1.ScopeType.Method) {
+            this.checkMethod(node, obj, issues);
+        }
+        for (const child of node.getChildren()) {
+            this.traverse(child, obj, issues);
+        }
+    }
+    checkMethod(node, obj, issues) {
+        const parameters = this.findExportingByReference(node, obj);
+        if (parameters.length === 0) {
+            return;
+        }
+        const references = this.collectReferences(node);
+        for (const parameter of parameters) {
+            const issue = this.checkParameter(parameter, references, obj);
+            if (issue !== undefined) {
+                issues.push(issue);
+            }
+        }
+    }
+    findExportingByReference(node, obj) {
+        var _a;
+        const ret = [];
+        const vars = node.getData().vars;
+        for (const name in vars) {
+            const parameter = vars[name];
+            const meta = parameter.getMeta();
+            if (meta.includes("exporting" /* IdentifierMeta.MethodExporting */) === false
+                || meta.includes("pass_by_value" /* IdentifierMeta.PassByValue */) === true) {
+                continue;
+            }
+            else if ((_a = this.conf.skipNames) === null || _a === void 0 ? void 0 : _a.some(s => s.toUpperCase() === name.toUpperCase())) {
+                continue;
+            }
+            const type = parameter.getType();
+            if (type instanceof basic_1.VoidType || type instanceof basic_1.UnknownType) {
+                continue; // e.g. RAP magic parameters, or unresolved types
+            }
+            else if (this.isPassByValue(parameter, obj) === true) {
+                continue; // VALUE(..) parameters are always initialized
+            }
+            ret.push(parameter);
+        }
+        return ret;
+    }
+    isPassByValue(parameter, obj) {
+        var _a;
+        // the PassByValue meta is not set for EXPORTING parameters, so determine it from the definition
+        const file = obj.getABAPFileByName(parameter.getFilename());
+        if (file === undefined) {
+            return false;
+        }
+        const statement = edit_helper_1.EditHelper.findStatement(parameter.getToken(), file);
+        if (statement === undefined) {
+            return false;
+        }
+        for (const param of statement.findAllExpressions(Expressions.MethodParam)) {
+            const nameToken = (_a = param.findFirstExpression(Expressions.MethodParamName)) === null || _a === void 0 ? void 0 : _a.getFirstToken();
+            if (nameToken !== undefined && nameToken.getStart().equals(parameter.getStart())) {
+                return param.getFirstToken().getStr().toUpperCase() === "VALUE";
+            }
+        }
+        return false;
+    }
+    collectReferences(node) {
+        // methods do not nest, so all descendant scopes (FOR, LET, ...) belong to this method
+        const ret = [...node.getData().references];
+        for (const child of node.getChildren()) {
+            ret.push(...this.collectReferences(child));
+        }
+        return ret;
+    }
+    checkParameter(parameter, references, obj) {
+        let firstRead = undefined;
+        let earliestWrite = undefined;
+        for (const reference of references) {
+            if (reference.resolved === undefined || parameter.equals(reference.resolved) === false) {
+                continue;
+            }
+            const pos = reference.position.getStart();
+            if (reference.referenceType === _reference_1.ReferenceType.DataReadReference) {
+                if (firstRead === undefined || pos.isBefore(firstRead.position.getStart())) {
+                    firstRead = reference;
+                }
+            }
+            else if (reference.referenceType === _reference_1.ReferenceType.DataWriteReference) {
+                if (earliestWrite === undefined || pos.isBefore(earliestWrite)) {
+                    earliestWrite = pos;
+                }
+            }
+        }
+        if (firstRead === undefined) {
+            return undefined; // never read, no hazard
+        }
+        // the parameter is safe only if it is written in a statement strictly before the first read
+        const readStatement = this.statementStart(firstRead.position.getStart(), obj);
+        const writeStatement = earliestWrite === undefined ? undefined : this.statementStart(earliestWrite, obj);
+        if (writeStatement !== undefined && readStatement !== undefined && writeStatement.isBefore(readStatement)) {
+            return undefined;
+        }
+        const message = `EXPORTING parameter "${parameter.getName().toLowerCase()}" read before it is cleared or assigned`;
+        return issue_1.Issue.atIdentifier(firstRead.position, message, this.getMetadata().key, this.conf.severity);
+    }
+    statementStart(pos, obj) {
+        for (const file of obj.getABAPFiles()) {
+            for (const statement of file.getStatements()) {
+                const start = statement.getStart();
+                const end = statement.getEnd();
+                if (pos.equals(start) || (pos.isAfter(start) && pos.isBefore(end))) {
+                    return start;
+                }
+            }
+        }
+        return undefined;
+    }
+}
+exports.ClearExportingParameters = ClearExportingParameters;
+//# sourceMappingURL=clear_exporting_parameters.js.map

package/build/src/rules/commented_code.js

@@ -30,7 +30,7 @@ class CommentedCode extends _abap_rule_1.ABAPRule {
             key: "commented_code",
             title: "Find commented code",
             shortDescription: `Detects usage of commented out code.`,
-            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
+            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
 https://docs.abapopenchecks.org/checks/14/`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
             badExample: `* WRITE 'hello world'.`,

package/build/src/rules/constructor_visibility_public.js

@@ -18,19 +18,19 @@ class ConstructorVisibilityPublic {
             key: "constructor_visibility_public",
             title: "Check constructor visibility is public",
             shortDescription: `Constructor must be placed in the public section, even if the class is not CREATE PUBLIC.`,
-            extendedInformation: `
-This only applies to global classes.
-
-https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
+            extendedInformation: `
+This only applies to global classes.
+
+https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
 https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abeninstance_constructor_guidl.htm`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
-            badExample: `CLASS zcl_foo DEFINITION PUBLIC CREATE PRIVATE.
-  PRIVATE SECTION.
-    METHODS constructor.
+            badExample: `CLASS zcl_foo DEFINITION PUBLIC CREATE PRIVATE.
+  PRIVATE SECTION.
+    METHODS constructor.
 ENDCLASS.`,
-            goodExample: `CLASS zcl_foo DEFINITION PUBLIC CREATE PRIVATE.
-  PUBLIC SECTION.
-    METHODS constructor.
+            goodExample: `CLASS zcl_foo DEFINITION PUBLIC CREATE PRIVATE.
+  PUBLIC SECTION.
+    METHODS constructor.
 ENDCLASS.`,
         };
     }

package/build/src/rules/contains_tab.js

@@ -25,8 +25,8 @@ class ContainsTab extends _abap_rule_1.ABAPRule {
             key: "contains_tab",
             title: "Code contains tab",
             shortDescription: `Checks for usage of tabs (enable to enforce spaces)`,
-            extendedInformation: `
-https://docs.abapopenchecks.org/checks/09/
+            extendedInformation: `
+https://docs.abapopenchecks.org/checks/09/
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#indent-and-snap-to-tab`,
             tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
             badExample: `\tWRITE 'hello world'.`,

package/build/src/rules/cyclic_oo.js

@@ -32,10 +32,10 @@ class CyclicOO {
             key: "cyclic_oo",
             title: "Cyclic OO",
             shortDescription: `Finds cyclic/circular OO references`,
-            extendedInformation: `Runs for global INTF + CLAS objects
-
-Objects must be without syntax errors for this rule to take effect
-
+            extendedInformation: `Runs for global INTF + CLAS objects
+
+Objects must be without syntax errors for this rule to take effect
+
 References in testclass includes are ignored`,
         };
     }

package/build/src/rules/dangerous_statement.js

@@ -77,7 +77,7 @@ class DangerousStatement extends _abap_rule_1.ABAPRule {
             key: "dangerous_statement",
             title: "Dangerous statement",
             shortDescription: `Detects potentially dangerous statements`,
-            extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
+            extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
 dynamic SQL can potentially create SQL injection problems`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
             badExample: `SELECT * FROM (lv_table_name) INTO TABLE @DATA(lt_rows).`,

package/build/src/rules/db_operation_in_loop.js

@@ -54,16 +54,16 @@ class DbOperationInLoop extends _abap_rule_1.ABAPRule {
             title: "Database operation in loop",
             shortDescription: `Database operation in LOOP/DO/WHILE`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Performance],
-            badExample: `LOOP AT lt_items INTO DATA(ls_item).
-  SELECT SINGLE name FROM zcustomer INTO @DATA(lv_name) WHERE id = @ls_item-customer_id.
+            badExample: `LOOP AT lt_items INTO DATA(ls_item).
+  SELECT SINGLE name FROM zcustomer INTO @DATA(lv_name) WHERE id = @ls_item-customer_id.
 ENDLOOP.`,
-            goodExample: `ASSERT lines( lt_items ) > 0.
-SELECT id, name FROM zcustomer INTO TABLE @DATA(lt_customers)
-  FOR ALL ENTRIES IN @lt_items
-  WHERE id = @lt_items-customer_id.
-
-LOOP AT lt_items INTO DATA(ls_item).
-  READ TABLE lt_customers INTO DATA(ls_customer) WITH KEY id = ls_item-customer_id.
+            goodExample: `ASSERT lines( lt_items ) > 0.
+SELECT id, name FROM zcustomer INTO TABLE @DATA(lt_customers)
+  FOR ALL ENTRIES IN @lt_items
+  WHERE id = @lt_items-customer_id.
+
+LOOP AT lt_items INTO DATA(ls_item).
+  READ TABLE lt_customers INTO DATA(ls_customer) WITH KEY id = ls_item-customer_id.
 ENDLOOP.`,
         };
     }

package/build/src/rules/definitions_top.js

@@ -63,13 +63,13 @@ class DefinitionsTop extends _abap_rule_1.ABAPRule {
             shortDescription: `Checks that definitions are placed at the beginning of METHODs, FORMs and FUNCTIONs.`,
             extendedInformation: `https://docs.abapopenchecks.org/checks/17/`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
-            badExample: `FORM foo.
-  WRITE 'hello'.
-  DATA int TYPE i.
+            badExample: `FORM foo.
+  WRITE 'hello'.
+  DATA int TYPE i.
 ENDFORM.`,
-            goodExample: `FORM foo.
-  DATA int TYPE i.
-  WRITE 'hello'.
+            goodExample: `FORM foo.
+  DATA int TYPE i.
+  WRITE 'hello'.
 ENDFORM.`,
         };
     }