@abaplint/core 2.90.2 → 2.90.5

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 (82) hide show
  1. package/README.md +6 -6
  2. package/build/src/abap/2_statements/statements/insert_internal.js +3 -3
  3. package/build/src/abap/5_syntax/_builtin.js +3 -3
  4. package/build/src/abap/5_syntax/statements/insert_internal.js +2 -2
  5. package/build/src/abap/flow/flow_graph.js +7 -7
  6. package/build/src/lsp/help.js +7 -7
  7. package/build/src/registry.js +1 -1
  8. package/build/src/rules/7bit_ascii.js +2 -2
  9. package/build/src/rules/abapdoc.js +1 -1
  10. package/build/src/rules/align_parameters.js +33 -33
  11. package/build/src/rules/ambiguous_statement.js +5 -5
  12. package/build/src/rules/avoid_use.js +8 -8
  13. package/build/src/rules/begin_end_names.js +4 -4
  14. package/build/src/rules/begin_single_include.js +12 -12
  15. package/build/src/rules/call_transaction_authority_check.js +3 -3
  16. package/build/src/rules/chain_mainly_declarations.js +4 -4
  17. package/build/src/rules/check_abstract.js +2 -2
  18. package/build/src/rules/check_comments.js +4 -4
  19. package/build/src/rules/check_include.js +3 -3
  20. package/build/src/rules/check_subrc.js +8 -8
  21. package/build/src/rules/classic_exceptions_overlap.js +8 -8
  22. package/build/src/rules/commented_code.js +1 -1
  23. package/build/src/rules/constructor_visibility_public.js +4 -4
  24. package/build/src/rules/contains_tab.js +2 -2
  25. package/build/src/rules/dangerous_statement.js +1 -1
  26. package/build/src/rules/downport.js +90 -63
  27. package/build/src/rules/exit_or_check.js +3 -3
  28. package/build/src/rules/exporting.js +1 -1
  29. package/build/src/rules/forbidden_identifier.js +1 -1
  30. package/build/src/rules/forbidden_void_type.js +2 -2
  31. package/build/src/rules/functional_writing.js +17 -17
  32. package/build/src/rules/global_class.js +8 -8
  33. package/build/src/rules/identical_conditions.js +2 -2
  34. package/build/src/rules/identical_contents.js +14 -14
  35. package/build/src/rules/identical_descriptions.js +4 -4
  36. package/build/src/rules/if_in_if.js +7 -7
  37. package/build/src/rules/implement_methods.js +3 -3
  38. package/build/src/rules/in_statement_indentation.js +11 -11
  39. package/build/src/rules/intf_referencing_clas.js +3 -3
  40. package/build/src/rules/line_break_style.js +2 -2
  41. package/build/src/rules/line_length.js +1 -1
  42. package/build/src/rules/line_only_punc.js +1 -1
  43. package/build/src/rules/local_variable_names.js +2 -2
  44. package/build/src/rules/many_parentheses.js +10 -10
  45. package/build/src/rules/max_one_method_parameter_per_line.js +7 -7
  46. package/build/src/rules/max_one_statement.js +3 -3
  47. package/build/src/rules/method_overwrites_builtin.js +2 -2
  48. package/build/src/rules/nesting.js +1 -1
  49. package/build/src/rules/no_chained_assignment.js +1 -1
  50. package/build/src/rules/no_external_form_calls.js +2 -2
  51. package/build/src/rules/no_inline_in_optional_branches.js +11 -11
  52. package/build/src/rules/no_public_attributes.js +1 -1
  53. package/build/src/rules/no_yoda_conditions.js +4 -4
  54. package/build/src/rules/nrob_consistency.js +2 -2
  55. package/build/src/rules/obsolete_statement.js +40 -40
  56. package/build/src/rules/omit_parameter_name.js +3 -3
  57. package/build/src/rules/omit_receiving.js +13 -13
  58. package/build/src/rules/parser_702_chaining.js +2 -2
  59. package/build/src/rules/parser_error.js +2 -2
  60. package/build/src/rules/parser_missing_space.js +1 -1
  61. package/build/src/rules/prefer_inline.js +16 -16
  62. package/build/src/rules/prefer_is_not.js +7 -7
  63. package/build/src/rules/prefer_raise_exception_new.js +3 -3
  64. package/build/src/rules/prefer_returning_to_exporting.js +1 -1
  65. package/build/src/rules/prefer_xsdbool.js +2 -2
  66. package/build/src/rules/remove_descriptions.js +4 -4
  67. package/build/src/rules/rfc_error_handling.js +9 -9
  68. package/build/src/rules/select_add_order_by.js +5 -5
  69. package/build/src/rules/select_performance.js +2 -2
  70. package/build/src/rules/sicf_consistency.js +2 -2
  71. package/build/src/rules/space_before_dot.js +2 -2
  72. package/build/src/rules/start_at_tab.js +1 -1
  73. package/build/src/rules/sy_modification.js +2 -2
  74. package/build/src/rules/tabl_enhancement_category.js +2 -2
  75. package/build/src/rules/unnecessary_pragma.js +14 -14
  76. package/build/src/rules/unused_methods.js +9 -9
  77. package/build/src/rules/unused_variables.js +6 -6
  78. package/build/src/rules/use_bool_expression.js +8 -8
  79. package/build/src/rules/use_line_exists.js +6 -6
  80. package/build/src/rules/use_new.js +4 -4
  81. package/build/src/rules/when_others_last.js +6 -6
  82. package/package.json +66 -66
