@abaplint/core 2.85.33 → 2.85.34

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 (74) hide show
  1. package/README.md +6 -6
  2. package/build/src/abap/flow/flow_graph.js +7 -7
  3. package/build/src/lsp/help.js +7 -7
  4. package/build/src/registry.js +1 -1
  5. package/build/src/rules/7bit_ascii.js +2 -2
  6. package/build/src/rules/abapdoc.js +1 -1
  7. package/build/src/rules/align_parameters.js +33 -33
  8. package/build/src/rules/ambiguous_statement.js +5 -5
  9. package/build/src/rules/avoid_use.js +6 -6
  10. package/build/src/rules/begin_end_names.js +4 -4
  11. package/build/src/rules/begin_single_include.js +12 -12
  12. package/build/src/rules/call_transaction_authority_check.js +3 -3
  13. package/build/src/rules/chain_mainly_declarations.js +4 -4
  14. package/build/src/rules/check_abstract.js +2 -2
  15. package/build/src/rules/check_comments.js +4 -4
  16. package/build/src/rules/check_include.js +3 -3
  17. package/build/src/rules/check_no_handler_pragma.js +8 -8
  18. package/build/src/rules/check_subrc.js +8 -8
  19. package/build/src/rules/commented_code.js +1 -1
  20. package/build/src/rules/constructor_visibility_public.js +4 -4
  21. package/build/src/rules/contains_tab.js +2 -2
  22. package/build/src/rules/dangerous_statement.js +1 -1
  23. package/build/src/rules/downport.js +75 -49
  24. package/build/src/rules/exit_or_check.js +3 -3
  25. package/build/src/rules/exporting.js +1 -1
  26. package/build/src/rules/forbidden_identifier.js +1 -1
  27. package/build/src/rules/forbidden_void_type.js +2 -2
  28. package/build/src/rules/functional_writing.js +17 -17
  29. package/build/src/rules/global_class.js +10 -10
  30. package/build/src/rules/identical_conditions.js +2 -2
  31. package/build/src/rules/identical_contents.js +14 -14
  32. package/build/src/rules/identical_descriptions.js +4 -4
  33. package/build/src/rules/if_in_if.js +7 -7
  34. package/build/src/rules/implement_methods.js +3 -3
  35. package/build/src/rules/in_statement_indentation.js +11 -11
  36. package/build/src/rules/intf_referencing_clas.js +3 -3
  37. package/build/src/rules/line_break_style.js +2 -2
  38. package/build/src/rules/line_length.js +1 -1
  39. package/build/src/rules/line_only_punc.js +1 -1
  40. package/build/src/rules/local_variable_names.js +2 -2
  41. package/build/src/rules/many_parentheses.js +10 -10
  42. package/build/src/rules/max_one_method_parameter_per_line.js +7 -7
  43. package/build/src/rules/max_one_statement.js +3 -3
  44. package/build/src/rules/nesting.js +1 -1
  45. package/build/src/rules/no_chained_assignment.js +1 -1
  46. package/build/src/rules/no_public_attributes.js +1 -1
  47. package/build/src/rules/no_yoda_conditions.js +4 -4
  48. package/build/src/rules/obsolete_statement.js +40 -40
  49. package/build/src/rules/omit_parameter_name.js +3 -3
  50. package/build/src/rules/omit_receiving.js +13 -13
  51. package/build/src/rules/parser_702_chaining.js +2 -2
  52. package/build/src/rules/parser_error.js +2 -2
  53. package/build/src/rules/parser_missing_space.js +1 -1
  54. package/build/src/rules/prefer_inline.js +16 -16
  55. package/build/src/rules/prefer_is_not.js +7 -7
  56. package/build/src/rules/prefer_raise_exception_new.js +3 -3
  57. package/build/src/rules/prefer_returning_to_exporting.js +1 -1
  58. package/build/src/rules/prefer_xsdbool.js +2 -2
  59. package/build/src/rules/remove_descriptions.js +4 -4
  60. package/build/src/rules/rfc_error_handling.js +9 -9
  61. package/build/src/rules/select_add_order_by.js +5 -5
  62. package/build/src/rules/select_performance.js +2 -2
  63. package/build/src/rules/sicf_consistency.js +4 -4
  64. package/build/src/rules/space_before_dot.js +2 -2
  65. package/build/src/rules/start_at_tab.js +1 -1
  66. package/build/src/rules/sy_modification.js +2 -2
  67. package/build/src/rules/tabl_enhancement_category.js +2 -2
  68. package/build/src/rules/unused_methods.js +9 -9
  69. package/build/src/rules/unused_variables.js +6 -6
  70. package/build/src/rules/use_bool_expression.js +8 -8
  71. package/build/src/rules/use_line_exists.js +6 -6
  72. package/build/src/rules/use_new.js +4 -4
  73. package/build/src/rules/when_others_last.js +6 -6
  74. package/package.json +66 -66
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
- # @abaplint/core
2
-
3
- [abaplint](https://abaplint.org/) core library
4
-
5
- Exposes functionality like the parser and rules, which can be used in other projects.
6
-
1
+ # @abaplint/core
2
+
3
+ [abaplint](https://abaplint.org/) core library
4
+
5
+ Exposes functionality like the parser and rules, which can be used in other projects.
6
+
7
7
  For more information see https://github.com/abaplint/abaplint
@@ -72,13 +72,13 @@ class FlowGraph {
72
72
  this.label = label;
73
73
  }
74
74
  toDigraph() {
75
- return `digraph G {
76
- labelloc="t";
77
- label="${this.label}";
78
- graph [fontname = "helvetica"];
79
- node [fontname = "helvetica", shape="box"];
80
- edge [fontname = "helvetica"];
81
- ${this.toTextEdges()}
75
+ return `digraph G {
76
+ labelloc="t";
77
+ label="${this.label}";
78
+ graph [fontname = "helvetica"];
79
+ node [fontname = "helvetica", shape="box"];
80
+ edge [fontname = "helvetica"];
81
+ ${this.toTextEdges()}
82
82
  }`;
83
83
  }
84
84
  listSources(node) {
@@ -19,13 +19,13 @@ class Help {
19
19
  /////////////////////////////////////////////////
20
20
  static dumpABAP(file, reg, textDocument, position) {
21
21
  let content = "";
22
- content = `
23
- <a href="#_tokens" rel="no-refresh">Tokens</a> |
24
- <a href="#_statements" rel="no-refresh">Statements</a> |
25
- <a href="#_structure" rel="no-refresh">Structure</a> |
26
- <a href="#_files" rel="no-refresh">Files</a> |
27
- <a href="#_info" rel="no-refresh">Info Dump</a>
28
- <hr>
22
+ content = `
23
+ <a href="#_tokens" rel="no-refresh">Tokens</a> |
24
+ <a href="#_statements" rel="no-refresh">Statements</a> |
25
+ <a href="#_structure" rel="no-refresh">Structure</a> |
26
+ <a href="#_files" rel="no-refresh">Files</a> |
27
+ <a href="#_info" rel="no-refresh">Info Dump</a>
28
+ <hr>
29
29
  ` +
30
30
  "<tt>" + textDocument.uri + " (" +
31
31
  (position.line + 1) + ", " +
@@ -68,7 +68,7 @@ class Registry {
68
68
  }
69
69
  static abaplintVersion() {
70
70
  // magic, see build script "version.sh"
71
- return "2.85.33";
71
+ return "2.85.34";
72
72
  }
73
73
  getDDICReferences() {
74
74
  return this.references;
@@ -17,8 +17,8 @@ class SevenBitAscii {
17
17
  key: "7bit_ascii",
18
18
  title: "Check for 7bit ascii",
19
19
  shortDescription: `Only allow characters from the 7bit ASCII set.`,
20
- extendedInformation: `https://docs.abapopenchecks.org/checks/05/
21
-
20
+ extendedInformation: `https://docs.abapopenchecks.org/checks/05/
21
+
22
22
  Checkes files with extension ".abap" and ".asddls"`,
23
23
  tags: [_irule_1.RuleTag.SingleFile],
24
24
  };
@@ -23,7 +23,7 @@ class Abapdoc extends _abap_rule_1.ABAPRule {
23
23
  return {
24
24
  key: "abapdoc",
25
25
  title: "Check abapdoc",
26
- shortDescription: `Various checks regarding abapdoc.
26
+ shortDescription: `Various checks regarding abapdoc.
27
27
  Base rule checks for existence of abapdoc for public class methods and all interface methods.`,
28
28
  tags: [_irule_1.RuleTag.SingleFile],
29
29
  };
@@ -20,42 +20,42 @@ class AlignParameters extends _abap_rule_1.ABAPRule {
20
20
  key: "align_parameters",
21
21
  title: "Align Parameters",
22
22
  shortDescription: `Checks for vertially aligned parameters`,
23
- extendedInformation: `Checks:
24
- * function module calls
25
- * method calls
26
- * VALUE constructors
27
- * NEW constructors
28
- * RAISE EXCEPTION statements
29
- * CREATE OBJECT statements
30
- * RAISE EVENT statements
31
-
32
- https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
33
-
34
- Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
35
-
23
+ extendedInformation: `Checks:
24
+ * function module calls
25
+ * method calls
26
+ * VALUE constructors
27
+ * NEW constructors
28
+ * RAISE EXCEPTION statements
29
+ * CREATE OBJECT statements
30
+ * RAISE EVENT statements
31
+
32
+ https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
33
+
34
+ Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
35
+
36
36
  Also https://rules.abaplint.org/max_one_method_parameter_per_line/ can help aligning parameter syntax`,
37
37
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Styleguide],
38
- badExample: `CALL FUNCTION 'FOOBAR'
39
- EXPORTING
40
- foo = 2
41
- parameter = 3.
42
-
43
- foobar( moo = 1
44
- param = 1 ).
45
-
46
- foo = VALUE #(
47
- foo = bar
38
+ badExample: `CALL FUNCTION 'FOOBAR'
39
+ EXPORTING
40
+ foo = 2
41
+ parameter = 3.
42
+
43
+ foobar( moo = 1
44
+ param = 1 ).
45
+
46
+ foo = VALUE #(
47
+ foo = bar
48
48
  moo = 2 ).`,
49
- goodExample: `CALL FUNCTION 'FOOBAR'
50
- EXPORTING
51
- foo = 2
52
- parameter = 3.
53
-
54
- foobar( moo = 1
55
- param = 1 ).
56
-
57
- foo = VALUE #(
58
- foo = bar
49
+ goodExample: `CALL FUNCTION 'FOOBAR'
50
+ EXPORTING
51
+ foo = 2
52
+ parameter = 3.
53
+
54
+ foobar( moo = 1
55
+ param = 1 ).
56
+
57
+ foo = VALUE #(
58
+ foo = bar
59
59
  moo = 2 ).`,
60
60
  };
61
61
  }
@@ -20,14 +20,14 @@ class AmbiguousStatement extends _abap_rule_1.ABAPRule {
20
20
  return {
21
21
  key: "ambiguous_statement",
22
22
  title: "Check for ambigious statements",
23
- shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
24
- Add "TABLE" keyword or "@" for escaping SQL variables
25
-
23
+ shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
24
+ Add "TABLE" keyword or "@" for escaping SQL variables
25
+
26
26
  Only works if the target version is 740sp05 or above`,
27
27
  tags: [_irule_1.RuleTag.SingleFile],
28
- badExample: `DELETE foo FROM bar.
28
+ badExample: `DELETE foo FROM bar.
29
29
  MODIFY foo FROM bar.`,
30
- goodExample: `DELETE foo FROM @bar.
30
+ goodExample: `DELETE foo FROM @bar.
31
31
  MODIFY TABLE foo FROM bar.`,
32
32
  };
33
33
  }
@@ -35,12 +35,12 @@ class AvoidUse extends _abap_rule_1.ABAPRule {
35
35
  key: "avoid_use",
36
36
  title: "Avoid use of certain statements",
37
37
  shortDescription: `Detects usage of certain statements.`,
38
- extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
39
-
40
- Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
41
-
42
- STATICS: use CLASS-DATA instead
43
-
38
+ extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
39
+
40
+ Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
41
+
42
+ STATICS: use CLASS-DATA instead
43
+
44
44
  DESCRIBE TABLE LINES: use lines() instead (quickfix exists)`,
45
45
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
46
46
  };
@@ -23,11 +23,11 @@ class BeginEndNames extends _abap_rule_1.ABAPRule {
23
23
  title: "Check BEGIN END names",
24
24
  shortDescription: `Check BEGIN OF and END OF names match, plus there must be statements between BEGIN and END`,
25
25
  tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
26
- badExample: `DATA: BEGIN OF stru,
27
- field TYPE i,
26
+ badExample: `DATA: BEGIN OF stru,
27
+ field TYPE i,
28
28
  END OF structure_not_the_same.`,
29
- goodExample: `DATA: BEGIN OF stru,
30
- field TYPE i,
29
+ goodExample: `DATA: BEGIN OF stru,
30
+ field TYPE i,
31
31
  END OF stru.`,
32
32
  };
33
33
  }
@@ -21,19 +21,19 @@ class BeginSingleInclude extends _abap_rule_1.ABAPRule {
21
21
  title: "BEGIN contains single INCLUDE",
22
22
  shortDescription: `Finds TYPE BEGIN with just one INCLUDE TYPE, and DATA with single INCLUDE STRUCTURE`,
23
23
  tags: [_irule_1.RuleTag.SingleFile],
24
- badExample: `TYPES: BEGIN OF dummy1.
25
- INCLUDE TYPE dselc.
26
- TYPES: END OF dummy1.
27
-
28
- DATA BEGIN OF foo.
29
- INCLUDE STRUCTURE syst.
30
- DATA END OF foo.
31
-
32
- STATICS BEGIN OF bar.
33
- INCLUDE STRUCTURE syst.
24
+ badExample: `TYPES: BEGIN OF dummy1.
25
+ INCLUDE TYPE dselc.
26
+ TYPES: END OF dummy1.
27
+
28
+ DATA BEGIN OF foo.
29
+ INCLUDE STRUCTURE syst.
30
+ DATA END OF foo.
31
+
32
+ STATICS BEGIN OF bar.
33
+ INCLUDE STRUCTURE syst.
34
34
  STATICS END OF bar.`,
35
- goodExample: `DATA BEGIN OF foo.
36
- INCLUDE STRUCTURE dselc.
35
+ goodExample: `DATA BEGIN OF foo.
36
+ INCLUDE STRUCTURE dselc.
37
37
  DATA END OF foo.`,
38
38
  };
39
39
  }
