@abaplint/core 2.119.66 → 2.120.0

package/build/src/rules/cds_association_name.js

@@ -18,15 +18,15 @@ class CDSAssociationName {
             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.
-
+            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
+            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
+            goodExample: `define view entity test as select from source
+  association [1..1] to target as _Assoc on _Assoc.id = source.id
 { key id }`,
         };
     }

package/build/src/rules/cds_comment_style.js

@@ -19,10 +19,10 @@ class CDSCommentStyle {
             key: "cds_comment_style",
             title: "CDS Comment Style",
             shortDescription: `Check for obsolete comment style`,
-            extendedInformation: `Check for obsolete comment style
-
-Comments starting with "--" are considered obsolete
-
+            extendedInformation: `Check for obsolete comment style
+
+Comments starting with "--" are considered obsolete
+
 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",

package/build/src/rules/cds_field_order.js

@@ -19,19 +19,19 @@ class CDSFieldOrder {
             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
+            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
+            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
 }`,
         };
     }

package/build/src/rules/cds_legacy_view.js

@@ -19,10 +19,10 @@ class CDSLegacyView {
             key: "cds_legacy_view",
             title: "CDS Legacy View",
             shortDescription: `Identify CDS Legacy Views`,
-            extendedInformation: `Use DEFINE VIEW ENTITY instead of DEFINE VIEW
-
-https://blogs.sap.com/2021/10/16/a-new-generation-of-cds-views-how-to-migrate-your-cds-views-to-cds-view-entities/
-
+            extendedInformation: `Use DEFINE VIEW ENTITY instead of DEFINE VIEW
+
+https://blogs.sap.com/2021/10/16/a-new-generation-of-cds-views-how-to-migrate-your-cds-views-to-cds-view-entities/
+
 v755 and up`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Upport],
         };

package/build/src/rules/cds_naming.js

@@ -44,13 +44,13 @@ class CDSNaming {
             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).
-
+            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 }`,

package/build/src/rules/chain_mainly_declarations.js

@@ -78,10 +78,10 @@ class ChainMainlyDeclarations extends _abap_rule_1.ABAPRule {
             key: "chain_mainly_declarations",
             title: "Chain mainly declarations",
             shortDescription: `Chain mainly declarations, allows chaining for the configured statements, reports errors for other statements.`,
-            extendedInformation: `
-https://docs.abapopenchecks.org/checks/23/
-
-https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
+            extendedInformation: `
+https://docs.abapopenchecks.org/checks/23/
+
+https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
 `,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
             badExample: `CALL METHOD: bar.`,

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/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.`,
         };
     }