@abaplint/core 2.90.9 → 2.90.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/README.md +6 -6
  2. package/build/abaplint.d.ts +15 -0
  3. package/build/src/abap/2_statements/expressions/association_name.js +11 -0
  4. package/build/src/abap/2_statements/expressions/index.js +1 -0
  5. package/build/src/abap/2_statements/statements/commit_entities.js +1 -1
  6. package/build/src/abap/2_statements/statements/delete_internal.js +3 -2
  7. package/build/src/abap/2_statements/statements/get_permissions.js +14 -0
  8. package/build/src/abap/2_statements/statements/index.js +2 -0
  9. package/build/src/abap/2_statements/statements/modify_entities.js +3 -1
  10. package/build/src/abap/2_statements/statements/read_entities.js +1 -1
  11. package/build/src/abap/2_statements/statements/set_locks.js +14 -0
  12. package/build/src/abap/3_structures/structures/normal.js +1 -1
  13. package/build/src/abap/5_syntax/_builtin.js +5 -5
  14. package/build/src/abap/5_syntax/expressions/form_param.js +4 -4
  15. package/build/src/abap/5_syntax/expressions/inline_data.js +2 -2
  16. package/build/src/abap/5_syntax/expressions/inline_field_definition.js +1 -1
  17. package/build/src/abap/5_syntax/expressions/inline_fs.js +2 -2
  18. package/build/src/abap/5_syntax/expressions/inline_loop_definition.js +2 -2
  19. package/build/src/abap/5_syntax/statements/catch.js +3 -3
  20. package/build/src/abap/5_syntax/statements/class_data.js +1 -1
  21. package/build/src/abap/5_syntax/statements/constant.js +1 -1
  22. package/build/src/abap/5_syntax/statements/selection_screen.js +2 -2
  23. package/build/src/abap/5_syntax/structures/class_data.js +1 -1
  24. package/build/src/abap/5_syntax/structures/constants.js +1 -1
  25. package/build/src/abap/5_syntax/structures/type_enum.js +2 -2
  26. package/build/src/abap/flow/flow_graph.js +7 -7
  27. package/build/src/abap/types/class_constant.js +1 -1
  28. package/build/src/abap/types/form_definition.js +2 -2
  29. package/build/src/abap/types/method_parameters.js +11 -11
  30. package/build/src/lsp/_lookup.js +1 -1
  31. package/build/src/lsp/help.js +7 -7
  32. package/build/src/registry.js +1 -1
  33. package/build/src/rules/7bit_ascii.js +2 -2
  34. package/build/src/rules/abapdoc.js +1 -1
  35. package/build/src/rules/align_parameters.js +33 -33
  36. package/build/src/rules/ambiguous_statement.js +5 -5
  37. package/build/src/rules/avoid_use.js +8 -8
  38. package/build/src/rules/begin_end_names.js +4 -4
  39. package/build/src/rules/begin_single_include.js +12 -12
  40. package/build/src/rules/call_transaction_authority_check.js +3 -3
  41. package/build/src/rules/chain_mainly_declarations.js +4 -4
  42. package/build/src/rules/check_abstract.js +2 -2
  43. package/build/src/rules/check_comments.js +4 -4
  44. package/build/src/rules/check_include.js +3 -3
  45. package/build/src/rules/check_subrc.js +8 -8
  46. package/build/src/rules/classic_exceptions_overlap.js +8 -8
  47. package/build/src/rules/commented_code.js +1 -1
  48. package/build/src/rules/constructor_visibility_public.js +4 -4
  49. package/build/src/rules/contains_tab.js +2 -2
  50. package/build/src/rules/dangerous_statement.js +1 -1
  51. package/build/src/rules/downport.js +65 -65
  52. package/build/src/rules/exit_or_check.js +4 -3
  53. package/build/src/rules/exporting.js +1 -1
  54. package/build/src/rules/forbidden_identifier.js +1 -1
  55. package/build/src/rules/forbidden_void_type.js +2 -2
  56. package/build/src/rules/functional_writing.js +17 -17
  57. package/build/src/rules/global_class.js +8 -8
  58. package/build/src/rules/identical_conditions.js +2 -2
  59. package/build/src/rules/identical_contents.js +14 -14
  60. package/build/src/rules/identical_descriptions.js +4 -4
  61. package/build/src/rules/if_in_if.js +7 -7
  62. package/build/src/rules/implement_methods.js +3 -3
  63. package/build/src/rules/in_statement_indentation.js +11 -11
  64. package/build/src/rules/intf_referencing_clas.js +3 -3
  65. package/build/src/rules/line_break_style.js +2 -2
  66. package/build/src/rules/line_length.js +1 -1
  67. package/build/src/rules/line_only_punc.js +1 -1
  68. package/build/src/rules/local_variable_names.js +2 -2
  69. package/build/src/rules/many_parentheses.js +10 -10
  70. package/build/src/rules/max_one_method_parameter_per_line.js +7 -7
  71. package/build/src/rules/max_one_statement.js +3 -3
  72. package/build/src/rules/method_overwrites_builtin.js +2 -2
  73. package/build/src/rules/nesting.js +1 -1
  74. package/build/src/rules/no_chained_assignment.js +1 -1
  75. package/build/src/rules/no_external_form_calls.js +2 -2
  76. package/build/src/rules/no_inline_in_optional_branches.js +11 -11
  77. package/build/src/rules/no_public_attributes.js +1 -1
  78. package/build/src/rules/no_yoda_conditions.js +4 -4
  79. package/build/src/rules/nrob_consistency.js +2 -2
  80. package/build/src/rules/obsolete_statement.js +40 -40
  81. package/build/src/rules/omit_parameter_name.js +8 -6
  82. package/build/src/rules/omit_receiving.js +13 -13
  83. package/build/src/rules/parser_702_chaining.js +2 -2
  84. package/build/src/rules/parser_error.js +2 -2
  85. package/build/src/rules/parser_missing_space.js +1 -1
  86. package/build/src/rules/prefer_inline.js +18 -18
  87. package/build/src/rules/prefer_is_not.js +7 -7
  88. package/build/src/rules/prefer_raise_exception_new.js +3 -3
  89. package/build/src/rules/prefer_returning_to_exporting.js +1 -1
  90. package/build/src/rules/prefer_xsdbool.js +2 -2
  91. package/build/src/rules/remove_descriptions.js +4 -4
  92. package/build/src/rules/rfc_error_handling.js +9 -9
  93. package/build/src/rules/select_add_order_by.js +5 -5
  94. package/build/src/rules/select_performance.js +2 -2
  95. package/build/src/rules/sicf_consistency.js +2 -2
  96. package/build/src/rules/slow_parameter_passing.js +1 -1
  97. package/build/src/rules/space_before_dot.js +2 -2
  98. package/build/src/rules/start_at_tab.js +1 -1
  99. package/build/src/rules/sy_modification.js +2 -2
  100. package/build/src/rules/tabl_enhancement_category.js +2 -2
  101. package/build/src/rules/unnecessary_pragma.js +14 -14
  102. package/build/src/rules/unused_methods.js +9 -9
  103. package/build/src/rules/unused_variables.js +9 -9
  104. package/build/src/rules/use_bool_expression.js +8 -8
  105. package/build/src/rules/use_line_exists.js +6 -6
  106. package/build/src/rules/use_new.js +4 -4
  107. package/build/src/rules/when_others_last.js +6 -6
  108. package/package.json +65 -65