@@ -24,9 +24,9 @@ class CallTransactionAuthorityCheck extends _abap_rule_1.ABAPRule {
24
24
  extendedInformation: `https://docs.abapopenchecks.org/checks/54/`,
25
25
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
26
26
  badExample: `CALL TRANSACTION 'FOO'.`,
27
- goodExample: `TRY.
28
- CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
29
- CATCH cx_sy_authorization_error.
27
+ goodExample: `TRY.
28
+ CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
29
+ CATCH cx_sy_authorization_error.
30
30
  ENDTRY.`,
31
31
  };
32
32
  }
@@ -45,10 +45,10 @@ class ChainMainlyDeclarations extends _abap_rule_1.ABAPRule {
45
45
  key: "chain_mainly_declarations",
46
46
  title: "Chain mainly declarations",
47
47
  shortDescription: `Chain mainly declarations, allows chaining for the configured statements, reports errors for other statements.`,
48
- extendedInformation: `
49
- https://docs.abapopenchecks.org/checks/23/
50
-
51
- https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
48
+ extendedInformation: `
49
+ https://docs.abapopenchecks.org/checks/23/
50
+
51
+ https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
52
52
  `,
53
53
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
54
54
  badExample: `CALL METHOD: bar.`,
@@ -23,8 +23,8 @@ class CheckAbstract extends _abap_rule_1.ABAPRule {
23
23
  return {
24
24
  key: "check_abstract",
25
25
  title: "Check abstract methods and classes",
26
- shortDescription: `Checks abstract methods and classes:
27
- - class defined as abstract and final,
26
+ shortDescription: `Checks abstract methods and classes:
27
+ - class defined as abstract and final,
28
28
  - non-abstract class contains abstract methods`,
29
29
  extendedInformation: `If a class defines only constants, use an interface instead`,
30
30
  tags: [_irule_1.RuleTag.SingleFile],
@@ -27,11 +27,11 @@ class CheckComments extends _abap_rule_1.ABAPRule {
27
27
  return {
28
28
  key: "check_comments",
29
29
  title: "Check Comments",
30
- shortDescription: `
30
+ shortDescription: `
31
31
  Various checks for comment usage.`,
32
- extendedInformation: `
33
- * End of line comments. Comments starting with "#EC" or "##" are ignored
34
-
32
+ extendedInformation: `
33
+ * End of line comments. Comments starting with "#EC" or "##" are ignored
34
+
35
35
  https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#put-comments-before-the-statement-they-relate-to`,
36
36
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
37
37
  };
@@ -17,9 +17,9 @@ class CheckInclude {
17
17
  key: "check_include",
18
18
  title: "Check INCLUDEs",
19
19
  shortDescription: `Checks INCLUDE statements`,
20
- extendedInformation: `
21
- * Reports unused includes
22
- * Errors if the includes are not found
20
+ extendedInformation: `
21
+ * Reports unused includes
22
+ * Errors if the includes are not found
23
23
  * Error if including a main program`,
24
24
  tags: [_irule_1.RuleTag.Syntax],
25
25
  };
@@ -21,15 +21,15 @@ class CheckNoHandlerPragma extends _abap_rule_1.ABAPRule {
21
21
  title: "Check if NO_HANDLER can be removed",
22
22
  shortDescription: `Checks NO_HANDLER pragmas that can be removed`,
23
23
  tags: [_irule_1.RuleTag.SingleFile],
24
- badExample: `TRY.
25
- ...
26
- CATCH zcx_abapgit_exception ##NO_HANDLER.
27
- RETURN. " it has a handler
24
+ badExample: `TRY.
25
+ ...
26
+ CATCH zcx_abapgit_exception ##NO_HANDLER.
27
+ RETURN. " it has a handler
28
28
  ENDTRY.`,
29
- goodExample: `TRY.
30
- ...
31
- CATCH zcx_abapgit_exception.
32
- RETURN.
29
+ goodExample: `TRY.
30
+ ...
31
+ CATCH zcx_abapgit_exception.
32
+ RETURN.
33
33
  ENDTRY.`,
34
34
  };
35
35
  }
@@ -34,14 +34,14 @@ class CheckSubrc extends _abap_rule_1.ABAPRule {
34
34
  key: "check_subrc",
35
35
  title: "Check sy-subrc",
36
36
  shortDescription: `Check sy-subrc`,
37
- extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
38
-
39
- If sy-dbcnt is checked after database statements, it is considered okay.
40
-
41
- "SELECT SINGLE @abap_true FROM " is considered as an existence check
42
-
43
- If IS ASSIGNED is checked after assigning, it is considered okay.
44
-
37
+ extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
38
+
39
+ If sy-dbcnt is checked after database statements, it is considered okay.
40
+
41
+ "SELECT SINGLE @abap_true FROM " is considered as an existence check
42
+
43
+ If IS ASSIGNED is checked after assigning, it is considered okay.
44
+
45
45
  FIND statement with MATCH COUNT is considered okay if subrc is not checked`,
46
46
  tags: [_irule_1.RuleTag.SingleFile],
47
47
  pseudoComment: "EC CI_SUBRC",
@@ -30,7 +30,7 @@ class CommentedCode extends _abap_rule_1.ABAPRule {
30
30
  key: "commented_code",
31
31
  title: "Find commented code",
32
32
  shortDescription: `Detects usage of commented out code.`,
33
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
33
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
34
34
  https://docs.abapopenchecks.org/checks/14/`,
35
35
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
36
36
  };
@@ -18,10 +18,10 @@ class ConstructorVisibilityPublic {
18
18
  key: "constructor_visibility_public",
19
19
  title: "Check constructor visibility is public",
20
20
  shortDescription: `Constructor must be placed in the public section, even if the class is not CREATE PUBLIC.`,
21
- extendedInformation: `
22
- This only applies to global classes.
23
-
24
- https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
21
+ extendedInformation: `
22
+ This only applies to global classes.
23
+
24
+ https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
25
25
  https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abeninstance_constructor_guidl.htm`,
26
26
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
27
27
  };
@@ -25,8 +25,8 @@ class ContainsTab extends _abap_rule_1.ABAPRule {
25
25
  key: "contains_tab",
26
26
  title: "Code contains tab",
27
27
  shortDescription: `Checks for usage of tabs (enable to enforce spaces)`,
28
- extendedInformation: `
29
- https://docs.abapopenchecks.org/checks/09/
28
+ extendedInformation: `
29
+ https://docs.abapopenchecks.org/checks/09/
30
30
  https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#indent-and-snap-to-tab`,
31
31
  tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
32
32
  };
@@ -40,7 +40,7 @@ class DangerousStatement extends _abap_rule_1.ABAPRule {
40
40
  key: "dangerous_statement",
41
41
  title: "Dangerous statement",
42
42
  shortDescription: `Detects potentially dangerous statements`,
43
- extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
43
+ extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
44
44
  dynamic SQL can potentially create SQL injection problems`,
45
45
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
46
46
  };
@@ -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
  };
@@ -214,6 +214,10 @@ Only one transformation is applied to a statement at a time, so multiple steps m
214
214
  if (found) {
215
215
  return found;
216
216
  }
217
+ found = this.outlineCatchSimple(high, lowFile);
218
+ if (found) {
219
+ return found;
220
+ }
217
221
  found = this.outlineDataSimple(high, lowFile);
218
222
  if (found) {
219
223
  return found;
@@ -254,8 +258,8 @@ Only one transformation is applied to a statement at a time, so multiple steps m
254
258
  if (!(low.get() instanceof _statement_1.Unknown)) {
255
259
  return undefined;
256
260
  }
257
- // todo: select loop
258
261
  if (!(high.get() instanceof Statements.Select)
262
+ && !(high.get() instanceof Statements.SelectLoop)
259
263
  && !(high.get() instanceof Statements.UpdateDatabase)
260
264
  && !(high.get() instanceof Statements.ModifyDatabase)
261
265
  && !(high.get() instanceof Statements.DeleteDatabase)
@@ -362,10 +366,10 @@ Only one transformation is applied to a statement at a time, so multiple steps m
362
366
  const fieldName = f.concatTokens();
363
367
  fieldDefinition += indentation + " " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
364
368
  }
365
- fieldDefinition = `DATA: BEGIN OF ${name},
369
+ fieldDefinition = `DATA: BEGIN OF ${name},
366
370
  ${fieldDefinition}${indentation} END OF ${name}.`;
367
371
  }
368
- const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
372
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
369
373
  ${indentation}`);
370
374
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
371
375
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -406,12 +410,12 @@ ${indentation}`);
406
410
  }
407
411
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
408
412
  const name = ((_c = inlineData.findFirstExpression(Expressions.TargetField)) === null || _c === void 0 ? void 0 : _c.concatTokens()) || "error";
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.
413
+ let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
414
+ ${fieldDefinitions}${indentation} END OF ${uniqueName}.
415
+ ${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
412
416
  ${indentation}`);
413
417
  if (fieldDefinitions === "") {
414
- fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
418
+ fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
415
419
  ${indentation}`);
416
420
  }
