@abaplint/core 2.83.7 → 2.83.8

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/abaplint.d.ts +59 -6
  3. package/build/src/abap/flow/flow_graph.js +7 -7
  4. package/build/src/abap/types/basic/any_type.js +3 -0
  5. package/build/src/abap/types/basic/character_type.js +3 -0
  6. package/build/src/abap/types/basic/clike_type.js +3 -0
  7. package/build/src/abap/types/basic/csequence_type.js +3 -0
  8. package/build/src/abap/types/basic/data_reference_type.js +3 -0
  9. package/build/src/abap/types/basic/date_type.js +3 -0
  10. package/build/src/abap/types/basic/decfloat16_type.js +3 -0
  11. package/build/src/abap/types/basic/decfloat34_type.js +3 -0
  12. package/build/src/abap/types/basic/decfloat_type.js +3 -0
  13. package/build/src/abap/types/basic/enum_type.js +3 -0
  14. package/build/src/abap/types/basic/float_type.js +3 -0
  15. package/build/src/abap/types/basic/floating_point_type.js +3 -0
  16. package/build/src/abap/types/basic/generic_object_reference_type.js +3 -0
  17. package/build/src/abap/types/basic/hex_type.js +3 -0
  18. package/build/src/abap/types/basic/integer_type.js +3 -0
  19. package/build/src/abap/types/basic/numeric_generic_type.js +3 -0
  20. package/build/src/abap/types/basic/numeric_type.js +3 -0
  21. package/build/src/abap/types/basic/object_reference_type.js +3 -0
  22. package/build/src/abap/types/basic/packed_type.js +3 -0
  23. package/build/src/abap/types/basic/simple_type.js +3 -0
  24. package/build/src/abap/types/basic/string_type.js +3 -0
  25. package/build/src/abap/types/basic/structure_type.js +3 -0
  26. package/build/src/abap/types/basic/table_type.js +3 -0
  27. package/build/src/abap/types/basic/time_type.js +3 -0
  28. package/build/src/abap/types/basic/unknown_type.js +3 -0
  29. package/build/src/abap/types/basic/utc_long_type.js +3 -0
  30. package/build/src/abap/types/basic/void_type.js +3 -0
  31. package/build/src/abap/types/basic/xsequence_type.js +3 -0
  32. package/build/src/abap/types/basic/xstring_type.js +3 -0
  33. package/build/src/cds/cds_determine_types.js +23 -0
  34. package/build/src/cds/expressions/cds_association.js +1 -1
  35. package/build/src/cds/expressions/cds_composition.js +1 -1
  36. package/build/src/cds/expressions/cds_relation.js +12 -0
  37. package/build/src/cds/expressions/index.js +1 -0
  38. package/build/src/index.js +3 -1
  39. package/build/src/lsp/help.js +17 -12
  40. package/build/src/objects/data_definition.js +59 -42
  41. package/build/src/registry.js +1 -1
  42. package/build/src/rules/7bit_ascii.js +2 -2
  43. package/build/src/rules/abapdoc.js +1 -1
  44. package/build/src/rules/align_parameters.js +33 -33
  45. package/build/src/rules/ambiguous_statement.js +5 -5
  46. package/build/src/rules/avoid_use.js +6 -6
  47. package/build/src/rules/begin_end_names.js +4 -4
  48. package/build/src/rules/begin_single_include.js +12 -12
  49. package/build/src/rules/call_transaction_authority_check.js +3 -3
  50. package/build/src/rules/chain_mainly_declarations.js +4 -4
  51. package/build/src/rules/check_abstract.js +2 -2
  52. package/build/src/rules/check_comments.js +6 -5
  53. package/build/src/rules/check_include.js +3 -3
  54. package/build/src/rules/check_no_handler_pragma.js +8 -8
  55. package/build/src/rules/check_subrc.js +8 -8
  56. package/build/src/rules/commented_code.js +1 -1
  57. package/build/src/rules/constructor_visibility_public.js +4 -4
  58. package/build/src/rules/contains_tab.js +2 -2
  59. package/build/src/rules/dangerous_statement.js +1 -1
  60. package/build/src/rules/downport.js +35 -35
  61. package/build/src/rules/exit_or_check.js +3 -3
  62. package/build/src/rules/exporting.js +1 -1
  63. package/build/src/rules/forbidden_identifier.js +1 -1
  64. package/build/src/rules/forbidden_void_type.js +2 -2
  65. package/build/src/rules/functional_writing.js +17 -17
  66. package/build/src/rules/global_class.js +10 -10
  67. package/build/src/rules/identical_conditions.js +2 -2
  68. package/build/src/rules/identical_contents.js +15 -15
  69. package/build/src/rules/identical_descriptions.js +4 -4
  70. package/build/src/rules/if_in_if.js +7 -7
  71. package/build/src/rules/implement_methods.js +3 -3
  72. package/build/src/rules/in_statement_indentation.js +11 -11
  73. package/build/src/rules/intf_referencing_clas.js +3 -3
  74. package/build/src/rules/line_break_style.js +2 -2
  75. package/build/src/rules/line_length.js +1 -1
  76. package/build/src/rules/line_only_punc.js +1 -1
  77. package/build/src/rules/local_variable_names.js +2 -2
  78. package/build/src/rules/many_parentheses.js +10 -10
  79. package/build/src/rules/max_one_method_parameter_per_line.js +7 -7
  80. package/build/src/rules/max_one_statement.js +3 -3
  81. package/build/src/rules/nesting.js +1 -1
  82. package/build/src/rules/no_chained_assignment.js +1 -1
  83. package/build/src/rules/no_public_attributes.js +1 -1
  84. package/build/src/rules/no_yoda_conditions.js +4 -4
  85. package/build/src/rules/obsolete_statement.js +40 -40
  86. package/build/src/rules/omit_parameter_name.js +3 -3
  87. package/build/src/rules/omit_receiving.js +13 -13
  88. package/build/src/rules/parser_702_chaining.js +2 -2
  89. package/build/src/rules/parser_error.js +2 -2
  90. package/build/src/rules/parser_missing_space.js +1 -1
  91. package/build/src/rules/prefer_inline.js +16 -16
  92. package/build/src/rules/prefer_is_not.js +7 -7
  93. package/build/src/rules/prefer_raise_exception_new.js +3 -3
  94. package/build/src/rules/prefer_returning_to_exporting.js +1 -1
  95. package/build/src/rules/prefer_xsdbool.js +2 -2
  96. package/build/src/rules/remove_descriptions.js +4 -4
  97. package/build/src/rules/rfc_error_handling.js +9 -9
  98. package/build/src/rules/select_add_order_by.js +5 -5
  99. package/build/src/rules/select_performance.js +2 -2
  100. package/build/src/rules/sicf_consistency.js +4 -4
  101. package/build/src/rules/space_before_dot.js +2 -2
  102. package/build/src/rules/start_at_tab.js +1 -1
  103. package/build/src/rules/sy_modification.js +2 -2
  104. package/build/src/rules/tabl_enhancement_category.js +2 -2
  105. package/build/src/rules/unused_methods.js +9 -9
  106. package/build/src/rules/unused_variables.js +6 -6
  107. package/build/src/rules/use_bool_expression.js +8 -8
  108. package/build/src/rules/use_line_exists.js +6 -6
  109. package/build/src/rules/use_new.js +2 -2
  110. package/build/src/rules/when_others_last.js +6 -6
  111. package/package.json +66 -66
