@abaplint/core 2.113.15 → 2.113.17

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 (111) hide show
  1. package/README.md +6 -6
  2. package/build/src/abap/flow/flow_graph.js +7 -7
  3. package/build/src/lsp/help.js +7 -7
  4. package/build/src/registry.js +1 -1
  5. package/build/src/rules/7bit_ascii.js +4 -4
  6. package/build/src/rules/abapdoc.js +4 -4
  7. package/build/src/rules/add_test_attributes.js +20 -20
  8. package/build/src/rules/align_parameters.js +40 -40
  9. package/build/src/rules/align_type_expressions.js +28 -28
  10. package/build/src/rules/ambiguous_statement.js +7 -7
  11. package/build/src/rules/avoid_use.js +10 -10
  12. package/build/src/rules/begin_end_names.js +4 -4
  13. package/build/src/rules/begin_single_include.js +13 -13
  14. package/build/src/rules/call_transaction_authority_check.js +3 -3
  15. package/build/src/rules/cds_comment_style.js +4 -4
  16. package/build/src/rules/cds_legacy_view.js +4 -4
  17. package/build/src/rules/chain_mainly_declarations.js +4 -4
  18. package/build/src/rules/change_if_to_case.js +8 -8
  19. package/build/src/rules/check_abstract.js +2 -2
  20. package/build/src/rules/check_comments.js +4 -4
  21. package/build/src/rules/check_include.js +3 -3
  22. package/build/src/rules/check_subrc.js +8 -8
  23. package/build/src/rules/classic_exceptions_overlap.js +10 -10
  24. package/build/src/rules/commented_code.js +1 -1
  25. package/build/src/rules/constructor_visibility_public.js +4 -4
  26. package/build/src/rules/contains_tab.js +2 -2
  27. package/build/src/rules/cyclic_oo.js +4 -4
  28. package/build/src/rules/dangerous_statement.js +1 -1
  29. package/build/src/rules/definitions_top.js +6 -6
  30. package/build/src/rules/downport.js +102 -87
  31. package/build/src/rules/easy_to_find_messages.js +6 -6
  32. package/build/src/rules/empty_event.js +6 -6
  33. package/build/src/rules/empty_line_in_statement.js +2 -2
  34. package/build/src/rules/empty_structure.js +6 -6
  35. package/build/src/rules/exit_or_check.js +3 -3
  36. package/build/src/rules/expand_macros.js +5 -5
  37. package/build/src/rules/exporting.js +1 -1
  38. package/build/src/rules/forbidden_identifier.js +1 -1
  39. package/build/src/rules/forbidden_void_type.js +2 -2
  40. package/build/src/rules/fully_type_itabs.js +1 -1
  41. package/build/src/rules/functional_writing.js +17 -17
  42. package/build/src/rules/global_class.js +8 -8
  43. package/build/src/rules/identical_conditions.js +12 -12
  44. package/build/src/rules/identical_contents.js +14 -14
  45. package/build/src/rules/identical_descriptions.js +6 -6
  46. package/build/src/rules/if_in_if.js +35 -35
  47. package/build/src/rules/implement_methods.js +3 -3
  48. package/build/src/rules/implicit_start_of_selection.js +5 -5
  49. package/build/src/rules/in_statement_indentation.js +11 -11
  50. package/build/src/rules/indentation.js +16 -16
  51. package/build/src/rules/intf_referencing_clas.js +3 -3
  52. package/build/src/rules/invalid_table_index.js +2 -2
  53. package/build/src/rules/line_break_style.js +2 -2
  54. package/build/src/rules/line_length.js +1 -1
  55. package/build/src/rules/line_only_punc.js +1 -1
  56. package/build/src/rules/local_variable_names.js +6 -6
  57. package/build/src/rules/macro_naming.js +2 -2
  58. package/build/src/rules/main_file_contents.js +4 -4
  59. package/build/src/rules/many_parentheses.js +10 -10
  60. package/build/src/rules/max_one_method_parameter_per_line.js +7 -7
  61. package/build/src/rules/max_one_statement.js +5 -5
  62. package/build/src/rules/method_length.js +2 -2
  63. package/build/src/rules/method_overwrites_builtin.js +12 -12
  64. package/build/src/rules/mix_returning.js +6 -6
  65. package/build/src/rules/nesting.js +1 -1
  66. package/build/src/rules/no_chained_assignment.js +1 -1
  67. package/build/src/rules/no_external_form_calls.js +2 -2
  68. package/build/src/rules/no_inline_in_optional_branches.js +11 -11
  69. package/build/src/rules/no_prefixes.js +6 -6
  70. package/build/src/rules/no_public_attributes.js +1 -1
  71. package/build/src/rules/no_yoda_conditions.js +4 -4
  72. package/build/src/rules/nrob_consistency.js +2 -2
  73. package/build/src/rules/obsolete_statement.js +51 -51
  74. package/build/src/rules/omit_parameter_name.js +3 -3
  75. package/build/src/rules/omit_receiving.js +13 -13
  76. package/build/src/rules/parser_702_chaining.js +2 -2
  77. package/build/src/rules/parser_error.js +2 -2
  78. package/build/src/rules/parser_missing_space.js +1 -1
  79. package/build/src/rules/prefer_inline.js +16 -16
  80. package/build/src/rules/prefer_is_not.js +9 -9
  81. package/build/src/rules/prefer_raise_exception_new.js +5 -5
  82. package/build/src/rules/prefer_returning_to_exporting.js +4 -4
  83. package/build/src/rules/prefer_xsdbool.js +2 -2
  84. package/build/src/rules/preferred_compare_operator.js +2 -2
  85. package/build/src/rules/reduce_procedural_code.js +17 -17
  86. package/build/src/rules/remove_descriptions.js +4 -4
  87. package/build/src/rules/rfc_error_handling.js +7 -7
  88. package/build/src/rules/select_add_order_by.js +5 -5
  89. package/build/src/rules/select_performance.js +5 -5
  90. package/build/src/rules/select_single_full_key.js +2 -2
  91. package/build/src/rules/sicf_consistency.js +2 -2
  92. package/build/src/rules/slow_parameter_passing.js +16 -16
  93. package/build/src/rules/space_before_dot.js +2 -2
  94. package/build/src/rules/sql_value_conversion.js +6 -6
  95. package/build/src/rules/start_at_tab.js +1 -1
  96. package/build/src/rules/strict_sql.js +6 -6
  97. package/build/src/rules/sy_modification.js +3 -3
  98. package/build/src/rules/tabl_enhancement_category.js +2 -2
  99. package/build/src/rules/tables_declared_locally.js +2 -2
  100. package/build/src/rules/type_form_parameters.js +2 -2
  101. package/build/src/rules/unnecessary_pragma.js +29 -29
  102. package/build/src/rules/unnecessary_return.js +11 -11
  103. package/build/src/rules/unused_macros.js +6 -6
  104. package/build/src/rules/unused_methods.js +12 -12
  105. package/build/src/rules/unused_variables.js +12 -12
  106. package/build/src/rules/use_bool_expression.js +8 -8
  107. package/build/src/rules/use_class_based_exceptions.js +8 -8
  108. package/build/src/rules/use_line_exists.js +6 -6
  109. package/build/src/rules/use_new.js +4 -4
  110. package/build/src/rules/when_others_last.js +6 -6
  111. package/package.json +70 -70