417
421
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
@@ -432,7 +436,7 @@ ${indentation}`);
432
436
  const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
433
437
  const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
434
438
  const firstToken = high.getFirstToken();
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()}.
439
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
436
440
  ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
437
441
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
438
442
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -476,11 +480,11 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
476
480
  const uniqueName = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
477
481
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
478
482
  const firstToken = node.getFirstToken();
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.
483
+ const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
484
+ ${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
485
+ ${indentation}IF sy-subrc <> 0.
486
+ ${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
487
+ ${indentation}ENDIF.
484
488
  ${indentation}`);
485
489
  const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, startToken.getStart(), tableExpression.getLastToken().getEnd(), uniqueName);
486
490
  const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -488,6 +492,28 @@ ${indentation}`);
488
492
  }
489
493
  return undefined;
490
494
  }
495
+ outlineCatchSimple(node, lowFile) {
496
+ // outlines "CATCH cx_bcs INTO DATA(lx_bcs_excep).", note that this does not need to look at types
497
+ var _a, _b;
498
+ if (!(node.get() instanceof Statements.Catch)) {
499
+ return undefined;
500
+ }
501
+ const target = node.findFirstExpression(Expressions.Target);
502
+ if (!(((_a = target === null || target === void 0 ? void 0 : target.getFirstChild()) === null || _a === void 0 ? void 0 : _a.get()) instanceof Expressions.InlineData)) {
503
+ return undefined;
504
+ }
505
+ const classNames = node.findDirectExpressions(Expressions.ClassName);
506
+ if (classNames.length !== 1) {
507
+ return undefined;
508
+ }
509
+ const className = classNames[0].concatTokens();
510
+ const targetName = (_b = target.findFirstExpression(Expressions.TargetField)) === null || _b === void 0 ? void 0 : _b.concatTokens();
511
+ const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
512
+ const code = ` DATA ${targetName} TYPE REF TO ${className}.
513
+ ${indentation}CATCH ${className} INTO ${targetName}.`;
514
+ const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getStart(), node.getEnd(), code);
515
+ return issue_1.Issue.atToken(lowFile, node.getFirstToken(), "Outline DATA", this.getMetadata().key, this.conf.severity, fix);
516
+ }
491
517
  outlineDataSimple(node, lowFile) {
492
518
  // outlines "DATA(ls_msg) = temp1.", note that this does not need to look at types
493
519
  var _a, _b, _c;
@@ -594,11 +620,11 @@ ${indentation}`);
594
620
  const uniqueName1 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