@@ -23,7 +23,7 @@ class Abapdoc extends _abap_rule_1.ABAPRule {
23
23
  return {
24
24
  key: "abapdoc",
25
25
  title: "Check abapdoc",
26
- shortDescription: `Various checks regarding abapdoc.
26
+ shortDescription: `Various checks regarding abapdoc.
27
27
  Base rule checks for existence of abapdoc for public class methods and all interface methods.`,
28
28
  tags: [_irule_1.RuleTag.SingleFile],
29
29
  };
@@ -20,42 +20,42 @@ class AlignParameters extends _abap_rule_1.ABAPRule {
20
20
  key: "align_parameters",
21
21
  title: "Align Parameters",
22
22
  shortDescription: `Checks for vertially aligned parameters`,
23
- extendedInformation: `Checks:
24
- * function module calls
25
- * method calls
26
- * VALUE constructors
27
- * NEW constructors
28
- * RAISE EXCEPTION statements
29
- * CREATE OBJECT statements
30
- * RAISE EVENT statements
31
-
32
- https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
33
-
34
- Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
35
-
23
+ extendedInformation: `Checks:
24
+ * function module calls
25
+ * method calls
26
+ * VALUE constructors
27
+ * NEW constructors
28
+ * RAISE EXCEPTION statements
29
+ * CREATE OBJECT statements
30
+ * RAISE EVENT statements
31
+
32
+ https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
33
+
34
+ Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
35
+
36
36
  Also https://rules.abaplint.org/max_one_method_parameter_per_line/ can help aligning parameter syntax`,
37
37
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Styleguide],
38
- badExample: `CALL FUNCTION 'FOOBAR'
39
- EXPORTING
40
- foo = 2
41
- parameter = 3.
42
-
43
- foobar( moo = 1
44
- param = 1 ).
45
-
46
- foo = VALUE #(
47
- foo = bar
38
+ badExample: `CALL FUNCTION 'FOOBAR'
39
+ EXPORTING
40
+ foo = 2
41
+ parameter = 3.
42
+
43
+ foobar( moo = 1
44
+ param = 1 ).
45
+
46
+ foo = VALUE #(
47
+ foo = bar
48
48
  moo = 2 ).`,
49
- goodExample: `CALL FUNCTION 'FOOBAR'
50
- EXPORTING
51
- foo = 2
52
- parameter = 3.
53
-
54
- foobar( moo = 1
55
- param = 1 ).
56
-
57
- foo = VALUE #(
58
- foo = bar
49
+ goodExample: `CALL FUNCTION 'FOOBAR'
50
+ EXPORTING
51
+ foo = 2
52
+ parameter = 3.
53
+
54
+ foobar( moo = 1
55
+ param = 1 ).
56
+
57
+ foo = VALUE #(
58
+ foo = bar
59
59
  moo = 2 ).`,