@@ -32,10 +32,10 @@ class CyclicOO {
32
32
  key: "cyclic_oo",
33
33
  title: "Cyclic OO",
34
34
  shortDescription: `Finds cyclic/circular OO references`,
35
- extendedInformation: `Runs for global INTF + CLAS objects
36
-
37
- Objects must be without syntax errors for this rule to take effect
38
-
35
+ extendedInformation: `Runs for global INTF + CLAS objects
36
+
37
+ Objects must be without syntax errors for this rule to take effect
38
+
39
39
  References in testclass includes are ignored`,
40
40
  };
41
41
  }
@@ -41,7 +41,7 @@ class DangerousStatement extends _abap_rule_1.ABAPRule {
41
41
  key: "dangerous_statement",
42
42
  title: "Dangerous statement",
43
43
  shortDescription: `Detects potentially dangerous statements`,
44
- extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
44
+ extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
45
45
  dynamic SQL can potentially create SQL injection problems`,
46
46
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
47
47
  };
@@ -30,13 +30,13 @@ class DefinitionsTop extends _abap_rule_1.ABAPRule {
30
30
  shortDescription: `Checks that definitions are placed at the beginning of METHODs, FORMs and FUNCTIONs.`,
31
31
  extendedInformation: `https://docs.abapopenchecks.org/checks/17/`,
32
32
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
33
- badExample: `FROM foo.
34
- WRITE 'hello'.
35
- DATA int TYPE i.
33
+ badExample: `FROM foo.
34
+ WRITE 'hello'.
35
+ DATA int TYPE i.
36
36
  ENDFORM.`,
37
- goodExample: `FROM foo.
38
- DATA int TYPE i.
39
- WRITE 'hello'.
37
+ goodExample: `FROM foo.
38
+ DATA int TYPE i.
39
+ WRITE 'hello'.
40
40
  ENDFORM.`,
41
41
  };