@@ -36,35 +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
- * EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
53
- * CAST changed to ?=
54
- * LOOP AT method_call( ) is outlined
55
- * VALUE # with structure fields
56
- * VALUE # with internal table lines
57
- * Table Expressions are outlined
58
- * SELECT INTO @DATA definitions are outlined
59
- * Some occurrences of string template formatting option ALPHA changed to function module call
60
- * SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
61
- * PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
62
- * RAISE EXCEPTION ... MESSAGE
63
- * Moving with +=, -=, /=, *=, &&= is expanded
64
- * line_exists and line_index is downported to READ TABLE
65
- * ENUMs, but does not nessesarily give the correct type and value
66
- * MESSAGE with non simple source
67
-
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
+
68
69
  Only one transformation is applied to a statement at a time, so multiple steps might be required to do the full downport.`,
69
70
  tags: [_irule_1.RuleTag.Experimental, _irule_1.RuleTag.Downport, _irule_1.RuleTag.Quickfix],
70
71
  };
@@ -286,6 +287,10 @@ Only one transformation is applied to a statement at a time, so multiple steps m
286
287
  if (found) {
287
288
  return found;
288
289
  }
290
+ found = this.replaceInsertExpression(high, lowFile, highSyntax);
291
+ if (found) {
292
+ return found;
293
+ }
289
294
  found = this.downportMessage(high, lowFile, highSyntax);
290
295
  if (found) {
291
296
  return found;
@@ -405,10 +410,10 @@ Only one transformation is applied to a statement at a time, so multiple steps m
405
410
  const fieldName = f.concatTokens();
406
411
  fieldDefinition += indentation + " " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
407
412
  }
408
- fieldDefinition = `DATA: BEGIN OF ${name},
413
+ fieldDefinition = `DATA: BEGIN OF ${name},
409
414
  ${fieldDefinition}${indentation} END OF ${name}.`;
410
415
  }
411
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
416
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
412
417
  ${indentation}`);
413
418
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
414
419
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -449,12 +454,12 @@ ${indentation}`);
449
454
  }
450
455
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
451
456
  const name = ((_c = inlineData.findFirstExpression(Expressions.TargetField)) === null || _c === void 0 ? void 0 : _c.concatTokens()) || "error";
452
- let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
453
- ${fieldDefinitions}${indentation} END OF ${uniqueName}.
454
- ${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.
455
460
  ${indentation}`);
456
461
  if (fieldDefinitions === "") {
457
- 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.
458
463
  ${indentation}`);
459
464
  }
460
465
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
@@ -499,7 +504,7 @@ ${indentation}`);
499
504
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
500
505
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
501
506
  const firstToken = high.getFirstToken();
502
- 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()}.
503
508
  ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
504
509
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
505
510
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -507,6 +512,28 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
507
512
  }
508
513
  return undefined;
509
514
  }
515
+ replaceInsertExpression(high, lowFile, highSyntax) {
516
+ if (!(high.get() instanceof Statements.InsertInternal)) {
517
+ return undefined;
518
+ }
519
+ const children = high.getChildren();
520
+ if (children[1].get() instanceof Expressions.Source) {
521
+ const source = children[1];
522
+ const target = high.findDirectExpression(Expressions.Target);
523
+ if (target === undefined) {
524
+ return undefined;
525
+ }
526
+ const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
527
+ const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
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()}.
530
+ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
531
+ const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
532
+ const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
533
+ return issue_1.Issue.atToken(lowFile, high.getFirstToken(), "Outline INSERT source expression", this.getMetadata().key, this.conf.severity, fix);
534
+ }
535
+ return undefined;
536
+ }
510
537
  replaceTableExpression(node, lowFile, highSyntax) {
511
538
  for (const fieldChain of node.findAllExpressionsRecursive(Expressions.FieldChain)) {
512
539
  const tableExpression = fieldChain.findDirectExpression(Expressions.TableExpression);
@@ -538,14 +565,14 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
538
565
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
539
566
  const firstToken = node.getFirstToken();
540
567
  // note that the tabix restore should be done before throwing the exception
541
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
542
- ${indentation}DATA ${tabixBackup} LIKE sy-tabix.
543
- ${indentation}${tabixBackup} = sy-tabix.
544
- ${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
545
- ${indentation}sy-tabix = ${tabixBackup}.
546
- ${indentation}IF sy-subrc <> 0.
547
- ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
548
- ${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.
549
576
  ${indentation}`);
