@abaplint/core 2.113.85 → 2.113.87

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 (127) hide show
  1. package/README.md +6 -6
  2. package/build/src/abap/2_statements/statements/assign.js +1 -1
  3. package/build/src/abap/2_statements/statements/call_ole.js +1 -1
  4. package/build/src/abap/2_statements/statements/communication.js +5 -3
  5. package/build/src/abap/2_statements/statements/delete_memory.js +1 -1
  6. package/build/src/abap/2_statements/statements/get_property.js +1 -1
  7. package/build/src/abap/2_statements/statements/modify_internal.js +2 -2
  8. package/build/src/abap/2_statements/statements/modify_line.js +1 -1
  9. package/build/src/abap/2_statements/statements/parameter.js +1 -1
  10. package/build/src/abap/2_statements/statements/scroll_list.js +2 -1
  11. package/build/src/abap/2_statements/statements/selectionscreen.js +1 -1
  12. package/build/src/abap/2_statements/statements/selectoption.js +1 -1
  13. package/build/src/abap/2_statements/statements/submit.js +1 -1
  14. package/build/src/abap/5_syntax/_type_utils.js +3 -0
  15. package/build/src/abap/5_syntax/expressions/source.js +3 -2
  16. package/build/src/abap/5_syntax/statements/loop.js +1 -5
  17. package/build/src/abap/flow/flow_graph.js +7 -7
  18. package/build/src/lsp/help.js +10 -10
  19. package/build/src/objects/_abap_object.js +4 -1
  20. package/build/src/registry.js +1 -1
  21. package/build/src/rules/7bit_ascii.js +4 -4
  22. package/build/src/rules/abapdoc.js +4 -4
  23. package/build/src/rules/add_test_attributes.js +20 -20
  24. package/build/src/rules/align_parameters.js +40 -40
  25. package/build/src/rules/align_type_expressions.js +28 -28
  26. package/build/src/rules/ambiguous_statement.js +7 -7
  27. package/build/src/rules/avoid_use.js +10 -10
  28. package/build/src/rules/begin_end_names.js +4 -4
  29. package/build/src/rules/begin_single_include.js +13 -13
  30. package/build/src/rules/call_transaction_authority_check.js +3 -3
  31. package/build/src/rules/cds_comment_style.js +4 -4
  32. package/build/src/rules/cds_legacy_view.js +4 -4
  33. package/build/src/rules/chain_mainly_declarations.js +4 -4
  34. package/build/src/rules/change_if_to_case.js +8 -8
  35. package/build/src/rules/check_abstract.js +2 -2
  36. package/build/src/rules/check_comments.js +4 -4
  37. package/build/src/rules/check_include.js +3 -3
  38. package/build/src/rules/check_subrc.js +8 -8
  39. package/build/src/rules/classic_exceptions_overlap.js +10 -10
  40. package/build/src/rules/commented_code.js +1 -1
  41. package/build/src/rules/constructor_visibility_public.js +4 -4
  42. package/build/src/rules/contains_tab.js +2 -2
  43. package/build/src/rules/cyclic_oo.js +4 -4
  44. package/build/src/rules/dangerous_statement.js +1 -1
  45. package/build/src/rules/definitions_top.js +6 -6
  46. package/build/src/rules/downport.js +82 -82
  47. package/build/src/rules/easy_to_find_messages.js +6 -6
  48. package/build/src/rules/empty_event.js +6 -6
  49. package/build/src/rules/empty_line_in_statement.js +2 -2
  50. package/build/src/rules/empty_structure.js +6 -6
  51. package/build/src/rules/exit_or_check.js +3 -3
  52. package/build/src/rules/expand_macros.js +5 -5
  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/fully_type_itabs.js +2 -2
  57. package/build/src/rules/functional_writing.js +17 -17
  58. package/build/src/rules/global_class.js +8 -8
  59. package/build/src/rules/identical_conditions.js +12 -12
  60. package/build/src/rules/identical_contents.js +14 -14
  61. package/build/src/rules/identical_descriptions.js +6 -6
  62. package/build/src/rules/if_in_if.js +35 -35
  63. package/build/src/rules/implement_methods.js +3 -3
  64. package/build/src/rules/implicit_start_of_selection.js +5 -5
  65. package/build/src/rules/in_statement_indentation.js +11 -11
  66. package/build/src/rules/indentation.js +16 -16
  67. package/build/src/rules/intf_referencing_clas.js +3 -3
  68. package/build/src/rules/invalid_table_index.js +2 -2
  69. package/build/src/rules/line_break_style.js +2 -2
  70. package/build/src/rules/line_length.js +1 -1
  71. package/build/src/rules/line_only_punc.js +1 -1
  72. package/build/src/rules/local_variable_names.js +6 -6
  73. package/build/src/rules/macro_naming.js +2 -2
  74. package/build/src/rules/main_file_contents.js +4 -4
  75. package/build/src/rules/many_parentheses.js +10 -10
  76. package/build/src/rules/max_one_method_parameter_per_line.js +7 -7
  77. package/build/src/rules/max_one_statement.js +5 -5
  78. package/build/src/rules/method_length.js +2 -2
  79. package/build/src/rules/method_overwrites_builtin.js +12 -12
  80. package/build/src/rules/mix_returning.js +6 -6
  81. package/build/src/rules/nesting.js +1 -1
  82. package/build/src/rules/no_chained_assignment.js +1 -1
  83. package/build/src/rules/no_external_form_calls.js +2 -2
  84. package/build/src/rules/no_inline_in_optional_branches.js +11 -11
  85. package/build/src/rules/no_prefixes.js +6 -6
  86. package/build/src/rules/no_public_attributes.js +1 -1
  87. package/build/src/rules/no_yoda_conditions.js +4 -4
  88. package/build/src/rules/nrob_consistency.js +2 -2
  89. package/build/src/rules/obsolete_statement.js +51 -51
  90. package/build/src/rules/omit_parameter_name.js +3 -3
  91. package/build/src/rules/omit_receiving.js +13 -13
  92. package/build/src/rules/parser_702_chaining.js +2 -2
  93. package/build/src/rules/parser_error.js +2 -2
  94. package/build/src/rules/parser_missing_space.js +1 -1
  95. package/build/src/rules/prefer_inline.js +16 -16
  96. package/build/src/rules/prefer_is_not.js +9 -9
  97. package/build/src/rules/prefer_raise_exception_new.js +5 -5
  98. package/build/src/rules/prefer_returning_to_exporting.js +4 -4
  99. package/build/src/rules/prefer_xsdbool.js +2 -2
  100. package/build/src/rules/preferred_compare_operator.js +2 -2
  101. package/build/src/rules/reduce_procedural_code.js +17 -17
  102. package/build/src/rules/remove_descriptions.js +4 -4
  103. package/build/src/rules/rfc_error_handling.js +7 -7
  104. package/build/src/rules/select_add_order_by.js +5 -5
  105. package/build/src/rules/select_performance.js +5 -5
  106. package/build/src/rules/select_single_full_key.js +2 -2
  107. package/build/src/rules/sicf_consistency.js +2 -2
  108. package/build/src/rules/slow_parameter_passing.js +16 -16
  109. package/build/src/rules/space_before_dot.js +2 -2
  110. package/build/src/rules/sql_value_conversion.js +6 -6
  111. package/build/src/rules/start_at_tab.js +1 -1
  112. package/build/src/rules/strict_sql.js +6 -6
  113. package/build/src/rules/sy_modification.js +3 -3
  114. package/build/src/rules/tabl_enhancement_category.js +2 -2
  115. package/build/src/rules/tables_declared_locally.js +2 -2
  116. package/build/src/rules/type_form_parameters.js +2 -2
  117. package/build/src/rules/unnecessary_pragma.js +29 -29
  118. package/build/src/rules/unnecessary_return.js +11 -11
  119. package/build/src/rules/unused_macros.js +6 -6
  120. package/build/src/rules/unused_methods.js +12 -12
  121. package/build/src/rules/unused_variables.js +12 -12
  122. package/build/src/rules/use_bool_expression.js +8 -8
  123. package/build/src/rules/use_class_based_exceptions.js +8 -8
  124. package/build/src/rules/use_line_exists.js +6 -6
  125. package/build/src/rules/use_new.js +4 -4
  126. package/build/src/rules/when_others_last.js +6 -6
  127. package/package.json +70 -70
