@abaplint/core 2.113.23 → 2.113.25

package/build/src/rules/align_type_expressions.js

@@ -30,37 +30,37 @@ class AlignTypeExpressions extends _abap_rule_1.ABAPRule {
             key: "align_type_expressions",
             title: "Align TYPE expressions",
             shortDescription: `Align TYPE expressions in statements`,
-            extendedInformation: `
-Currently works for METHODS + BEGIN OF
-
-If BEGIN OF has an INCLUDE TYPE its ignored
-
-Also note that clean ABAP does not recommend aligning TYPE clauses:
+            extendedInformation: `
+Currently works for METHODS + BEGIN OF
+
+If BEGIN OF has an INCLUDE TYPE its ignored
+
+Also note that clean ABAP does not recommend aligning TYPE clauses:
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-align-type-clauses`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix],
-            badExample: `
-TYPES: BEGIN OF foo,
-         bar TYPE i,
-         foobar TYPE i,
-       END OF foo.
-
-INTERFACE lif.
-  METHODS bar
-    IMPORTING
-      foo TYPE i
-      foobar TYPE i.
+            badExample: `
+TYPES: BEGIN OF foo,
+         bar TYPE i,
+         foobar TYPE i,
+       END OF foo.
+
+INTERFACE lif.
+  METHODS bar
+    IMPORTING
+      foo TYPE i
+      foobar TYPE i.
 ENDINTERFACE.`,
-            goodExample: `
-TYPES: BEGIN OF foo,
-         bar    TYPE i,
-         foobar TYPE i,
-       END OF foo.
-
-INTERFACE lif.
-  METHODS bar
-    IMPORTING
-      foo    TYPE i
-      foobar TYPE i.
+            goodExample: `
+TYPES: BEGIN OF foo,
+         bar    TYPE i,
+         foobar TYPE i,
+       END OF foo.
+
+INTERFACE lif.
+  METHODS bar
+    IMPORTING
+      foo    TYPE i
+      foobar TYPE i.
 ENDINTERFACE.`,
         };
     }

package/build/src/rules/ambiguous_statement.js

@@ -20,16 +20,16 @@ class AmbiguousStatement extends _abap_rule_1.ABAPRule {
         return {
             key: "ambiguous_statement",
             title: "Check for ambigious statements",
-            shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
-Add "TABLE" keyword or "@" for escaping SQL variables
-
+            shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
+Add "TABLE" keyword or "@" for escaping SQL variables
+
 Only works if the target version is 740sp05 or above`,
             tags: [_irule_1.RuleTag.SingleFile],
-            badExample: `DELETE foo FROM bar.
+            badExample: `DELETE foo FROM bar.
 MODIFY foo FROM bar.`,
-            goodExample: `DELETE foo FROM @bar.
-DELETE TABLE itab FROM 2.
-MODIFY zfoo FROM @wa.
+            goodExample: `DELETE foo FROM @bar.
+DELETE TABLE itab FROM 2.
+MODIFY zfoo FROM @wa.
 MODIFY TABLE foo FROM bar.`,
         };
     }

package/build/src/rules/avoid_use.js

@@ -44,16 +44,16 @@ class AvoidUse extends _abap_rule_1.ABAPRule {
             key: "avoid_use",
             title: "Avoid use of certain statements",
             shortDescription: `Detects usage of certain statements.`,
-            extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
-
-Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
-
-STATICS: use CLASS-DATA instead
-
-DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
-
-TEST-SEAMS: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-test-seams-as-temporary-workaround
-
+            extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
+
+Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
+
+STATICS: use CLASS-DATA instead
+
+DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
+
+TEST-SEAMS: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-test-seams-as-temporary-workaround
+
 BREAK points`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
         };

package/build/src/rules/begin_end_names.js

@@ -24,11 +24,11 @@ class BeginEndNames extends _abap_rule_1.ABAPRule {
             title: "Check BEGIN END names",
             shortDescription: `Check BEGIN OF and END OF names match, plus there must be statements between BEGIN and END`,
             tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
-            badExample: `DATA: BEGIN OF stru,
-        field TYPE i,
+            badExample: `DATA: BEGIN OF stru,
+        field TYPE i,
       END OF structure_not_the_same.`,
-            goodExample: `DATA: BEGIN OF stru,
-        field TYPE i,
+            goodExample: `DATA: BEGIN OF stru,
+        field TYPE i,
       END OF stru.`,
         };
     }

package/build/src/rules/begin_single_include.js

@@ -21,20 +21,20 @@ class BeginSingleInclude extends _abap_rule_1.ABAPRule {
             title: "BEGIN contains single INCLUDE",
             shortDescription: `Finds TYPE BEGIN with just one INCLUDE TYPE, and DATA with single INCLUDE STRUCTURE`,
             tags: [_irule_1.RuleTag.SingleFile],
-            badExample: `TYPES: BEGIN OF dummy1.
-  INCLUDE TYPE dselc.
-TYPES: END OF dummy1.
-
-DATA BEGIN OF foo.
-INCLUDE STRUCTURE syst.
-DATA END OF foo.
-
-STATICS BEGIN OF bar.
-INCLUDE STRUCTURE syst.
+            badExample: `TYPES: BEGIN OF dummy1.
+  INCLUDE TYPE dselc.
+TYPES: END OF dummy1.
+
+DATA BEGIN OF foo.
+INCLUDE STRUCTURE syst.
+DATA END OF foo.
+
+STATICS BEGIN OF bar.
+INCLUDE STRUCTURE syst.
 STATICS END OF bar.`,
-            goodExample: `DATA BEGIN OF foo.
-  DATA field TYPE i.
-  INCLUDE STRUCTURE dselc.
+            goodExample: `DATA BEGIN OF foo.
+  DATA field TYPE i.
+  INCLUDE STRUCTURE dselc.
 DATA END OF foo.`,
         };
     }

package/build/src/rules/call_transaction_authority_check.js

@@ -24,9 +24,9 @@ class CallTransactionAuthorityCheck extends _abap_rule_1.ABAPRule {
             extendedInformation: `https://docs.abapopenchecks.org/checks/54/`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
             badExample: `CALL TRANSACTION 'FOO'.`,
-            goodExample: `TRY.
-    CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
-  CATCH cx_sy_authorization_error.
+            goodExample: `TRY.
+    CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
+  CATCH cx_sy_authorization_error.
 ENDTRY.`,
         };
     }

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_legacy_view.js

@@ -18,10 +18,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/chain_mainly_declarations.js

@@ -45,10 +45,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

@@ -29,17 +29,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

@@ -27,11 +27,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

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

package/build/src/rules/check_subrc.js

@@ -35,14 +35,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/classic_exceptions_overlap.js

@@ -21,17 +21,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,10 +18,10 @@ 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],
         };

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

@@ -41,7 +41,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],
         };

package/build/src/rules/definitions_top.js

@@ -30,13 +30,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: `FROM foo.
-  WRITE 'hello'.
-  DATA int TYPE i.
+            badExample: `FROM foo.
+  WRITE 'hello'.
+  DATA int TYPE i.
 ENDFORM.`,
-            goodExample: `FROM foo.
-  DATA int TYPE i.
-  WRITE 'hello'.
+            goodExample: `FROM foo.
+  DATA int TYPE i.
+  WRITE 'hello'.
 ENDFORM.`,
         };
     }