@@ -32,27 +32,27 @@ class Downport {
32
32
  key: "downport",
33
33
  title: "Downport statement",
34
34
  shortDescription: `Experimental downport functionality`,
35
- extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
36
- a higher level language version. If successful, various rules are applied to downport the statement.
37
- Target downport version is always v702, thus rule is only enabled if target version is v702.
38
-
39
- Current rules:
40
- * NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
41
- * DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
42
- * FIELD-SYMBOL() definitions are outlined
43
- * CONV is outlined
44
- * COND is outlined
45
- * REDUCE is outlined
46
- * EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
47
- * CAST changed to ?=
48
- * LOOP AT method_call( ) is outlined
49
- * VALUE # with structure fields
50
- * VALUE # with internal table lines
51
- * Table Expressions[ index ] are outlined
52
- * SELECT INTO @DATA definitions are outlined
53
- * Some occurrences of string template formatting option ALPHA changed to function module call
54
- * SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
55
-
35
+ extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
36
+ a higher level language version. If successful, various rules are applied to downport the statement.
37
+ Target downport version is always v702, thus rule is only enabled if target version is v702.
38
+
39
+ Current rules:
40
+ * NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
41
+ * DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
42
+ * FIELD-SYMBOL() definitions are outlined
43
+ * CONV is outlined
44
+ * COND is outlined
45
+ * REDUCE is outlined
46
+ * EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
47
+ * CAST changed to ?=
48
+ * LOOP AT method_call( ) is outlined
49
+ * VALUE # with structure fields
50
+ * VALUE # with internal table lines
51
+ * Table Expressions[ index ] are outlined
52
+ * SELECT INTO @DATA definitions are outlined
53
+ * Some occurrences of string template formatting option ALPHA changed to function module call
54
+ * SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
55
+
56
56
  Only one transformation is applied to a statement at a time, so multiple steps might be required to do the full downport.`,
57
57
  tags: [_irule_1.RuleTag.Experimental, _irule_1.RuleTag.Downport, _irule_1.RuleTag.Quickfix],
58
58
  };
@@ -306,10 +306,10 @@ Only one transformation is applied to a statement at a time, so multiple steps m
306
306
  const fieldName = f.concatTokens();
307
307
  fieldDefinition += indentation + " " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
308
308
  }
309
- fieldDefinition = `DATA: BEGIN OF ${name},
309
+ fieldDefinition = `DATA: BEGIN OF ${name},
310
310
  ${fieldDefinition}${indentation} END OF ${name}.`;
311
311
  }