@@ -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
  };
@@ -21,12 +21,12 @@ class ExpandMacros extends _abap_rule_1.ABAPRule {
21
21
  key: "expand_macros",
22
22
  title: "Expand Macros",
23
23
  shortDescription: `Allows expanding macro calls with quick fixes`,
24
- extendedInformation: `Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
25
-
24
+ extendedInformation: `Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
25
+
26
26
  Note that macros/DEFINE cannot be used in the ABAP Cloud programming model`,
27
- badExample: `DEFINE _hello.
28
- WRITE 'hello'.
29
- END-OF-DEFINITION.
27
+ badExample: `DEFINE _hello.
28
+ WRITE 'hello'.
29
+ END-OF-DEFINITION.
30
30
  _hello.`,
31
31
  goodExample: `WRITE 'hello'.`,
32
32
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Upport],
@@ -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
  }
@@ -20,9 +20,9 @@ class FullyTypeITabs extends _abap_rule_1.ABAPRule {
20
20
  key: "fully_type_itabs",
21
21
  title: "Fully type internal tables",
22
22
  shortDescription: `No implict table types or table keys`,
23
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-the-right-table-type
23
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-the-right-table-type
24
24
  https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key`,
25
- badExample: `DATA lt_foo TYPE TABLE OF ty.
25
+ badExample: `DATA lt_foo TYPE TABLE OF ty.
26
26
  DATA lt_bar TYPE STANDARD TABLE OF ty.`,
27
27
  goodExample: `DATA lt_foo TYPE STANDARD TABLE OF ty WITH EMPTY KEY.`,
28
28
  tags: [_irule_1.RuleTag.SingleFile],
@@ -28,26 +28,26 @@ class FunctionalWriting extends _abap_rule_1.ABAPRule {
28
28
  key: "functional_writing",
29
29
  title: "Use functional writing",
30
30
  shortDescription: `Detects usage of call method when functional style calls can be used.`,
31
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-functional-to-procedural-calls
31
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-functional-to-procedural-calls
32
32
  https://docs.abapopenchecks.org/checks/07/`,
33
33
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
34
- badExample: `CALL METHOD zcl_class=>method( ).
35
- CALL METHOD cl_abap_typedescr=>describe_by_name
36
- EXPORTING
37
- p_name = 'NAME'
38
- RECEIVING
39
- p_descr_ref = lr_typedescr
40
- EXCEPTIONS
41
- type_not_found = 1
34
+ badExample: `CALL METHOD zcl_class=>method( ).
35
+ CALL METHOD cl_abap_typedescr=>describe_by_name
36
+ EXPORTING
37
+ p_name = 'NAME'
38
+ RECEIVING
39
+ p_descr_ref = lr_typedescr
40
+ EXCEPTIONS
41
+ type_not_found = 1
42
42
  OTHERS = 2.`,
43
- goodExample: `zcl_class=>method( ).
44
- cl_abap_typedescr=>describe_by_name(
45
- EXPORTING
46
- p_name = 'NAME'
47
- RECEIVING
48
- p_descr_ref = lr_typedescr
49
- EXCEPTIONS
50
- type_not_found = 1
43
+ goodExample: `zcl_class=>method( ).
44
+ cl_abap_typedescr=>describe_by_name(
45
+ EXPORTING
46
+ p_name = 'NAME'
47
+ RECEIVING
48
+ p_descr_ref = lr_typedescr
49
+ EXCEPTIONS
50
+ type_not_found = 1
51
51
  OTHERS = 2 ).`,
52
52
  };
53
53
  }
@@ -19,14 +19,14 @@ class GlobalClass extends _abap_rule_1.ABAPRule {
19
19
  key: "global_class",
20
20
  title: "Global class checks",
21
21
  shortDescription: `Checks related to global classes`,
22
- extendedInformation: `* global classes must be in own files
23
-
24
- * file names must match class name
25
-
26
- * file names must match interface name
27
-
28
- * global classes must be global definitions
29
-
22
+ extendedInformation: `* global classes must be in own files
23
+
24
+ * file names must match class name
25
+
26
+ * file names must match interface name
27
+
28
+ * global classes must be global definitions
29
+
30
30
  * global interfaces must be global definitions`,
31
31
  tags: [_irule_1.RuleTag.Syntax],
32
32
  };
@@ -33,21 +33,21 @@ class IdenticalConditions extends _abap_rule_1.ABAPRule {
33
33
  return {
34
34
  key: "identical_conditions",
35
35
  title: "Identical conditions",
36
- shortDescription: `Find identical conditions in IF + CASE + WHILE etc
37
-
36
+ shortDescription: `Find identical conditions in IF + CASE + WHILE etc
37
+
38
38
  Prerequsites: code is pretty printed with identical cAsE`,
39
39
  tags: [_irule_1.RuleTag.SingleFile],
40
- badExample: `IF foo = bar OR 1 = a OR foo = bar.
41
- ENDIF.
42
- CASE bar.
43
- WHEN '1'.
44
- WHEN 'A' OR '1'.
40
+ badExample: `IF foo = bar OR 1 = a OR foo = bar.
41
+ ENDIF.
42
+ CASE bar.
43
+ WHEN '1'.
44
+ WHEN 'A' OR '1'.
45
45
  ENDCASE.`,
46
- goodExample: `IF foo = bar OR 1 = a.
47
- ENDIF.
48
- CASE bar.
49
- WHEN '1'.
50
- WHEN 'A'.
46
+ goodExample: `IF foo = bar OR 1 = a.
47
+ ENDIF.
48
+ CASE bar.
49
+ WHEN '1'.
50
+ WHEN 'A'.
51
51
  ENDCASE.`,
52
52
  };
53
53
  }
