@abaplint/core 2.85.32 → 2.85.33

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 (86) hide show
  1. package/README.md +6 -6
  2. package/build/src/abap/1_lexer/tokens/index.js +5 -1
  3. package/build/src/abap/2_statements/expressions/index.js +5 -1
  4. package/build/src/abap/2_statements/statements/index.js +5 -1
  5. package/build/src/abap/3_structures/structures/index.js +5 -1
  6. package/build/src/abap/flow/flow_graph.js +7 -7
  7. package/build/src/abap/nodes/index.js +5 -1
  8. package/build/src/abap/types/basic/index.js +5 -1
  9. package/build/src/abap/types/index.js +5 -1
  10. package/build/src/cds/expressions/index.js +5 -1
  11. package/build/src/ddl/expressions/index.js +5 -1
  12. package/build/src/lsp/help.js +7 -7
  13. package/build/src/objects/index.js +5 -1
  14. package/build/src/registry.js +1 -1
  15. package/build/src/rules/7bit_ascii.js +2 -2
  16. package/build/src/rules/abapdoc.js +1 -1
  17. package/build/src/rules/align_parameters.js +33 -33
  18. package/build/src/rules/ambiguous_statement.js +5 -5
  19. package/build/src/rules/avoid_use.js +7 -6
  20. package/build/src/rules/begin_end_names.js +4 -4
  21. package/build/src/rules/begin_single_include.js +12 -12
  22. package/build/src/rules/call_transaction_authority_check.js +3 -3
  23. package/build/src/rules/chain_mainly_declarations.js +4 -4
  24. package/build/src/rules/check_abstract.js +2 -2
  25. package/build/src/rules/check_comments.js +4 -4
  26. package/build/src/rules/check_include.js +3 -3
  27. package/build/src/rules/check_no_handler_pragma.js +8 -8
  28. package/build/src/rules/check_subrc.js +8 -8
  29. package/build/src/rules/commented_code.js +1 -1
  30. package/build/src/rules/constructor_visibility_public.js +4 -4
  31. package/build/src/rules/contains_tab.js +2 -2
  32. package/build/src/rules/dangerous_statement.js +1 -1
  33. package/build/src/rules/downport.js +86 -50
  34. package/build/src/rules/empty_structure.js +14 -1
  35. package/build/src/rules/exit_or_check.js +3 -3
  36. package/build/src/rules/exporting.js +1 -1
  37. package/build/src/rules/forbidden_identifier.js +1 -1
  38. package/build/src/rules/forbidden_void_type.js +2 -2
  39. package/build/src/rules/functional_writing.js +17 -17
  40. package/build/src/rules/global_class.js +10 -10
  41. package/build/src/rules/identical_conditions.js +2 -2
  42. package/build/src/rules/identical_contents.js +14 -14
  43. package/build/src/rules/identical_descriptions.js +4 -4
  44. package/build/src/rules/if_in_if.js +7 -7
  45. package/build/src/rules/implement_methods.js +3 -3
  46. package/build/src/rules/in_statement_indentation.js +11 -11
  47. package/build/src/rules/index.js +5 -1
  48. package/build/src/rules/intf_referencing_clas.js +3 -3
  49. package/build/src/rules/line_break_style.js +2 -2
  50. package/build/src/rules/line_length.js +1 -1
  51. package/build/src/rules/line_only_punc.js +1 -1
  52. package/build/src/rules/local_variable_names.js +2 -2
  53. package/build/src/rules/many_parentheses.js +10 -10
  54. package/build/src/rules/max_one_method_parameter_per_line.js +7 -7
  55. package/build/src/rules/max_one_statement.js +3 -3
  56. package/build/src/rules/nesting.js +1 -1
  57. package/build/src/rules/no_chained_assignment.js +1 -1
  58. package/build/src/rules/no_public_attributes.js +1 -1
  59. package/build/src/rules/no_yoda_conditions.js +4 -4
  60. package/build/src/rules/obsolete_statement.js +40 -40
  61. package/build/src/rules/omit_parameter_name.js +3 -3
  62. package/build/src/rules/omit_receiving.js +13 -13
  63. package/build/src/rules/parser_702_chaining.js +2 -2
  64. package/build/src/rules/parser_error.js +2 -2
  65. package/build/src/rules/parser_missing_space.js +1 -1
  66. package/build/src/rules/prefer_inline.js +16 -16
  67. package/build/src/rules/prefer_is_not.js +7 -7
  68. package/build/src/rules/prefer_raise_exception_new.js +3 -3
  69. package/build/src/rules/prefer_returning_to_exporting.js +1 -1
  70. package/build/src/rules/prefer_xsdbool.js +2 -2
  71. package/build/src/rules/remove_descriptions.js +4 -4
  72. package/build/src/rules/rfc_error_handling.js +9 -9
  73. package/build/src/rules/select_add_order_by.js +5 -5
  74. package/build/src/rules/select_performance.js +2 -2
  75. package/build/src/rules/sicf_consistency.js +4 -4
  76. package/build/src/rules/space_before_dot.js +2 -2
  77. package/build/src/rules/start_at_tab.js +1 -1
  78. package/build/src/rules/sy_modification.js +2 -2
  79. package/build/src/rules/tabl_enhancement_category.js +2 -2
  80. package/build/src/rules/unused_methods.js +9 -9
  81. package/build/src/rules/unused_variables.js +6 -6
  82. package/build/src/rules/use_bool_expression.js +8 -8
  83. package/build/src/rules/use_line_exists.js +6 -6
  84. package/build/src/rules/use_new.js +4 -4
  85. package/build/src/rules/when_others_last.js +6 -6
  86. package/package.json +66 -66