312
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
312
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
313
313
  ${indentation}`);
314
314
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
315
315
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -345,9 +345,9 @@ ${indentation}`);
345
345
  }
346
346
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
347
347
  const name = ((_c = inlineData.findFirstExpression(Expressions.TargetField)) === null || _c === void 0 ? void 0 : _c.concatTokens()) || "error";
348
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
349
- ${fieldDefinitions}${indentation} END OF ${uniqueName}.
350
- ${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
348
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
349
+ ${fieldDefinitions}${indentation} END OF ${uniqueName}.
350
+ ${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
351
351
  ${indentation}`);
352
352
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
353
353
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -381,11 +381,11 @@ ${indentation}`);
381
381
  const uniqueName = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
382
382
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
383
383
  const firstToken = node.getFirstToken();
384
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
385
- ${indentation}READ TABLE ${pre} INDEX ${(_a = tableExpression.findFirstExpression(Expressions.Source)) === null || _a === void 0 ? void 0 : _a.concatTokens()} INTO ${uniqueName}.
386
- ${indentation}IF sy-subrc <> 0.
387
- ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
388
- ${indentation}ENDIF.
384
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
385
+ ${indentation}READ TABLE ${pre} INDEX ${(_a = tableExpression.findFirstExpression(Expressions.Source)) === null || _a === void 0 ? void 0 : _a.concatTokens()} INTO ${uniqueName}.
386
+ ${indentation}IF sy-subrc <> 0.
387
+ ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
388
+ ${indentation}ENDIF.
389
389
  ${indentation}`);
390
390
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, startToken.getStart(), tableExpression.getLastToken().getEnd(), uniqueName);
391
391
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -484,10 +484,10 @@ ${indentation}`);
484
484
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
485
485
  const source = (_b = templateSource === null || templateSource === void 0 ? void 0 : templateSource.findDirectExpression(Expressions.Source)) === null || _b === void 0 ? void 0 : _b.concatTokens();
486
486
  const topTarget = (_c = node.findDirectExpression(Expressions.Target)) === null || _c === void 0 ? void 0 : _c.concatTokens();