60
60
  };
61
61
  }
@@ -20,14 +20,14 @@ class AmbiguousStatement extends _abap_rule_1.ABAPRule {
20
20
  return {
21
21
  key: "ambiguous_statement",
22
22
  title: "Check for ambigious statements",
23
- shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
24
- Add "TABLE" keyword or "@" for escaping SQL variables
25
-
23
+ shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
24
+ Add "TABLE" keyword or "@" for escaping SQL variables
25
+
26
26
  Only works if the target version is 740sp05 or above`,
27
27
  tags: [_irule_1.RuleTag.SingleFile],
28
- badExample: `DELETE foo FROM bar.
28
+ badExample: `DELETE foo FROM bar.
29
29
  MODIFY foo FROM bar.`,
30
- goodExample: `DELETE foo FROM @bar.
30
+ goodExample: `DELETE foo FROM @bar.
31
31
  MODIFY TABLE foo FROM bar.`,
32
32
  };
33
33
  }
@@ -37,14 +37,14 @@ class AvoidUse extends _abap_rule_1.ABAPRule {
37
37
  key: "avoid_use",
38
38
  title: "Avoid use of certain statements",
39
39
  shortDescription: `Detects usage of certain statements.`,
40
- extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
41
-
42
- Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
43
-
44
- STATICS: use CLASS-DATA instead
45
-
46
- DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
47
-
40
+ extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
41
+
42
+ Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
43
+
44
+ STATICS: use CLASS-DATA instead
45
+
46
+ DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
47
+
48
48
  TEST-SEAMS: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-test-seams-as-temporary-workaround`,
49
49
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
50
50
  };
@@ -23,11 +23,11 @@ class BeginEndNames extends _abap_rule_1.ABAPRule {
23
23
  title: "Check BEGIN END names",
24
24
  shortDescription: `Check BEGIN OF and END OF names match, plus there must be statements between BEGIN and END`,
25
25
  tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
26
- badExample: `DATA: BEGIN OF stru,
27
- field TYPE i,
26
+ badExample: `DATA: BEGIN OF stru,
27
+ field TYPE i,
28
28
  END OF structure_not_the_same.`,
29
- goodExample: `DATA: BEGIN OF stru,
30
- field TYPE i,
29
+ goodExample: `DATA: BEGIN OF stru,
30
+ field TYPE i,
31
31
  END OF stru.`,
32
32
  };
33
33
  }