@@ -33,33 +33,33 @@ class Downport {
33
33
  key: "downport",
34
34
  title: "Downport statement",
35
35
  shortDescription: `Experimental downport functionality`,
36
- extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
37
- a higher level language version. If successful, various rules are applied to downport the statement.
38
- Target downport version is always v702, thus rule is only enabled if target version is v702.
39
-
40
- Current rules:
41
- * NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
42
- * DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
43
- * FIELD-SYMBOL() definitions are outlined
44
- * CONV is outlined
45
- * COND is outlined
46
- * REDUCE is outlined
47
- * SWITCH is outlined
48
- * APPEND expression is outlined
49
- * EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
50
- * CAST changed to ?=
51
- * LOOP AT method_call( ) is outlined
52
- * VALUE # with structure fields
53
- * VALUE # with internal table lines
54
- * Table Expressions are outlined
55
- * SELECT INTO @DATA definitions are outlined
56
- * Some occurrences of string template formatting option ALPHA changed to function module call
57
- * SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
58
- * PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
59
- * RAISE EXCEPTION ... MESSAGE
60
- * Moving with +=, -=, /=, *=, &&= is expanded
61
- * line_exists and line_index is downported to READ TABLE
62
-
36
+ extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
37
+ a higher level language version. If successful, various rules are applied to downport the statement.
38
+ Target downport version is always v702, thus rule is only enabled if target version is v702.
39
+
40
+ Current rules:
41
+ * NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
42
+ * DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
43
+ * FIELD-SYMBOL() definitions are outlined
44
+ * CONV is outlined
45
+ * COND is outlined
46
+ * REDUCE is outlined
47
+ * SWITCH is outlined
48
+ * APPEND expression is outlined
49
+ * EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
50
+ * CAST changed to ?=
51
+ * LOOP AT method_call( ) is outlined
52
+ * VALUE # with structure fields
53
+ * VALUE # with internal table lines
54
+ * Table Expressions are outlined
55
+ * SELECT INTO @DATA definitions are outlined
56
+ * Some occurrences of string template formatting option ALPHA changed to function module call
57
+ * SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
58
+ * PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
59
+ * RAISE EXCEPTION ... MESSAGE
60
+ * Moving with +=, -=, /=, *=, &&= is expanded
61
+ * line_exists and line_index is downported to READ TABLE
62
+
63
63
  Only one transformation is applied to a statement at a time, so multiple steps might be required to do the full downport.`,
64
64
  tags: [_irule_1.RuleTag.Experimental, _irule_1.RuleTag.Downport, _irule_1.RuleTag.Quickfix],
65
65
  };
@@ -170,6 +170,10 @@ Only one transformation is applied to a statement at a time, so multiple steps m
170
170
  if (found) {
171
171
  return found;
172
172
  }
173
+ found = this.moveWithSimpleValue(high, lowFile);
174
+ if (found) {
175
+ return found;
176
+ }
173
177
  found = this.downportSelectInline(low, high, lowFile, highSyntax);
174
178
  if (found) {
175
179
  return found;
@@ -358,10 +362,10 @@ Only one transformation is applied to a statement at a time, so multiple steps m
358
362
  const fieldName = f.concatTokens();
359
363
  fieldDefinition += indentation + " " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
360
364
  }
361
- fieldDefinition = `DATA: BEGIN OF ${name},
365
+ fieldDefinition = `DATA: BEGIN OF ${name},
362
366
  ${fieldDefinition}${indentation} END OF ${name}.`;
363
367
  }