550
577
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, startToken.getStart(), tableExpression.getLastToken().getEnd(), uniqueName);
551
578
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -599,7 +626,7 @@ ${indentation}`);
599
626
  const className = classNames[0].concatTokens();
600
627
  const targetName = (_b = target.findFirstExpression(Expressions.TargetField)) === null || _b === void 0 ? void 0 : _b.concatTokens();
601
628
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
602
- const code = ` DATA ${targetName} TYPE REF TO ${className}.
629
+ const code = ` DATA ${targetName} TYPE REF TO ${className}.
603
630
  ${indentation}CATCH ${className} INTO ${targetName}.`;
604
631
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getStart(), node.getEnd(), code);
605
632
  return issue_1.Issue.atToken(lowFile, node.getFirstToken(), "Outline DATA", this.getMetadata().key, this.conf.severity, fix);
@@ -722,11 +749,11 @@ ${indentation}CATCH ${className} INTO ${targetName}.`;
722
749
  const uniqueName1 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
723
750
  const uniqueName2 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
724
751
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
725
- const abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
726
- ${indentation}${uniqueName1}-msgid = ${id === null || id === void 0 ? void 0 : id.toUpperCase()}.
727
- ${indentation}${uniqueName1}-msgno = ${number}.
728
- ${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
729
- ${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}.
730
757
  ${indentation}RAISE EXCEPTION ${uniqueName2}.`;
731
758
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getStart(), node.getEnd(), abap);
732
759
  return issue_1.Issue.atToken(lowFile, startToken, "Downport RAISE MESSAGE", this.getMetadata().key, this.conf.severity, fix);
@@ -798,7 +825,7 @@ ${indentation}RAISE EXCEPTION ${uniqueName2}.`;
798
825
  }
799
826
  const enumName = (_b = high.findExpressionAfterToken("ENUM")) === null || _b === void 0 ? void 0 : _b.concatTokens();
800
827
  const structureName = (_c = high.findExpressionAfterToken("STRUCTURE")) === null || _c === void 0 ? void 0 : _c.concatTokens();
801
- let code = `TYPES ${enumName} TYPE i.
828
+ let code = `TYPES ${enumName} TYPE i.
802
829
  CONSTANTS: BEGIN OF ${structureName},\n`;
803
830
  let count = 1;