@@ -21,23 +21,23 @@ class IdenticalContents extends _abap_rule_1.ABAPRule {
21
21
  key: "identical_contents",
22
22
  title: "Identical contents",
23
23
  shortDescription: `Find identical contents in blocks inside IFs, both in the beginning and in the end.`,
24
- extendedInformation: `
25
- Prerequsites: code is pretty printed with identical cAsE
26
-
24
+ extendedInformation: `
25
+ Prerequsites: code is pretty printed with identical cAsE
26
+
27
27
  Chained statments are ignored`,
28
28
  tags: [_irule_1.RuleTag.SingleFile],
29
- badExample: `IF foo = bar.
30
- WRITE 'bar'.
31
- WRITE 'world'.
32
- ELSE.
33
- WRITE 'foo'.
34
- WRITE 'world'.
29
+ badExample: `IF foo = bar.
30
+ WRITE 'bar'.
31
+ WRITE 'world'.
32
+ ELSE.
33
+ WRITE 'foo'.
34
+ WRITE 'world'.
35
35
  ENDIF.`,
36
- goodExample: `IF foo = bar.
37
- WRITE 'bar'.
38
- ELSE.
39
- WRITE 'foo'.
40
- ENDIF.
36
+ goodExample: `IF foo = bar.
37
+ WRITE 'bar'.
38
+ ELSE.
39
+ WRITE 'foo'.
40
+ ENDIF.
41
41
  WRITE 'world'.`,
42
42
  };
43
43
  }
@@ -16,12 +16,12 @@ class IdenticalDescriptions {
16
16
  key: "identical_descriptions",
17
17
  title: "Identical descriptions",
18
18
  shortDescription: `Searches for objects with the same type and same description`,
19
- extendedInformation: `Case insensitive
20
-
21
- Only checks the master language descriptions
22
-
23
- Dependencies are skipped
24
-
19
+ extendedInformation: `Case insensitive
20
+
21
+ Only checks the master language descriptions
22
+
23
+ Dependencies are skipped
24
+
25
25
  Works for: INTF, CLAS, DOMA, DTEL, FUNC in same FUGR`,
26
26
  tags: [],
27
27
  };