487
- const code = `CALL FUNCTION '${functionName}'
488
- ${indentation} EXPORTING
489
- ${indentation} input = ${source}
490
- ${indentation} IMPORTING
487
+ const code = `CALL FUNCTION '${functionName}'
488
+ ${indentation} EXPORTING
489
+ ${indentation} input = ${source}
490
+ ${indentation} IMPORTING
491
491
  ${indentation} output = ${topTarget}.`;
492
492
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getFirstToken().getStart(), node.getLastToken().getEnd(), code);
493
493
  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
  }
@@ -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
  };
@@ -19,24 +19,24 @@ class IdenticalContents extends _abap_rule_1.ABAPRule {
19
19
  return {
20
20
  key: "identical_contents",
21
21
  title: "Identical contents",
22
- shortDescription: `Find identical contents in blocks inside IFs, both in the beginning and in the end.
23
-
24
- Prerequsites: code is pretty printed with identical cAsE
25
-
22
+ shortDescription: `Find identical contents in blocks inside IFs, both in the beginning and in the end.
23
+
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
  };
@@ -22,17 +22,17 @@ class ManyParentheses extends _abap_rule_1.ABAPRule {
22
22
  title: "Too many parentheses",
23
23
  shortDescription: `Searches for expressions where extra parentheses can safely be removed`,
24
24
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
25
- badExample: `
26
- IF ( destination IS INITIAL ).
27
- ENDIF.
28
- IF foo = boo AND ( bar = lar AND moo = loo ).
29
- ENDIF.
25
+ badExample: `
26
+ IF ( destination IS INITIAL ).
27
+ ENDIF.
28
+ IF foo = boo AND ( bar = lar AND moo = loo ).
29
+ ENDIF.
30
30
  `,
31
- goodExample: `
32
- IF destination IS INITIAL.
33
- ENDIF.
34
- IF foo = boo AND bar = lar AND moo = loo.
35
- ENDIF.
31
+ goodExample: `
32
+ IF destination IS INITIAL.
33
+ ENDIF.
34
+ IF foo = boo AND bar = lar AND moo = loo.
35
+ ENDIF.
36
36
  `,
37
37
  };
38
38
  }
@@ -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.`,
@@ -24,7 +24,7 @@ class Nesting extends _abap_rule_1.ABAPRule {
24
24
  key: "nesting",
25
25
  title: "Check nesting depth",
26
26
  shortDescription: `Checks for methods exceeding a maximum nesting depth`,
27
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-the-nesting-depth-low
27
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-the-nesting-depth-low
28
28
  https://docs.abapopenchecks.org/checks/74/`,
29
29
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
30
30
  };
@@ -23,7 +23,7 @@ class NoChainedAssignment extends _abap_rule_1.ABAPRule {
23
23
  extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-chain-assignments`,
24
24
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
25
25
  badExample: `var1 = var2 = var3.`,
26
- goodExample: `var2 = var3.
26
+ goodExample: `var2 = var3.
27
27
  var1 = var2.`,
28
28
  };
29
29
  }