804
831
  for (const e of enumStructure.findDirectStatements(Statements.TypeEnum).concat(enumStructure.findDirectStatements(Statements.Type))) {
@@ -839,14 +866,14 @@ CONSTANTS: BEGIN OF ${structureName},\n`;
839
866
  const tabixBackup = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
840
867
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
841
868
  // restore tabix before exeption
842
- const code = `FIELD-SYMBOLS ${uniqueName} LIKE LINE OF ${tName}.
843
- ${indentation}DATA ${tabixBackup} LIKE sy-tabix.
844
- ${indentation}${tabixBackup} = sy-tabix.
845
- ${indentation}READ TABLE ${tName} ${condition}ASSIGNING ${uniqueName}.
846
- ${indentation}sy-tabix = ${tabixBackup}.
847
- ${indentation}IF sy-subrc <> 0.
848
- ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
849
- ${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.
850
877
  ${indentation}${uniqueName}`;
851
878
  const start = target.getFirstToken().getStart();
852
879
  const end = (_a = tableExpression.findDirectTokenByText("]")) === null || _a === void 0 ? void 0 : _a.getEnd();
@@ -934,10 +961,10 @@ ${indentation}${uniqueName}`;
934
961
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
935
962
  const source = (_b = templateSource === null || templateSource === void 0 ? void 0 : templateSource.findDirectExpression(Expressions.Source)) === null || _b === void 0 ? void 0 : _b.concatTokens();
936
963
  const topTarget = (_c = node.findDirectExpression(Expressions.Target)) === null || _c === void 0 ? void 0 : _c.concatTokens();
937
- const code = `CALL FUNCTION '${functionName}'
938
- ${indentation} EXPORTING
939
- ${indentation} input = ${source}
940
- ${indentation} IMPORTING
964
+ const code = `CALL FUNCTION '${functionName}'
965
+ ${indentation} EXPORTING
966
+ ${indentation} input = ${source}
967
+ ${indentation} IMPORTING
941
968
  ${indentation} output = ${topTarget}.`;
942
969
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getFirstToken().getStart(), node.getLastToken().getEnd(), code);
943
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
  };
@@ -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
  }
@@ -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,8 +33,8 @@ 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
40
  };
@@ -20,23 +20,23 @@ class IdenticalContents extends _abap_rule_1.ABAPRule {
20
20
  key: "identical_contents",
21
21
  title: "Identical contents",
22
22
  shortDescription: `Find identical contents in blocks inside IFs, both in the beginning and in the end.`,
23
- extendedInformation: `
24
- Prerequsites: code is pretty printed with identical cAsE
25
-
23
+ extendedInformation: `
24
+ Prerequsites: code is pretty printed with identical cAsE
25
+
26
26
  Chained statments are ignored`,
27
27
  tags: [_irule_1.RuleTag.SingleFile],
28
- badExample: `IF foo = bar.
29
- WRITE 'bar'.
30
- WRITE 'world'.
31
- ELSE.
32
- WRITE 'foo'.
33
- WRITE 'world'.
28
+ badExample: `IF foo = bar.
29
+ WRITE 'bar'.
30
+ WRITE 'world'.
31
+ ELSE.
32
+ WRITE 'foo'.
33
+ WRITE 'world'.
34
34
  ENDIF.`,
35
- goodExample: `IF foo = bar.
36
- WRITE 'bar'.
37
- ELSE.
38
- WRITE 'foo'.
39
- ENDIF.
35
+ goodExample: `IF foo = bar.
36
+ WRITE 'bar'.
37
+ ELSE.
38
+ WRITE 'foo'.
39
+ ENDIF.
40
40
  WRITE 'world'.`,
41
41
  };
42
42
  }
@@ -16,10 +16,10 @@ 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
-
19
+ extendedInformation: `Case insensitive
20
+
21
+ Only checks the master language descriptions
22
+
23
23
  Works for: INTF, CLAS, DOMA, DTEL, FUNC in same FUGR`,
24
24
  tags: [],
25
25
  };
@@ -19,15 +19,15 @@ class IfInIf extends _abap_rule_1.ABAPRule {
19
19
  key: "if_in_if",
20
20
  title: "IF in IF",
21
21
  shortDescription: `Detects nested ifs which can be refactored to a single condition using AND.`,
22
- extendedInformation: `https://docs.abapopenchecks.org/checks/01/
22
+ extendedInformation: `https://docs.abapopenchecks.org/checks/01/
23
23
  https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-the-nesting-depth-low`,
24
- badExample: `IF condition1.
25
- IF condition2.
26
- ...
27
- ENDIF.
24
+ badExample: `IF condition1.
25
+ IF condition2.
26
+ ...
27
+ ENDIF.
28
28
  ENDIF.`,
29
- goodExample: `IF ( condition1 ) AND ( condition2 ).
30
- ...
29
+ goodExample: `IF ( condition1 ) AND ( condition2 ).
30
+ ...
31
31
  ENDIF.`,
32
32
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
33
33
  };
@@ -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
  }
@@ -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
  };
@@ -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
  }
@@ -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,8 +30,8 @@ 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
37
  };
@@ -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,9 +21,9 @@ 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
- 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
+ https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#no-more-than-one-statement-per-line
27
27
  https://docs.abapopenchecks.org/checks/11/`,
28
28
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
29
29
  badExample: `WRITE foo. WRITE bar.`,
@@ -19,8 +19,8 @@ class MethodOverwritesBuiltIn extends _abap_rule_1.ABAPRule {
19
19
  key: "method_overwrites_builtin",
20
20
  title: "Method name overwrites builtin function",
21
21
  shortDescription: `Checks Method names that overwrite builtin SAP functions`,
22
- extendedInformation: `https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abenbuilt_in_functions_overview.htm
23
-
22
+ extendedInformation: `https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abenbuilt_in_functions_overview.htm
23
+
24
24
  https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-obscuring-built-in-functions`,
25
25
  tags: [_irule_1.RuleTag.Naming, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
26
26
  };