@@ -21,43 +21,43 @@ class IfInIf extends _abap_rule_1.ABAPRule {
21
21
  key: "if_in_if",
22
22
  title: "IF in IF",
23
23
  shortDescription: `Detects nested ifs which can be refactored.`,
24
- extendedInformation: `
25
- Directly nested IFs without ELSE can be refactored to a single condition using AND.
26
-
27
- ELSE condtions with directly nested IF refactored to ELSEIF, quickfixes are suggested for this case.
28
-
29
- https://docs.abapopenchecks.org/checks/01/
24
+ extendedInformation: `
25
+ Directly nested IFs without ELSE can be refactored to a single condition using AND.
26
+
27
+ ELSE condtions with directly nested IF refactored to ELSEIF, quickfixes are suggested for this case.
28
+
29
+ https://docs.abapopenchecks.org/checks/01/
30
30
  https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-the-nesting-depth-low`,
31
- badExample: `IF condition1.
32
- IF condition2.
33
- ...
34
- ENDIF.
35
- ENDIF.
36
-
37
- IF condition1.
38
- ...
39
- ELSE.
40
- IF condition2.
41
- ...
42
- ENDIF.
31
+ badExample: `IF condition1.
32
+ IF condition2.
33
+ ...
34
+ ENDIF.
35
+ ENDIF.
36
+
37
+ IF condition1.
38
+ ...
39
+ ELSE.
40
+ IF condition2.
41
+ ...
42
+ ENDIF.
43
43
  ENDIF.`,
44
- goodExample: `IF ( condition1 ) AND ( condition2 ).
45
- ...
46
- ENDIF.
47
-
48
- IF condition1.
49
- ...
50
- ELSEIF condition2.
51
- ...
52
- ENDIF.
53
-
54
- CASE variable.
55
- WHEN value1.
56
- ...
57
- WHEN value2.
58
- IF condition2.
59
- ...
60
- ENDIF.
44
+ goodExample: `IF ( condition1 ) AND ( condition2 ).
45
+ ...
46
+ ENDIF.
47
+
48
+ IF condition1.
49
+ ...
50
+ ELSEIF condition2.
51
+ ...
52
+ ENDIF.
53
+
54
+ CASE variable.
55
+ WHEN value1.
56
+ ...
57
+ WHEN value2.
58
+ IF condition2.
59
+ ...
60
+ ENDIF.
61
61
  ENDCASE.`,
62
62
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
63
63
  };
@@ -102,9 +102,9 @@ class ImplementMethods extends _abap_rule_1.ABAPRule {
102
102
  for (const i of ((_a = file.getStructure()) === null || _a === void 0 ? void 0 : _a.findAllStatements(Statements.ClassImplementation)) || []) {
103
103
  const name = (_b = i.findFirstExpression(Expressions.ClassName)) === null || _b === void 0 ? void 0 : _b.getFirstToken().getStr().toUpperCase();
104
104
  if (name === impl.identifier.getName().toUpperCase()) {
105
- return edit_helper_1.EditHelper.insertAt(file, i.getLastToken().getEnd(), `
106
- METHOD ${methodName.toLowerCase()}.
107
- RETURN. " todo, implement method
105
+ return edit_helper_1.EditHelper.insertAt(file, i.getLastToken().getEnd(), `
106
+ METHOD ${methodName.toLowerCase()}.
107
+ RETURN. " todo, implement method
108
108
  ENDMETHOD.`);
109
109
  }