364
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
368
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
365
369
  ${indentation}`);
366
370
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
367
371
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -395,19 +399,19 @@ ${indentation}`);
395
399
  let fieldName = f.concatTokens();
396
400
  if (fieldName.includes("~")) {
397
401
  const split = fieldName.split("~");
398
- fieldName = split[0];
399
- tableName = split[1];
402
+ tableName = split[0];
403
+ fieldName = split[1];
400
404
  }
401
405
  fieldDefinitions += indentation + " " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
402
406
  }
403
407
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
404
408
  const name = ((_c = inlineData.findFirstExpression(Expressions.TargetField)) === null || _c === void 0 ? void 0 : _c.concatTokens()) || "error";
405
- let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
406
- ${fieldDefinitions}${indentation} END OF ${uniqueName}.
407
- ${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
409
+ let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
410
+ ${fieldDefinitions}${indentation} END OF ${uniqueName}.
411
+ ${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
408
412
  ${indentation}`);
409
413
  if (fieldDefinitions === "") {
410
- fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
414
+ fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
411
415
  ${indentation}`);
412
416
  }
413
417
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
@@ -428,7 +432,7 @@ ${indentation}`);
428
432
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
429
433
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
430
434
  const firstToken = high.getFirstToken();
431
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
435
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
432
436
  ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
433
437
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
434
438
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -472,11 +476,11 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
472
476
  const uniqueName = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
473
477
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
474
478
  const firstToken = node.getFirstToken();
475
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
476
- ${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
477
- ${indentation}IF sy-subrc <> 0.
478
- ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
479
- ${indentation}ENDIF.
479
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
480
+ ${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
481
+ ${indentation}IF sy-subrc <> 0.
482
+ ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
483
+ ${indentation}ENDIF.
480
484
  ${indentation}`);
481
485
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, startToken.getStart(), tableExpression.getLastToken().getEnd(), uniqueName);
482
486
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -590,11 +594,11 @@ ${indentation}`);
590
594
  const uniqueName1 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
591
595
  const uniqueName2 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
592
596
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
593
- const abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
594
- ${indentation}${uniqueName1}-msgid = ${id}.
595
- ${indentation}${uniqueName1}-msgno = ${number}.
596
- ${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
597
- ${indentation}CREATE OBJECT ${uniqueName2} EXPORTING textid = ${uniqueName1}.
597
+ const abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
598
+ ${indentation}${uniqueName1}-msgid = ${id}.
599
+ ${indentation}${uniqueName1}-msgno = ${number}.
600
+ ${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
601
+ ${indentation}CREATE OBJECT ${uniqueName2} EXPORTING textid = ${uniqueName1}.
598
602
  ${indentation}RAISE EXCEPTION ${uniqueName2}.`;
599
603
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getStart(), node.getEnd(), abap);
600
604
  return issue_1.Issue.atToken(lowFile, startToken, "Downport RAISE MESSAGE", this.getMetadata().key, this.conf.severity, fix);