42
42
  }
@@ -125,39 +125,39 @@ class Downport {
125
125
  key: "downport",
126
126
  title: "Downport statement",
127
127
  shortDescription: `Downport functionality`,
128
- extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
129
- a higher level language version. If successful, various rules are applied to downport the statement.
130
- Target downport version is always v702, thus rule is only enabled if target version is v702.
131
-
132
- Current rules:
133
- * NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
134
- * DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
135
- * FIELD-SYMBOL() definitions are outlined
136
- * CONV is outlined
137
- * COND is outlined
138
- * REDUCE is outlined
139
- * SWITCH is outlined
140
- * FILTER is outlined
141
- * APPEND expression is outlined
142
- * INSERT expression is outlined
143
- * EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
144
- * CAST changed to ?=
145
- * LOOP AT method_call( ) is outlined
146
- * VALUE # with structure fields
147
- * VALUE # with internal table lines
148
- * Table Expressions are outlined
149
- * SELECT INTO @DATA definitions are outlined
150
- * Some occurrences of string template formatting option ALPHA changed to function module call
151
- * SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
152
- * PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
153
- * RAISE EXCEPTION ... MESSAGE
154
- * Moving with +=, -=, /=, *=, &&= is expanded
155
- * line_exists and line_index is downported to READ TABLE
156
- * ENUMs, but does not nessesarily give the correct type and value
157
- * MESSAGE with non simple source
158
-
159
- Only one transformation is applied to a statement at a time, so multiple steps might be required to do the full downport.
160
-
128
+ extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
129
+ a higher level language version. If successful, various rules are applied to downport the statement.
130
+ Target downport version is always v702, thus rule is only enabled if target version is v702.
131
+
132
+ Current rules:
133
+ * NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
134
+ * DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
135
+ * FIELD-SYMBOL() definitions are outlined
136
+ * CONV is outlined
137
+ * COND is outlined
138
+ * REDUCE is outlined
139
+ * SWITCH is outlined
140
+ * FILTER is outlined
141
+ * APPEND expression is outlined
142
+ * INSERT expression is outlined
143
+ * EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
144
+ * CAST changed to ?=
145
+ * LOOP AT method_call( ) is outlined
146
+ * VALUE # with structure fields
147
+ * VALUE # with internal table lines
148
+ * Table Expressions are outlined
149
+ * SELECT INTO @DATA definitions are outlined
150
+ * Some occurrences of string template formatting option ALPHA changed to function module call
151
+ * SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
152
+ * PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
153
+ * RAISE EXCEPTION ... MESSAGE
154
+ * Moving with +=, -=, /=, *=, &&= is expanded
155
+ * line_exists and line_index is downported to READ TABLE
156
+ * ENUMs, but does not nessesarily give the correct type and value
157
+ * MESSAGE with non simple source
158
+
159
+ Only one transformation is applied to a statement at a time, so multiple steps might be required to do the full downport.
160
+
161
161
  Make sure to test the downported code, it might not always be completely correct.`,
162
162
  tags: [_irule_1.RuleTag.Downport, _irule_1.RuleTag.Quickfix],
163
163
  };
@@ -735,17 +735,17 @@ Make sure to test the downported code, it might not always be completely correct
735
735
  const fieldName = f.concatTokens();
736
736
  fieldDefinition += indentation + " " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
737
737
  }
738
- fieldDefinition = `DATA: BEGIN OF ${name},
738
+ fieldDefinition = `DATA: BEGIN OF ${name},
739
739
  ${fieldDefinition}${indentation} END OF ${name}.`;
740
740
  }