110
110
  }
@@ -22,14 +22,14 @@ class ImplicitStartOfSelection extends _abap_rule_1.ABAPRule {
22
22
  key: "implicit_start_of_selection",
23
23
  title: "Implicit START-OF-SELECTION",
24
24
  shortDescription: `Add explicit selection screen event handling`,
25
- extendedInformation: `Only runs for executable programs
26
-
25
+ extendedInformation: `Only runs for executable programs
26
+
27
27
  https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapstart-of-selection.htm`,
28
28
  tags: [_irule_1.RuleTag.SingleFile],
29
- badExample: `REPORT zfoo.
29
+ badExample: `REPORT zfoo.
30
30
  WRITE 'hello'.`,
31
- goodExample: `
32
- START-OF-SELECTION.
31
+ goodExample: `
32
+ START-OF-SELECTION.
33
33
  WRITE 'hello'.`,
34
34
  };
35
35
  }
@@ -31,19 +31,19 @@ class InStatementIndentation extends _abap_rule_1.ABAPRule {
31
31
  key: "in_statement_indentation",
32
32
  title: "In-statement indentation",
33
33
  shortDescription: "Checks alignment within statements which span multiple lines.",
34
- extendedInformation: `Lines following the first line should be indented once (2 spaces).
35
-
36
- For block declaration statements, lines after the first should be indented an additional time (default: +2 spaces)
34
+ extendedInformation: `Lines following the first line should be indented once (2 spaces).
35
+
36
+ For block declaration statements, lines after the first should be indented an additional time (default: +2 spaces)
37
37
  to distinguish them better from code within the block.`,
38
- badExample: `IF 1 = 1
39
- AND 2 = 2.
40
- WRITE 'hello' &&
41
- 'world'.
38
+ badExample: `IF 1 = 1
39
+ AND 2 = 2.
40
+ WRITE 'hello' &&
41
+ 'world'.
42
42
  ENDIF.`,
43
- goodExample: `IF 1 = 1
44
- AND 2 = 2.
45
- WRITE 'hello' &&
46
- 'world'.
43
+ goodExample: `IF 1 = 1
44
+ AND 2 = 2.
45
+ WRITE 'hello' &&
46
+ 'world'.
47
47
  ENDIF.`,
48
48
  tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
49
49
  };