@@ -21,19 +21,19 @@ class BeginSingleInclude extends _abap_rule_1.ABAPRule {
21
21
  title: "BEGIN contains single INCLUDE",
22
22
  shortDescription: `Finds TYPE BEGIN with just one INCLUDE TYPE, and DATA with single INCLUDE STRUCTURE`,
23
23
  tags: [_irule_1.RuleTag.SingleFile],
24
- badExample: `TYPES: BEGIN OF dummy1.
25
- INCLUDE TYPE dselc.
26
- TYPES: END OF dummy1.
27
-
28
- DATA BEGIN OF foo.
29
- INCLUDE STRUCTURE syst.
30
- DATA END OF foo.
31
-
32
- STATICS BEGIN OF bar.
33
- INCLUDE STRUCTURE syst.
24
+ badExample: `TYPES: BEGIN OF dummy1.
25
+ INCLUDE TYPE dselc.
26
+ TYPES: END OF dummy1.
27
+
28
+ DATA BEGIN OF foo.
29
+ INCLUDE STRUCTURE syst.
30
+ DATA END OF foo.
31
+
32
+ STATICS BEGIN OF bar.
33
+ INCLUDE STRUCTURE syst.
34
34
  STATICS END OF bar.`,
35
- goodExample: `DATA BEGIN OF foo.
36
- INCLUDE STRUCTURE dselc.
35
+ goodExample: `DATA BEGIN OF foo.
36
+ INCLUDE STRUCTURE dselc.
37
37
  DATA END OF foo.`,
38
38
  };
39
39
  }