741
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
741
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
742
742
  ${indentation}`);
743
743
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
744
744
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
745
745
  return issue_1.Issue.atToken(lowFile, inlineData.getFirstToken(), "Outline SELECT @DATA", this.getMetadata().key, this.conf.severity, fix);
746
746
  }
747
747
  downportSelectTableInline(low, high, lowFile, highSyntax) {
748
- var _a, _b, _c;
748
+ var _a, _b, _c, _d, _e, _f, _g;
749
749
  if (!(low.get() instanceof _statement_1.Unknown)) {
750
750
  return undefined;
751
751
  }
@@ -766,28 +766,43 @@ ${indentation}`);
766
766
  if (tableName === undefined) {
767
767
  return undefined;
768
768
  }
769
+ const tableMap = {};
770
+ for (const from of sqlFrom) {
771
+ const dbName = (_c = from.findDirectExpression(Expressions.DatabaseTable)) === null || _c === void 0 ? void 0 : _c.concatTokens().toUpperCase();
772
+ if (dbName === undefined) {
773
+ continue;
774
+ }
775
+ const asName = ((_d = from.findDirectExpression(Expressions.SQLAsName)) === null || _d === void 0 ? void 0 : _d.concatTokens().toUpperCase()) || dbName;
776
+ tableMap[asName] = dbName;
777
+ }
769
778
  const fieldList = high.findFirstExpression(Expressions.SQLFieldList);
770
779
  if (fieldList === undefined) {
771
780
  return undefined;
772
781
  }
773
782
  let fieldDefinitions = "";