@@ -25,7 +25,7 @@ class NoPublicAttributes extends _abap_rule_1.ABAPRule {
25
25
  return {
26
26
  key: "no_public_attributes",
27
27
  title: "No public attributes",
28
- shortDescription: `Checks that classes and interfaces don't contain any public attributes.
28
+ shortDescription: `Checks that classes and interfaces don't contain any public attributes.
29
29
  Exceptions are excluded from this rule.`,
30
30
  extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#members-private-by-default-protected-only-if-needed`,
31
31
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
@@ -24,13 +24,13 @@ class NoYodaConditions extends _abap_rule_1.ABAPRule {
24
24
  key: "no_yoda_conditions",
25
25
  title: "No Yoda conditions",
26
26
  shortDescription: `Finds Yoda conditions and reports issues`,
27
- extendedInformation: `https://en.wikipedia.org/wiki/Yoda_conditions
28
-
27
+ extendedInformation: `https://en.wikipedia.org/wiki/Yoda_conditions
28
+
29
29
  Conditions with operators CP, NP, CS, NS, CA, NA, CO, CN are ignored`,
30
30
  tags: [_irule_1.RuleTag.SingleFile],
31
- badExample: `IF 0 <> sy-subrc.
31
+ badExample: `IF 0 <> sy-subrc.
32
32
  ENDIF.`,
33
- goodExample: `IF sy-subrc <> 0.
33
+ goodExample: `IF sy-subrc <> 0.
34
34
  ENDIF.`,
35
35
  };
36
36
  }
@@ -79,46 +79,46 @@ class ObsoleteStatement extends _abap_rule_1.ABAPRule {
79
79
  title: "Obsolete statements",
80
80
  shortDescription: `Checks for usages of certain obsolete statements`,
81
81
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix],
82
- extendedInformation: `
83
- https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-functional-to-procedural-language-constructs
84
-
85
- https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-obsolete-language-elements
86
-
87
- SET EXTENDED CHECK: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapset_extended_check.htm
88
-
89
- IS REQUESTED: https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abenlogexp_requested.htm
90
-
91
- WITH HEADER LINE: https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abapdata_header_line.htm
92
-
93
- FIELD-SYMBOLS STRUCTURE: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapfield-symbols_obsolete_typing.htm
94
-
95
- TYPE-POOLS: from 702, https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abennews-71-program_load.htm
96
-
97
- LOAD addition: from 702, https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abennews-71-program_load.htm
98
-
99
- COMMUICATION: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapcommunication.htm
100
-
101
- OCCURS: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapdata_occurs.htm
102
-
103
- PARAMETER: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abapparameter.htm
104
-
105
- RANGES: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapranges.htm
106
-
107
- PACK: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abappack.htm
108
-
109
- MOVE: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapmove_obs.htm
110
-
111
- SELECT without INTO: https://help.sap.com/doc/abapdocu_731_index_htm/7.31/en-US/abapselect_obsolete.htm
112
- SELECT COUNT(*) is considered okay
113
-
114
- FREE MEMORY: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abapfree_mem_id_obsolete.htm
115
-
116
- SORT BY FS: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapsort_itab_obsolete.htm
117
-
118
- CALL TRANSFORMATION OBJECTS: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapcall_transformation_objects.htm
119
-
120
- POSIX REGEX: https://help.sap.com/doc/abapdocu_755_index_htm/7.55/en-US/index.htm
121
-
82
+ extendedInformation: `
83
+ https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-functional-to-procedural-language-constructs
84
+
85
+ https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-obsolete-language-elements
86
+
87
+ SET EXTENDED CHECK: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapset_extended_check.htm
88
+
89
+ IS REQUESTED: https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abenlogexp_requested.htm
90
+
91
+ WITH HEADER LINE: https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abapdata_header_line.htm
92
+
93
+ FIELD-SYMBOLS STRUCTURE: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapfield-symbols_obsolete_typing.htm
94
+
95
+ TYPE-POOLS: from 702, https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abennews-71-program_load.htm
96
+
97
+ LOAD addition: from 702, https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abennews-71-program_load.htm
98
+
99
+ COMMUICATION: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapcommunication.htm
100
+
101
+ OCCURS: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapdata_occurs.htm
102
+
103
+ PARAMETER: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abapparameter.htm
104
+
105
+ RANGES: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapranges.htm
106
+
107
+ PACK: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abappack.htm
108
+
109
+ MOVE: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapmove_obs.htm
110
+
111
+ SELECT without INTO: https://help.sap.com/doc/abapdocu_731_index_htm/7.31/en-US/abapselect_obsolete.htm
112
+ SELECT COUNT(*) is considered okay
113
+
114
+ FREE MEMORY: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abapfree_mem_id_obsolete.htm
115
+
116
+ SORT BY FS: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapsort_itab_obsolete.htm
117
+
118
+ CALL TRANSFORMATION OBJECTS: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapcall_transformation_objects.htm
119
+
120
+ POSIX REGEX: https://help.sap.com/doc/abapdocu_755_index_htm/7.55/en-US/index.htm
121
+
122
122
  OCCURENCES: check for OCCURENCES vs OCCURRENCES`,
123
123
  };
124
124
  }