@@ -24,9 +24,9 @@ class CallTransactionAuthorityCheck extends _abap_rule_1.ABAPRule {
24
24
  extendedInformation: `https://docs.abapopenchecks.org/checks/54/`,
25
25
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
26
26
  badExample: `CALL TRANSACTION 'FOO'.`,
27
- goodExample: `TRY.
28
- CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
29
- CATCH cx_sy_authorization_error.
27
+ goodExample: `TRY.
28
+ CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
29
+ CATCH cx_sy_authorization_error.
30
30
  ENDTRY.`,
31
31
  };
32
32
  }
@@ -45,10 +45,10 @@ class ChainMainlyDeclarations extends _abap_rule_1.ABAPRule {
45
45
  key: "chain_mainly_declarations",
46
46
  title: "Chain mainly declarations",
47
47
  shortDescription: `Chain mainly declarations, allows chaining for the configured statements, reports errors for other statements.`,
48
- extendedInformation: `
49
- https://docs.abapopenchecks.org/checks/23/
50
-
51
- https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
48
+ extendedInformation: `
49
+ https://docs.abapopenchecks.org/checks/23/
50
+
51
+ https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
52
52
  `,
53
53
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
54
54
  badExample: `CALL METHOD: bar.`,
@@ -23,8 +23,8 @@ class CheckAbstract extends _abap_rule_1.ABAPRule {
23
23
  return {
24
24
  key: "check_abstract",
25
25
  title: "Check abstract methods and classes",
26
- shortDescription: `Checks abstract methods and classes:
27
- - class defined as abstract and final,
26
+ shortDescription: `Checks abstract methods and classes:
27
+ - class defined as abstract and final,
28
28
  - non-abstract class contains abstract methods`,
29
29
  extendedInformation: `If a class defines only constants, use an interface instead`,
30
30
  tags: [_irule_1.RuleTag.SingleFile],
@@ -27,11 +27,11 @@ class CheckComments extends _abap_rule_1.ABAPRule {
27
27
  return {
28
28
  key: "check_comments",
29
29
  title: "Check Comments",
30
- shortDescription: `
30
+ shortDescription: `
31
31
  Various checks for comment usage.`,
32
- extendedInformation: `
33
- * End of line comments. Comments starting with "#EC" or "##" are ignored
34
-
32
+ extendedInformation: `
33
+ * End of line comments. Comments starting with "#EC" or "##" are ignored
34
+
35
35
  https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#put-comments-before-the-statement-they-relate-to`,
36
36
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
37
37
  };
@@ -17,9 +17,9 @@ class CheckInclude {
17
17
  key: "check_include",
18
18
  title: "Check INCLUDEs",
19
19
  shortDescription: `Checks INCLUDE statements`,
20
- extendedInformation: `
21
- * Reports unused includes
22
- * Errors if the includes are not found
20
+ extendedInformation: `
21
+ * Reports unused includes
22
+ * Errors if the includes are not found
23
23
  * Error if including a main program`,
24
24
  tags: [_irule_1.RuleTag.Syntax],
25
25
  };
@@ -34,14 +34,14 @@ class CheckSubrc extends _abap_rule_1.ABAPRule {
34
34
  key: "check_subrc",
35
35
  title: "Check sy-subrc",
36
36
  shortDescription: `Check sy-subrc`,
37
- extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
38
-
39
- If sy-dbcnt is checked after database statements, it is considered okay.
40
-
41
- "SELECT SINGLE @abap_true FROM " is considered as an existence check
42
-
43
- If IS ASSIGNED is checked after assigning, it is considered okay.
44
-
37
+ extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
38
+
39
+ If sy-dbcnt is checked after database statements, it is considered okay.
40
+
41
+ "SELECT SINGLE @abap_true FROM " is considered as an existence check
42
+
43
+ If IS ASSIGNED is checked after assigning, it is considered okay.
44
+
45
45
  FIND statement with MATCH COUNT is considered okay if subrc is not checked`,
46
46
  tags: [_irule_1.RuleTag.SingleFile],
47
47
  pseudoComment: "EC CI_SUBRC",
@@ -21,15 +21,15 @@ class ClassicExceptionsOverlap extends _abap_rule_1.ABAPRule {
21
21
  shortDescription: `Find overlapping classic exceptions`,
22
22
  extendedInformation: `When debugging its typically good to know exactly which exception is caught`,
23
23
  tags: [_irule_1.RuleTag.SingleFile],
24
- badExample: ` EXCEPTIONS
25
- system_failure = 1 MESSAGE lv_message
26
- communication_failure = 1 MESSAGE lv_message
27
- resource_failure = 1
24
+ badExample: ` EXCEPTIONS
25
+ system_failure = 1 MESSAGE lv_message
26
+ communication_failure = 1 MESSAGE lv_message
27
+ resource_failure = 1
28
28
  OTHERS = 1.`,
29
- goodExample: ` EXCEPTIONS
30
- system_failure = 1 MESSAGE lv_message
31
- communication_failure = 2 MESSAGE lv_message
32
- resource_failure = 3
29
+ goodExample: ` EXCEPTIONS
30
+ system_failure = 1 MESSAGE lv_message
31
+ communication_failure = 2 MESSAGE lv_message
32
+ resource_failure = 3
33
33
  OTHERS = 4.`,
34
34
  };
35
35
  }
@@ -30,7 +30,7 @@ class CommentedCode extends _abap_rule_1.ABAPRule {
30
30
  key: "commented_code",
31
31
  title: "Find commented code",
32
32
  shortDescription: `Detects usage of commented out code.`,
33
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
33
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
34
34
  https://docs.abapopenchecks.org/checks/14/`,
35
35
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
36
36
  };
@@ -18,10 +18,10 @@ class ConstructorVisibilityPublic {
18
18
  key: "constructor_visibility_public",
19
19
  title: "Check constructor visibility is public",
20
20
  shortDescription: `Constructor must be placed in the public section, even if the class is not CREATE PUBLIC.`,
21
- extendedInformation: `
22
- This only applies to global classes.
23
-
24
- https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
21
+ extendedInformation: `
22
+ This only applies to global classes.
23
+
24
+ https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
25
25
  https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abeninstance_constructor_guidl.htm`,
26
26
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
27
27
  };
@@ -25,8 +25,8 @@ class ContainsTab extends _abap_rule_1.ABAPRule {
25
25
  key: "contains_tab",
26
26
  title: "Code contains tab",
27
27
  shortDescription: `Checks for usage of tabs (enable to enforce spaces)`,
28
- extendedInformation: `
29
- https://docs.abapopenchecks.org/checks/09/
28
+ extendedInformation: `
29
+ https://docs.abapopenchecks.org/checks/09/
30
30
  https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#indent-and-snap-to-tab`,
31
31
  tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
32
32
  };
@@ -40,7 +40,7 @@ class DangerousStatement extends _abap_rule_1.ABAPRule {
40
40
  key: "dangerous_statement",
41
41
  title: "Dangerous statement",
42
42
  shortDescription: `Detects potentially dangerous statements`,
43
- extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
43
+ extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
44
44
  dynamic SQL can potentially create SQL injection problems`,
45
45
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
46
46
  };
@@ -36,36 +36,36 @@ class Downport {
36
36
  key: "downport",
37
37
  title: "Downport statement",
38
38
  shortDescription: `Experimental downport functionality`,
39
- extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
40
- a higher level language version. If successful, various rules are applied to downport the statement.
41
- Target downport version is always v702, thus rule is only enabled if target version is v702.
42
-
43
- Current rules:
44
- * NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
45
- * DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
46
- * FIELD-SYMBOL() definitions are outlined
47
- * CONV is outlined
48
- * COND is outlined
49
- * REDUCE is outlined
50
- * SWITCH is outlined
51
- * APPEND expression is outlined
52
- * INSERT expression is outlined
53
- * EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
54
- * CAST changed to ?=
55
- * LOOP AT method_call( ) is outlined
56
- * VALUE # with structure fields
57
- * VALUE # with internal table lines
58
- * Table Expressions are outlined
59
- * SELECT INTO @DATA definitions are outlined
60
- * Some occurrences of string template formatting option ALPHA changed to function module call
61
- * SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
62
- * PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
63
- * RAISE EXCEPTION ... MESSAGE
64
- * Moving with +=, -=, /=, *=, &&= is expanded
65
- * line_exists and line_index is downported to READ TABLE
66
- * ENUMs, but does not nessesarily give the correct type and value
67
- * MESSAGE with non simple source
68
-
39
+ extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
40
+ a higher level language version. If successful, various rules are applied to downport the statement.
41
+ Target downport version is always v702, thus rule is only enabled if target version is v702.
42
+
43
+ Current rules:
44
+ * NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
45
+ * DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
46
+ * FIELD-SYMBOL() definitions are outlined
47
+ * CONV is outlined
48
+ * COND is outlined
49
+ * REDUCE is outlined
50
+ * SWITCH is outlined
51
+ * APPEND expression is outlined
52
+ * INSERT expression is outlined
53
+ * EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
54
+ * CAST changed to ?=
55
+ * LOOP AT method_call( ) is outlined
56
+ * VALUE # with structure fields
57
+ * VALUE # with internal table lines
58
+ * Table Expressions are outlined
59
+ * SELECT INTO @DATA definitions are outlined
60
+ * Some occurrences of string template formatting option ALPHA changed to function module call
61
+ * SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
62
+ * PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
63
+ * RAISE EXCEPTION ... MESSAGE
64
+ * Moving with +=, -=, /=, *=, &&= is expanded
65
+ * line_exists and line_index is downported to READ TABLE
66
+ * ENUMs, but does not nessesarily give the correct type and value
67
+ * MESSAGE with non simple source
68
+
69
69
  Only one transformation is applied to a statement at a time, so multiple steps might be required to do the full downport.`,
70
70
  tags: [_irule_1.RuleTag.Experimental, _irule_1.RuleTag.Downport, _irule_1.RuleTag.Quickfix],
71
71
  };
@@ -410,10 +410,10 @@ Only one transformation is applied to a statement at a time, so multiple steps m
410
410
  const fieldName = f.concatTokens();
411
411
  fieldDefinition += indentation + " " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
412
412
  }
413
- fieldDefinition = `DATA: BEGIN OF ${name},
413
+ fieldDefinition = `DATA: BEGIN OF ${name},
414
414
  ${fieldDefinition}${indentation} END OF ${name}.`;
415
415
  }
416
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
416
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
417
417
  ${indentation}`);