774
- for (const f of fieldList.findAllExpressions(Expressions.SQLFieldName)) {
775
- let fieldName = f.concatTokens();
783
+ for (const f of fieldList.findAllExpressions(Expressions.SQLField)) {
784
+ let fieldName = (_e = f.findFirstExpression(Expressions.SQLFieldName)) === null || _e === void 0 ? void 0 : _e.concatTokens();
785
+ if (fieldName === undefined) {
786
+ continue;
787
+ }
776
788
  if (fieldName.includes("~")) {
777
789
  const split = fieldName.split("~");
778
790
  tableName = split[0];
779
791
  fieldName = split[1];
780
792
  }
781
- fieldDefinitions += indentation + " " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
793
+ const translated = tableMap[tableName.toUpperCase()];
794
+ const typeName = translated + "-" + fieldName;
795
+ fieldName = ((_f = f.findFirstExpression(Expressions.SQLAsName)) === null || _f === void 0 ? void 0 : _f.concatTokens()) || fieldName;
796
+ fieldDefinitions += indentation + " " + fieldName + " TYPE " + typeName.toLowerCase() + ",\n";
782
797
  }
783
798
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
784
- const name = ((_c = inlineData.findFirstExpression(Expressions.TargetField)) === null || _c === void 0 ? void 0 : _c.concatTokens()) || "error";
785
- let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
786
- ${fieldDefinitions}${indentation} END OF ${uniqueName}.
787
- ${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
799
+ const name = ((_g = inlineData.findFirstExpression(Expressions.TargetField)) === null || _g === void 0 ? void 0 : _g.concatTokens()) || "error";
800
+ let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
801
+ ${fieldDefinitions}${indentation} END OF ${uniqueName}.
802
+ ${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
788
803
  ${indentation}`);
789
804
  if (fieldDefinitions === "") {
790
- fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
805
+ fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
791
806
  ${indentation}`);
792
807
  }
793
808
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
@@ -855,7 +870,7 @@ ${indentation}`);
855
870
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
856
871
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
857
872
  const firstToken = high.getFirstToken();
858
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
873
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
859
874
  ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
860
875
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
861
876
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -909,7 +924,7 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
909
924
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
910
925
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
911
926
  const firstToken = high.getFirstToken();
912
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
927
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
913
928
  ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
914
929
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
915
930
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -951,14 +966,14 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
951
966
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
952
967
  const firstToken = high.getFirstToken();
953
968
  // note that the tabix restore should be done before throwing the exception
954
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
955
- ${indentation}DATA ${tabixBackup} LIKE sy-tabix.
956
- ${indentation}${tabixBackup} = sy-tabix.
957
- ${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
958
- ${indentation}sy-tabix = ${tabixBackup}.
959
- ${indentation}IF sy-subrc <> 0.
960
- ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
961
- ${indentation}ENDIF.
969
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
970
+ ${indentation}DATA ${tabixBackup} LIKE sy-tabix.
971
+ ${indentation}${tabixBackup} = sy-tabix.
972
+ ${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
973
+ ${indentation}sy-tabix = ${tabixBackup}.
974
+ ${indentation}IF sy-subrc <> 0.
975
+ ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
976
+ ${indentation}ENDIF.
962
977
  ${indentation}`);
963
978
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, startToken.getStart(), tableExpression.getLastToken().getEnd(), uniqueName);
964
979
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -1015,7 +1030,7 @@ ${indentation}`);
1015
1030
  const className = classNames[0].concatTokens();
1016
1031
  const targetName = (_b = target.findFirstExpression(Expressions.TargetField)) === null || _b === void 0 ? void 0 : _b.concatTokens();
1017
1032
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
1018
- const code = ` DATA ${targetName} TYPE REF TO ${className}.
1033
+ const code = ` DATA ${targetName} TYPE REF TO ${className}.
1019
1034
  ${indentation}CATCH ${className} INTO ${targetName}.`;
1020
1035
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getStart(), node.getEnd(), code);
1021
1036
  return issue_1.Issue.atToken(lowFile, node.getFirstToken(), "Outline DATA", this.getMetadata().key, this.conf.severity, fix);
@@ -1177,16 +1192,16 @@ ${indentation}CATCH ${className} INTO ${targetName}.`;
1177
1192
  const uniqueName1 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
1178
1193
  const uniqueName2 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
1179
1194
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
1180
- let abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
1181
- ${indentation}${uniqueName1}-msgid = ${id}.
1195
+ let abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
1196
+ ${indentation}${uniqueName1}-msgid = ${id}.
1182
1197
  ${indentation}${uniqueName1}-msgno = ${number}.\n`;