@@ -40,23 +40,23 @@ class Indentation extends _abap_rule_1.ABAPRule {
40
40
  title: "Indentation",
41
41
  shortDescription: `Checks indentation`,
42
42
  tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
43
- badExample: `CLASS lcl DEFINITION.
44
- PRIVATE SECTION.
45
- METHODS constructor.
46
- ENDCLASS.
47
-
48
- CLASS lcl IMPLEMENTATION.
49
- METHOD constructor.
50
- ENDMETHOD.
43
+ badExample: `CLASS lcl DEFINITION.
44
+ PRIVATE SECTION.
45
+ METHODS constructor.
46
+ ENDCLASS.
47
+
48
+ CLASS lcl IMPLEMENTATION.
49
+ METHOD constructor.
50
+ ENDMETHOD.
51
51
  ENDCLASS.`,
52
- goodExample: `CLASS lcl DEFINITION.
53
- PRIVATE SECTION.
54
- METHODS constructor.
55
- ENDCLASS.
56
-
57
- CLASS lcl IMPLEMENTATION.
58
- METHOD constructor.
59
- ENDMETHOD.
52
+ goodExample: `CLASS lcl DEFINITION.
53
+ PRIVATE SECTION.
54
+ METHODS constructor.
55
+ ENDCLASS.
56
+
57
+ CLASS lcl IMPLEMENTATION.
58
+ METHOD constructor.
59
+ ENDMETHOD.
60
60
  ENDCLASS.`,
61
61
  };
62
62
  }