@@ -621,6 +625,38 @@ ${indentation}RAISE EXCEPTION ${uniqueName2}.`;
621
625
  }
622
626
  return undefined;
623
627
  }
628
+ moveWithSimpleValue(high, lowFile) {
629
+ if (!(high.get() instanceof Statements.Move)
630
+ || high.getChildren().length !== 4) {
631
+ return undefined;
632
+ }
633
+ const target = high.findDirectExpression(Expressions.Target);
634
+ if (target === undefined) {
635
+ return undefined;
636
+ }
637
+ const source = high.findDirectExpression(Expressions.Source);
638
+ if (source === undefined) {
639
+ return undefined;
640
+ }
641
+ const field = target.findDirectExpression(Expressions.TargetField);
642
+ if (field === undefined) {
643
+ return;
644
+ }
645
+ const valueBody = source.findDirectExpression(Expressions.ValueBody);
646
+ if (valueBody === undefined || valueBody.getChildren().length !== 1) {
647
+ return;
648
+ }
649
+ const fieldAssignment = valueBody.findDirectExpression(Expressions.FieldAssignment);
650
+ if (fieldAssignment === undefined) {
651
+ return;
652
+ }
653
+ const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
654
+ const code = `CLEAR ${target.concatTokens()}.\n` + indentation + target.concatTokens() + "-" + fieldAssignment.concatTokens();
655
+ const start = high.getFirstToken().getStart();
656
+ const end = high.getLastToken().getStart();
657
+ const fix = edit_helper_1.EditHelper.replaceRange(lowFile, start, end, code);
658
+ return issue_1.Issue.atToken(lowFile, high.getFirstToken(), "Downport, Reduce statement", this.getMetadata().key, this.conf.severity, fix);
659
+ }
624
660
  moveWithOperator(high, lowFile) {
625
661
  var _a, _b, _c;
626
662
  if (!(high.get() instanceof Statements.Move)) {
@@ -699,10 +735,10 @@ ${indentation}RAISE EXCEPTION ${uniqueName2}.`;
699
735
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
700
736
  const source = (_b = templateSource === null || templateSource === void 0 ? void 0 : templateSource.findDirectExpression(Expressions.Source)) === null || _b === void 0 ? void 0 : _b.concatTokens();
701
737
  const topTarget = (_c = node.findDirectExpression(Expressions.Target)) === null || _c === void 0 ? void 0 : _c.concatTokens();
702
- const code = `CALL FUNCTION '${functionName}'
703
- ${indentation} EXPORTING
704
- ${indentation} input = ${source}
705
- ${indentation} IMPORTING
738
+ const code = `CALL FUNCTION '${functionName}'
739
+ ${indentation} EXPORTING
740
+ ${indentation} input = ${source}
741
+ ${indentation} IMPORTING
706
742
  ${indentation} output = ${topTarget}.`;
707
743
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getFirstToken().getStart(), node.getLastToken().getEnd(), code);
708
744
  return issue_1.Issue.atToken(lowFile, node.getFirstToken(), "Downport ALPHA", this.getMetadata().key, this.conf.severity, fix);
@@ -25,7 +25,9 @@ class EmptyStructureConf extends _basic_rule_config_1.BasicRuleConfig {
25
25
  this.at = true;
26
26
  /** Checks for empty TRY blocks */
27
27
  this.try = true;
28
- // todo, other category containing WHEN, ELSE
28
+ /** Checks for empty WHEN blocks */
29
+ this.when = true;
30
+ // todo, other category containing ELSE
29
31
  }
30
32
  }
31
33
  exports.EmptyStructureConf = EmptyStructureConf;
@@ -108,6 +110,17 @@ class EmptyStructure extends _abap_rule_1.ABAPRule {
108
110
  }
109
111
  }
110
112
  }
113
+ if (this.getConfig().when === true) {
114
+ const tries = stru.findAllStructures(Structures.When);
115
+ for (const t of tries) {
116
+ if (t.getChildren().length === 1) {
117
+ const token = t.getFirstToken();
118
+ const message = this.getDescription(t.get().constructor.name);
119
+ const issue = issue_1.Issue.atToken(file, token, message, this.getMetadata().key, this.conf.severity);
120
+ issues.push(issue);
121
+ }
122
+ }
123
+ }
111
124
  return issues;
112
125
  }
113
126
  }
@@ -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
  }
@@ -18,16 +18,16 @@ class GlobalClass extends _abap_rule_1.ABAPRule {
18
18
  return {
19
19
  key: "global_class",
20
20
  title: "Global class checks",
21
- shortDescription: `Checks related to global classes.
22
-
23
- * global classes must be in own files
24
-
25
- * file names must match class name
26
-
27
- * file names must match interface name
28
-
29
- * global classes must be global definitions
30
-
21
+ shortDescription: `Checks related to global classes.
22
+
23
+ * global classes must be in own files
24
+
25
+ * file names must match class name
26
+
27
+ * file names must match interface name
28
+
29
+ * global classes must be global definitions
30
+
31
31
  * global interfaces must be global definitions`,
32
32
  tags: [_irule_1.RuleTag.Syntax],
33
33
  };
@@ -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
  };
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
@@ -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.`,