1183
1198
  if (withs.length > 0) {
1184
- abap += `${indentation}${uniqueName1}-attr1 = 'IF_T100_DYN_MSG~MSGV1'.
1185
- ${indentation}${uniqueName1}-attr2 = 'IF_T100_DYN_MSG~MSGV2'.
1186
- ${indentation}${uniqueName1}-attr3 = 'IF_T100_DYN_MSG~MSGV3'.
1199
+ abap += `${indentation}${uniqueName1}-attr1 = 'IF_T100_DYN_MSG~MSGV1'.
1200
+ ${indentation}${uniqueName1}-attr2 = 'IF_T100_DYN_MSG~MSGV2'.
1201
+ ${indentation}${uniqueName1}-attr3 = 'IF_T100_DYN_MSG~MSGV3'.
1187
1202
  ${indentation}${uniqueName1}-attr4 = 'IF_T100_DYN_MSG~MSGV4'.\n`;
1188
1203
  }
1189
- abap += `${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
1204
+ abap += `${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
1190
1205
  ${indentation}CREATE OBJECT ${uniqueName2} EXPORTING textid = ${uniqueName1}.\n`;
1191
1206
  if (withs.length > 0) {
1192
1207
  abap += `${indentation}${uniqueName2}->if_t100_dyn_msg~msgty = 'E'.\n`;
@@ -1298,10 +1313,10 @@ ${indentation}CREATE OBJECT ${uniqueName2} EXPORTING textid = ${uniqueName1}.\n`
1298
1313
  let code = "";
1299
1314
  if (sourceRef.findFirstExpression(Expressions.TableExpression)) {
1300
1315
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
1301
- code = `ASSIGN ${sourceRef.concatTokens()} TO FIELD-SYMBOL(<${uniqueName}>).
1302
- IF sy-subrc <> 0.
1303
- RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
1304
- ENDIF.
1316
+ code = `ASSIGN ${sourceRef.concatTokens()} TO FIELD-SYMBOL(<${uniqueName}>).
1317
+ IF sy-subrc <> 0.
1318
+ RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
1319
+ ENDIF.
1305
1320
  GET REFERENCE OF <${uniqueName}> INTO ${target.concatTokens()}`;
1306
1321
  }
1307
1322
  else {
@@ -1390,20 +1405,20 @@ GET REFERENCE OF <${uniqueName}> INTO ${target.concatTokens()}`;
1390
1405
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
1391
1406
  const uniqueFS = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
1392
1407
  const uniqueNameIndex = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
1393
- code += ` items LIKE ${loopSourceName},
1394
- END OF ${groupTargetName}type.
1395
- DATA ${groupTargetName}tab TYPE STANDARD TABLE OF ${groupTargetName}type WITH DEFAULT KEY.
1396
- DATA ${uniqueName} LIKE LINE OF ${groupTargetName}tab.
1408
+ code += ` items LIKE ${loopSourceName},
1409
+ END OF ${groupTargetName}type.
1410
+ DATA ${groupTargetName}tab TYPE STANDARD TABLE OF ${groupTargetName}type WITH DEFAULT KEY.
1411
+ DATA ${uniqueName} LIKE LINE OF ${groupTargetName}tab.
1397
1412
  LOOP AT ${loopSourceName} ${(_l = high.findFirstExpression(Expressions.LoopTarget)) === null || _l === void 0 ? void 0 : _l.concatTokens()}.\n`;
1398
1413
  if (groupIndexName !== undefined) {
1399
1414
  code += `DATA(${uniqueNameIndex}) = sy-tabix.\n`;
1400
1415
  }
1401
- code += `READ TABLE ${groupTargetName}tab ASSIGNING FIELD-SYMBOL(<${uniqueFS}>) WITH KEY ${condition}.
1416
+ code += `READ TABLE ${groupTargetName}tab ASSIGNING FIELD-SYMBOL(<${uniqueFS}>) WITH KEY ${condition}.
1402
1417
  IF sy-subrc = 0.\n`;
1403
1418
  if (groupCountName !== undefined) {
1404
1419
  code += ` <${uniqueFS}>-${groupCountName} = <${uniqueFS}>-${groupCountName} + 1.\n`;
1405
1420
  }
1406
- code += ` INSERT ${loopTargetName}${isReference ? "->*" : ""} INTO TABLE <${uniqueFS}>-items.
1421
+ code += ` INSERT ${loopTargetName}${isReference ? "->*" : ""} INTO TABLE <${uniqueFS}>-items.
1407
1422
  ELSE.\n`;
1408
1423
  code += ` CLEAR ${uniqueName}.\n`;
1409
1424
  for (const c of group.findAllExpressions(Expressions.LoopGroupByComponent)) {
@@ -1424,8 +1439,8 @@ ELSE.\n`;
1424
1439
  }
1425
1440
  code += ` INSERT ${loopTargetName}${isReference ? "->*" : ""} INTO TABLE ${uniqueName}-items.\n`;
1426
1441
  code += ` INSERT ${uniqueName} INTO TABLE ${groupTargetName}tab.\n`;
1427
- code += `ENDIF.
1428
- ENDLOOP.
1442
+ code += `ENDIF.
1443
+ ENDLOOP.
1429
1444
  LOOP AT ${groupTargetName}tab ${groupTarget}.`;
1430
1445
  let fix = edit_helper_1.EditHelper.replaceRange(lowFile, high.getFirstToken().getStart(), high.getLastToken().getEnd(), code);
1431
1446
  for (const l of ((_m = highFile.getStructure()) === null || _m === void 0 ? void 0 : _m.findAllStructures(Structures.Loop)) || []) {
@@ -1597,7 +1612,7 @@ LOOP AT ${groupTargetName}tab ${groupTarget}.`;
1597
1612
  const enumName = (_b = high.findExpressionAfterToken("ENUM")) === null || _b === void 0 ? void 0 : _b.concatTokens();
1598
1613
  const structureName = (_c = high.findExpressionAfterToken("STRUCTURE")) === null || _c === void 0 ? void 0 : _c.concatTokens();
1599
1614
  // all ENUMS are char like?
1600
- let code = `TYPES ${enumName} TYPE string.
1615
+ let code = `TYPES ${enumName} TYPE string.
1601
1616
  CONSTANTS: BEGIN OF ${structureName},\n`;
1602
1617
  let count = 1;
1603
1618
  for (const e of enumStructure.findDirectStatements(Statements.TypeEnum).concat(enumStructure.findDirectStatements(Statements.Type))) {
@@ -1641,14 +1656,14 @@ CONSTANTS: BEGIN OF ${structureName},\n`;
1641
1656
  const tabixBackup = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
1642
1657
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
1643
1658
  // restore tabix before exeption
1644
- const code = `FIELD-SYMBOLS ${uniqueName} LIKE LINE OF ${tName}.
1645
- ${indentation}DATA ${tabixBackup} LIKE sy-tabix.
1646
- ${indentation}${tabixBackup} = sy-tabix.
1647
- ${indentation}READ TABLE ${tName} ${condition}ASSIGNING ${uniqueName}.
1648
- ${indentation}sy-tabix = ${tabixBackup}.
1649
- ${indentation}IF sy-subrc <> 0.
1650
- ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
1651
- ${indentation}ENDIF.
1659
+ const code = `FIELD-SYMBOLS ${uniqueName} LIKE LINE OF ${tName}.
1660
+ ${indentation}DATA ${tabixBackup} LIKE sy-tabix.
1661
+ ${indentation}${tabixBackup} = sy-tabix.
1662
+ ${indentation}READ TABLE ${tName} ${condition}ASSIGNING ${uniqueName}.
1663
+ ${indentation}sy-tabix = ${tabixBackup}.
1664
+ ${indentation}IF sy-subrc <> 0.
1665
+ ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
1666
+ ${indentation}ENDIF.
1652
1667
  ${indentation}${uniqueName}`;
1653
1668
  const start = target.getFirstToken().getStart();
1654
1669
  const end = (_a = tableExpression.findDirectTokenByText("]")) === null || _a === void 0 ? void 0 : _a.getEnd();
@@ -1732,11 +1747,11 @@ ${indentation}${uniqueName}`;
1732
1747
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
1733
1748
  const source = (_b = templateSource === null || templateSource === void 0 ? void 0 : templateSource.findDirectExpression(Expressions.Source)) === null || _b === void 0 ? void 0 : _b.concatTokens();
1734
1749
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
1735
- const code = `DATA ${uniqueName} TYPE string.
1736
- ${indentation}CALL FUNCTION '${functionName}'
1737
- ${indentation} EXPORTING
1738
- ${indentation} input = ${source}
1739
- ${indentation} IMPORTING
1750
+ const code = `DATA ${uniqueName} TYPE string.
1751
+ ${indentation}CALL FUNCTION '${functionName}'
1752
+ ${indentation} EXPORTING
1753
+ ${indentation} input = ${source}
1754
+ ${indentation} IMPORTING
1740
1755
  ${indentation} output = ${uniqueName}.\n`;
1741
1756
  const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getFirstToken().getStart(), code);
1742
1757
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, child.getFirstToken().getStart(), child.getLastToken().getEnd(), uniqueName);
@@ -19,12 +19,12 @@ class EasyToFindMessages {
19
19
  key: "easy_to_find_messages",
20
20
  title: "Easy to find messages",
21
21
  shortDescription: `Make messages easy to find`,
22
- extendedInformation: `All messages must be statically referenced exactly once
23
-
24
- Only MESSAGE and RAISE statments are counted as static references
25
-
26
- Also see rule "message_exists"
27
-
22
+ extendedInformation: `All messages must be statically referenced exactly once
23
+
24
+ Only MESSAGE and RAISE statments are counted as static references
25
+
26
+ Also see rule "message_exists"
27
+
28
28
  https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#make-messages-easy-to-find`,
29
29
  tags: [_irule_1.RuleTag.Styleguide],
30
30
  };
@@ -23,13 +23,13 @@ class EmptyEvent extends _abap_rule_1.ABAPRule {
23
23
  shortDescription: `Empty selection screen or list processing event block`,
24
24
  extendedInformation: ``,
25
25
  tags: [_irule_1.RuleTag.SingleFile],
26
- badExample: `
27
- INITIALIZATION.
28
- WRITE 'hello'.
26
+ badExample: `
27
+ INITIALIZATION.
28
+ WRITE 'hello'.
29
29
  END-OF-SELECTION.`,
30
- goodExample: `
31
- START-OF-SELECTION.
32
- PERFORM sdf.
30
+ goodExample: `
31
+ START-OF-SELECTION.
32
+ PERFORM sdf.
33
33
  COMMIT WORK.`,
34
34
  };
35
35
  }
@@ -27,8 +27,8 @@ class EmptyLineinStatement extends _abap_rule_1.ABAPRule {
27
27
  key: "empty_line_in_statement",
28
28
  title: "Find empty lines in statements",
29
29
  shortDescription: `Checks that statements do not contain empty lines.`,
30
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-obsess-with-separating-blank-lines
31
-
30
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-obsess-with-separating-blank-lines
31
+
32
32
  https://docs.abapopenchecks.org/checks/41/`,
33
33
  tags: [_irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
34
34
  badExample: `WRITE\n\nhello.`,
@@ -46,13 +46,13 @@ class EmptyStructure extends _abap_rule_1.ABAPRule {
46
46
  shortDescription: `Checks that the code does not contain empty blocks.`,
47
47
  extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#no-empty-if-branches`,
48
48
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
49
- badExample: `IF foo = bar.
50
- ENDIF.
51
-
52
- DO 2 TIMES.
49
+ badExample: `IF foo = bar.
50
+ ENDIF.
51
+
52
+ DO 2 TIMES.
53
53
  ENDDO.`,
54
- goodExample: `LOOP AT itab WHERE qty = 0 OR date > sy-datum.
55
- ENDLOOP.
54
+ goodExample: `LOOP AT itab WHERE qty = 0 OR date > sy-datum.
55
+ ENDLOOP.
56
56
  result = xsdbool( sy-subrc = 0 ).`,
57
57
  };
58
58
  }
@@ -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,7 +20,7 @@ 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
- badExample: `DATA lt_foo TYPE TABLE OF ty.
23
+ badExample: `DATA lt_foo TYPE TABLE OF ty.
24
24
  DATA lt_bar TYPE STANDARD TABLE OF ty.`,
25
25
  goodExample: `DATA lt_foo TYPE STANDARD TABLE OF ty WITH EMPTY KEY.`,
26
26
  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
  }