@@ -26,9 +26,9 @@ class IntfReferencingClas {
26
26
  key: "intf_referencing_clas",
27
27
  title: "INTF referencing CLAS",
28
28
  shortDescription: `Interface contains references to class`,
29
- extendedInformation: `Only global interfaces are checked.
30
- Only first level references are checked.
31
- Exception class references are ignored.
29
+ extendedInformation: `Only global interfaces are checked.
30
+ Only first level references are checked.
31
+ Exception class references are ignored.
32
32
  Void references are ignored.`,
33
33
  };
34
34
  }
@@ -22,9 +22,9 @@ class InvalidTableIndex extends _abap_rule_1.ABAPRule {
22
22
  title: "Invalid Table Index",
23
23
  shortDescription: `Issues error for constant table index zero, as ABAP starts from 1`,
24
24
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
25
- badExample: `DATA(first) = table[ 0 ].
25
+ badExample: `DATA(first) = table[ 0 ].
26
26
  READ TABLE gt_stack ASSIGNING <ls_stack> INDEX 0.`,
27
- goodExample: `DATA(first) = table[ 1 ].
27
+ goodExample: `DATA(first) = table[ 1 ].
28
28
  READ TABLE gt_stack ASSIGNING <ls_stack> INDEX 1.`,
29
29
  };
30
30
  }
@@ -15,8 +15,8 @@ class LineBreakStyle {
15
15
  return {
16
16
  key: "line_break_style",
17
17
  title: "Makes sure line breaks are consistent in the ABAP code",
18
- shortDescription: `Enforces LF as newlines in ABAP files
19
-
18
+ shortDescription: `Enforces LF as newlines in ABAP files
19
+
20
20
  abapGit does not work with CRLF`,
21
21
  tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.SingleFile],
22
22
  };
@@ -23,7 +23,7 @@ class LineLength extends _abap_rule_1.ABAPRule {
23
23
  key: "line_length",
24
24
  title: "Line length",
25
25
  shortDescription: `Detects lines exceeding the provided maximum length.`,
26
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#stick-to-a-reasonable-line-length
26
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#stick-to-a-reasonable-line-length
27
27
  https://docs.abapopenchecks.org/checks/04/`,
28
28
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
29
29
  };
@@ -27,7 +27,7 @@ class LineOnlyPunc extends _abap_rule_1.ABAPRule {
27
27
  key: "line_only_punc",
28
28
  title: "Line containing only punctuation",
29
29
  shortDescription: `Detects lines containing only punctuation.`,
30
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#close-brackets-at-line-end
30
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#close-brackets-at-line-end
31
31
  https://docs.abapopenchecks.org/checks/16/`,
32
32
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
33
33
  badExample: "zcl_class=>method(\n).",
@@ -30,15 +30,15 @@ class LocalVariableNames extends _abap_rule_1.ABAPRule {
30
30
  return {
31
31
  key: "local_variable_names",
32
32
  title: "Local variable naming conventions",
33
- shortDescription: `
34
- Allows you to enforce a pattern, such as a prefix, for local variables, constants and field symbols.
33
+ shortDescription: `
34
+ Allows you to enforce a pattern, such as a prefix, for local variables, constants and field symbols.
35
35
  Regexes are case-insensitive.`,
36
36
  tags: [_irule_1.RuleTag.Naming, _irule_1.RuleTag.SingleFile],
37
- badExample: `FORM bar.
38
- DATA foo.
37
+ badExample: `FORM bar.
38
+ DATA foo.
39
39
  ENDFORM.`,
40
- goodExample: `FORM bar.
41
- DATA lv_foo.
40
+ goodExample: `FORM bar.
41
+ DATA lv_foo.
42
42
  ENDFORM.`,
43
43
  };
44
44
  }
@@ -28,9 +28,9 @@ class MacroNaming extends _abap_rule_1.ABAPRule {
28
28
  shortDescription: `Allows you to enforce a pattern for macro definitions`,
29
29
  extendedInformation: `Use rule "avoid_use" to avoid macros altogether.`,
30
30
  tags: [_irule_1.RuleTag.Naming, _irule_1.RuleTag.SingleFile],
31
- badExample: `DEFINE something.
31
+ badExample: `DEFINE something.
32
32
  END-OF-DEFINITION.`,
33
- goodExample: `DEFINE _something.
33
+ goodExample: `DEFINE _something.
34
34
  END-OF-DEFINITION.`,
35
35
  };
36
36
  }
@@ -22,10 +22,10 @@ class MainFileContents {
22
22
  key: "main_file_contents",
23
23
  title: "Main file contents",
24
24
  shortDescription: `Checks related to report declarations.`,
25
- extendedInformation: `Does not run if the target version is Cloud
26
-
27
- * PROGs must begin with "REPORT <name>." or "PROGRAM <name>.
28
- * TYPEs must begin with "TYPE-POOL <name>."
25
+ extendedInformation: `Does not run if the target version is Cloud
26
+
27
+ * PROGs must begin with "REPORT <name>." or "PROGRAM <name>.
28
+ * TYPEs must begin with "TYPE-POOL <name>."
29
29
  `,
30
30
  };
31
31
  }
@@ -23,17 +23,17 @@ class ManyParentheses extends _abap_rule_1.ABAPRule {
23
23
  title: "Too many parentheses",
24
24
  shortDescription: `Searches for expressions where extra parentheses can safely be removed`,
25
25
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
26
- badExample: `
27
- IF ( destination IS INITIAL ).
28
- ENDIF.
29
- IF foo = boo AND ( bar = lar AND moo = loo ).
30
- ENDIF.
26
+ badExample: `
27
+ IF ( destination IS INITIAL ).
28
+ ENDIF.
29
+ IF foo = boo AND ( bar = lar AND moo = loo ).
30
+ ENDIF.
31
31
  `,
32
- goodExample: `
33
- IF destination IS INITIAL.
34
- ENDIF.
35
- IF foo = boo AND bar = lar AND moo = loo.
36
- ENDIF.
32
+ goodExample: `
33
+ IF destination IS INITIAL.
34
+ ENDIF.
35
+ IF foo = boo AND bar = lar AND moo = loo.
36
+ ENDIF.
37
37
  `,
38
38
  };
39
39
  }