418
418
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
419
419
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -454,12 +454,12 @@ ${indentation}`);
454
454
  }
455
455
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
456
456
  const name = ((_c = inlineData.findFirstExpression(Expressions.TargetField)) === null || _c === void 0 ? void 0 : _c.concatTokens()) || "error";
457
- let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
458
- ${fieldDefinitions}${indentation} END OF ${uniqueName}.
459
- ${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
457
+ let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
458
+ ${fieldDefinitions}${indentation} END OF ${uniqueName}.
459
+ ${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
460
460
  ${indentation}`);
461
461
  if (fieldDefinitions === "") {
462
- fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
462
+ fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
463
463
  ${indentation}`);
464
464
  }
465
465
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
@@ -504,7 +504,7 @@ ${indentation}`);
504
504
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
505
505
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
506
506
  const firstToken = high.getFirstToken();
507
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
507
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
508
508
  ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
509
509
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
510
510
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -526,7 +526,7 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
526
526
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
527
527
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
528
528
  const firstToken = high.getFirstToken();
529
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
529
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
530
530
  ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
531
531
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
532
532
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -565,14 +565,14 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
565
565
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
566
566
  const firstToken = node.getFirstToken();
567
567
  // note that the tabix restore should be done before throwing the exception
568
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
569
- ${indentation}DATA ${tabixBackup} LIKE sy-tabix.
570
- ${indentation}${tabixBackup} = sy-tabix.
571
- ${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
572
- ${indentation}sy-tabix = ${tabixBackup}.
573
- ${indentation}IF sy-subrc <> 0.
574
- ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
575
- ${indentation}ENDIF.
568
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
569
+ ${indentation}DATA ${tabixBackup} LIKE sy-tabix.
570
+ ${indentation}${tabixBackup} = sy-tabix.
571
+ ${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
572
+ ${indentation}sy-tabix = ${tabixBackup}.
573
+ ${indentation}IF sy-subrc <> 0.
574
+ ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
575
+ ${indentation}ENDIF.
576
576
  ${indentation}`);
577
577
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, startToken.getStart(), tableExpression.getLastToken().getEnd(), uniqueName);
578
578
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -626,7 +626,7 @@ ${indentation}`);
626
626
  const className = classNames[0].concatTokens();
627
627
  const targetName = (_b = target.findFirstExpression(Expressions.TargetField)) === null || _b === void 0 ? void 0 : _b.concatTokens();
628
628
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
629
- const code = ` DATA ${targetName} TYPE REF TO ${className}.
629
+ const code = ` DATA ${targetName} TYPE REF TO ${className}.
630
630
  ${indentation}CATCH ${className} INTO ${targetName}.`;
631
631
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getStart(), node.getEnd(), code);
632
632
  return issue_1.Issue.atToken(lowFile, node.getFirstToken(), "Outline DATA", this.getMetadata().key, this.conf.severity, fix);
@@ -749,11 +749,11 @@ ${indentation}CATCH ${className} INTO ${targetName}.`;
749
749
  const uniqueName1 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
750
750
  const uniqueName2 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
751
751
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
752
- const abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
753
- ${indentation}${uniqueName1}-msgid = ${id === null || id === void 0 ? void 0 : id.toUpperCase()}.
754
- ${indentation}${uniqueName1}-msgno = ${number}.
755
- ${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
756
- ${indentation}CREATE OBJECT ${uniqueName2} EXPORTING textid = ${uniqueName1}.
752
+ const abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
753
+ ${indentation}${uniqueName1}-msgid = ${id === null || id === void 0 ? void 0 : id.toUpperCase()}.
754
+ ${indentation}${uniqueName1}-msgno = ${number}.
755
+ ${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
756
+ ${indentation}CREATE OBJECT ${uniqueName2} EXPORTING textid = ${uniqueName1}.
757
757
  ${indentation}RAISE EXCEPTION ${uniqueName2}.`;
758
758
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getStart(), node.getEnd(), abap);
759
759
  return issue_1.Issue.atToken(lowFile, startToken, "Downport RAISE MESSAGE", this.getMetadata().key, this.conf.severity, fix);
@@ -825,7 +825,7 @@ ${indentation}RAISE EXCEPTION ${uniqueName2}.`;
825
825
  }
826
826
  const enumName = (_b = high.findExpressionAfterToken("ENUM")) === null || _b === void 0 ? void 0 : _b.concatTokens();
827
827
  const structureName = (_c = high.findExpressionAfterToken("STRUCTURE")) === null || _c === void 0 ? void 0 : _c.concatTokens();
828
- let code = `TYPES ${enumName} TYPE i.
828
+ let code = `TYPES ${enumName} TYPE i.
829
829
  CONSTANTS: BEGIN OF ${structureName},\n`;
830
830
  let count = 1;
831
831
  for (const e of enumStructure.findDirectStatements(Statements.TypeEnum).concat(enumStructure.findDirectStatements(Statements.Type))) {
@@ -866,14 +866,14 @@ CONSTANTS: BEGIN OF ${structureName},\n`;
866
866
  const tabixBackup = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
867
867
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
868
868
  // restore tabix before exeption
869
- const code = `FIELD-SYMBOLS ${uniqueName} LIKE LINE OF ${tName}.
870
- ${indentation}DATA ${tabixBackup} LIKE sy-tabix.
871
- ${indentation}${tabixBackup} = sy-tabix.
872
- ${indentation}READ TABLE ${tName} ${condition}ASSIGNING ${uniqueName}.
873
- ${indentation}sy-tabix = ${tabixBackup}.
874
- ${indentation}IF sy-subrc <> 0.
875
- ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
876
- ${indentation}ENDIF.
869
+ const code = `FIELD-SYMBOLS ${uniqueName} LIKE LINE OF ${tName}.
870
+ ${indentation}DATA ${tabixBackup} LIKE sy-tabix.
871
+ ${indentation}${tabixBackup} = sy-tabix.
872
+ ${indentation}READ TABLE ${tName} ${condition}ASSIGNING ${uniqueName}.
873
+ ${indentation}sy-tabix = ${tabixBackup}.
874
+ ${indentation}IF sy-subrc <> 0.
875
+ ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
876
+ ${indentation}ENDIF.
877
877
  ${indentation}${uniqueName}`;
878
878
  const start = target.getFirstToken().getStart();
879
879
  const end = (_a = tableExpression.findDirectTokenByText("]")) === null || _a === void 0 ? void 0 : _a.getEnd();
@@ -961,10 +961,10 @@ ${indentation}${uniqueName}`;
961
961
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
962
962
  const source = (_b = templateSource === null || templateSource === void 0 ? void 0 : templateSource.findDirectExpression(Expressions.Source)) === null || _b === void 0 ? void 0 : _b.concatTokens();
963
963
  const topTarget = (_c = node.findDirectExpression(Expressions.Target)) === null || _c === void 0 ? void 0 : _c.concatTokens();
964
- const code = `CALL FUNCTION '${functionName}'
965
- ${indentation} EXPORTING
966
- ${indentation} input = ${source}
967
- ${indentation} IMPORTING
964
+ const code = `CALL FUNCTION '${functionName}'
965
+ ${indentation} EXPORTING
966
+ ${indentation} input = ${source}
967
+ ${indentation} IMPORTING
968
968
  ${indentation} output = ${topTarget}.`;
969
969
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getFirstToken().getStart(), node.getLastToken().getEnd(), code);
970
970
  return issue_1.Issue.atToken(lowFile, node.getFirstToken(), "Downport ALPHA", this.getMetadata().key, this.conf.severity, fix);
@@ -24,10 +24,10 @@ class ExitOrCheck extends _abap_rule_1.ABAPRule {
24
24
  return {
25
25
  key: "exit_or_check",
26
26
  title: "Find EXIT or CHECK outside loops",
27
- shortDescription: `Detects usages of EXIT or CHECK statements outside of loops.
27
+ shortDescription: `Detects usages of EXIT or CHECK statements outside of loops.
28
28
  Use RETURN to leave procesing blocks instead.`,
29
- extendedInformation: `https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenleave_processing_blocks.htm
30
- https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abapcheck_processing_blocks.htm
29
+ extendedInformation: `https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenleave_processing_blocks.htm
30
+ https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abapcheck_processing_blocks.htm
31
31
  https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#check-vs-return`,
32
32
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
33
33
  };
@@ -45,6 +45,7 @@ https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#check-vs-re
45
45
  const get = statement.get();
46
46
  if (get instanceof Statements.Loop
47
47
  || get instanceof Statements.While
48
+ || get instanceof Statements.LoopAtScreen
48
49
  || get instanceof Statements.SelectLoop
49
50
  || get instanceof Statements.Do) {
50
51
  stack.push(statement);
@@ -22,7 +22,7 @@ class Exporting extends _abap_rule_1.ABAPRule {
22
22
  shortDescription: `Detects EXPORTING statements which can be omitted.`,
23
23
  badExample: `call_method( EXPORTING foo = bar ).`,
24
24
  goodExample: `call_method( foo = bar ).`,
25
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#omit-the-optional-keyword-exporting
25
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#omit-the-optional-keyword-exporting
26
26
  https://docs.abapopenchecks.org/checks/30/`,
27
27
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
28
28
  };
@@ -26,7 +26,7 @@ class ForbiddenIdentifier extends _abap_rule_1.ABAPRule {
26
26
  key: "forbidden_identifier",
27
27
  title: "Forbidden Identifier",
28
28
  shortDescription: `Forbid use of specified identifiers, list of regex.`,
29
- extendedInformation: `Used in the transpiler to find javascript keywords in ABAP identifiers,
29
+ extendedInformation: `Used in the transpiler to find javascript keywords in ABAP identifiers,
30
30
  https://github.com/abaplint/transpiler/blob/bda94b8b56e2b7f2f87be2168f12361aa530220e/packages/transpiler/src/validation.ts#L44`,
31
31
  tags: [_irule_1.RuleTag.SingleFile],
32
32
  };
@@ -28,8 +28,8 @@ class ForbiddenVoidType {
28
28
  key: "forbidden_void_type",
29
29
  title: "Forbidden Void Types",
30
30
  shortDescription: `Avoid usage of specified void types.`,
31
- extendedInformation: `Inspiration:
32
- BOOLEAN, BOOLE_D, CHAR01, CHAR1, CHAR10, CHAR12, CHAR128, CHAR2, CHAR20, CHAR4, CHAR70,
31
+ extendedInformation: `Inspiration:
32
+ BOOLEAN, BOOLE_D, CHAR01, CHAR1, CHAR10, CHAR12, CHAR128, CHAR2, CHAR20, CHAR4, CHAR70,
33
33
  DATS, TIMS, DATUM, FLAG, INT4, NUMC3, NUMC4, SAP_BOOL, TEXT25, TEXT80, X255, XFELD`,
34
34
  };
35
35
  }