595
621
  const uniqueName2 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
596
622
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
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}.
623
+ const abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
624
+ ${indentation}${uniqueName1}-msgid = ${id}.
625
+ ${indentation}${uniqueName1}-msgno = ${number}.
626
+ ${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
627
+ ${indentation}CREATE OBJECT ${uniqueName2} EXPORTING textid = ${uniqueName1}.
602
628
  ${indentation}RAISE EXCEPTION ${uniqueName2}.`;
603
629
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getStart(), node.getEnd(), abap);
604
630
  return issue_1.Issue.atToken(lowFile, startToken, "Downport RAISE MESSAGE", this.getMetadata().key, this.conf.severity, fix);
@@ -735,10 +761,10 @@ ${indentation}RAISE EXCEPTION ${uniqueName2}.`;
735
761
  const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
736
762
  const source = (_b = templateSource === null || templateSource === void 0 ? void 0 : templateSource.findDirectExpression(Expressions.Source)) === null || _b === void 0 ? void 0 : _b.concatTokens();
737
763
  const topTarget = (_c = node.findDirectExpression(Expressions.Target)) === null || _c === void 0 ? void 0 : _c.concatTokens();
738
- const code = `CALL FUNCTION '${functionName}'
739
- ${indentation} EXPORTING
740
- ${indentation} input = ${source}
741
- ${indentation} IMPORTING
764
+ const code = `CALL FUNCTION '${functionName}'
765
+ ${indentation} EXPORTING
766
+ ${indentation} input = ${source}
767
+ ${indentation} IMPORTING
742
768
  ${indentation} output = ${topTarget}.`;
743
769
  const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getFirstToken().getStart(), node.getLastToken().getEnd(), code);
744
770
  return issue_1.Issue.atToken(lowFile, node.getFirstToken(), "Downport ALPHA", this.getMetadata().key, this.conf.severity, fix);