@@ -21,14 +21,14 @@ class MaxOneMethodParameterPerLine extends _abap_rule_1.ABAPRule {
21
21
  title: "Max one method parameter definition per line",
22
22
  shortDescription: `Keep max one method parameter description per line`,
23
23
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace],
24
- badExample: `
25
- METHODS apps_scope_token
26
- IMPORTING
24
+ badExample: `
25
+ METHODS apps_scope_token
26
+ IMPORTING
27
27
  body TYPE bodyapps_scope_token client_id TYPE str.`,
28
- goodExample: `
29
- METHODS apps_scope_token
30
- IMPORTING
31
- body TYPE bodyapps_scope_token
28
+ goodExample: `
29
+ METHODS apps_scope_token
30
+ IMPORTING
31
+ body TYPE bodyapps_scope_token
32
32
  client_id TYPE str.`,
33
33
  };
34
34
  }
@@ -21,11 +21,11 @@ class MaxOneStatement extends _abap_rule_1.ABAPRule {
21
21
  key: "max_one_statement",
22
22
  title: "Max one statement per line",
23
23
  shortDescription: `Checks that each line contains only a single statement.`,
24
- extendedInformation: `Does not report empty statements, use rule empty_statement for detecting empty statements.
25
-
26
- Does not report anything for chained statements.
27
-
28
- https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#no-more-than-one-statement-per-line
24
+ extendedInformation: `Does not report empty statements, use rule empty_statement for detecting empty statements.
25
+
26
+ Does not report anything for chained statements.
27
+
28
+ https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#no-more-than-one-statement-per-line
29
29
  https://docs.abapopenchecks.org/checks/11/`,
30
30
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
31
31
  badExample: `WRITE foo. WRITE bar.`,
@@ -35,8 +35,8 @@ class MethodLength {
35
35
  key: "method_length",
36
36
  title: "Method/Form Length",
37
37
  shortDescription: `Checks relating to method/form length.`,
38
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-methods-small
39
-
38
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-methods-small
39
+
40
40
  Abstract methods without statements are considered okay.`,
41
41
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
42
42
  };