@abaplint/core 2.113.81 → 2.113.82
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.
- package/README.md +6 -6
- package/build/src/abap/flow/flow_graph.js +7 -7
- package/build/src/lsp/help.js +10 -10
- package/build/src/registry.js +1 -1
- package/build/src/rules/7bit_ascii.js +4 -4
- package/build/src/rules/abapdoc.js +4 -4
- package/build/src/rules/add_test_attributes.js +20 -20
- package/build/src/rules/align_parameters.js +40 -40
- package/build/src/rules/align_type_expressions.js +28 -28
- package/build/src/rules/ambiguous_statement.js +7 -7
- package/build/src/rules/avoid_use.js +10 -10
- package/build/src/rules/begin_end_names.js +4 -4
- package/build/src/rules/begin_single_include.js +13 -13
- package/build/src/rules/call_transaction_authority_check.js +3 -3
- package/build/src/rules/cds_comment_style.js +4 -4
- package/build/src/rules/cds_legacy_view.js +4 -4
- package/build/src/rules/chain_mainly_declarations.js +4 -4
- package/build/src/rules/change_if_to_case.js +8 -8
- package/build/src/rules/check_abstract.js +2 -2
- package/build/src/rules/check_comments.js +4 -4
- package/build/src/rules/check_include.js +3 -3
- package/build/src/rules/check_subrc.js +8 -8
- package/build/src/rules/classic_exceptions_overlap.js +10 -10
- package/build/src/rules/commented_code.js +1 -1
- package/build/src/rules/constructor_visibility_public.js +4 -4
- package/build/src/rules/contains_tab.js +2 -2
- package/build/src/rules/cyclic_oo.js +4 -4
- package/build/src/rules/dangerous_statement.js +1 -1
- package/build/src/rules/definitions_top.js +6 -6
- package/build/src/rules/downport.js +122 -108
- package/build/src/rules/easy_to_find_messages.js +6 -6
- package/build/src/rules/empty_event.js +6 -6
- package/build/src/rules/empty_line_in_statement.js +2 -2
- package/build/src/rules/empty_structure.js +6 -6
- package/build/src/rules/exit_or_check.js +3 -3
- package/build/src/rules/expand_macros.js +5 -5
- package/build/src/rules/exporting.js +1 -1
- package/build/src/rules/forbidden_identifier.js +1 -1
- package/build/src/rules/forbidden_void_type.js +2 -2
- package/build/src/rules/fully_type_itabs.js +2 -2
- package/build/src/rules/functional_writing.js +17 -17
- package/build/src/rules/global_class.js +8 -8
- package/build/src/rules/identical_conditions.js +12 -12
- package/build/src/rules/identical_contents.js +14 -14
- package/build/src/rules/identical_descriptions.js +6 -6
- package/build/src/rules/if_in_if.js +35 -35
- package/build/src/rules/implement_methods.js +3 -3
- package/build/src/rules/implicit_start_of_selection.js +5 -5
- package/build/src/rules/in_statement_indentation.js +11 -11
- package/build/src/rules/indentation.js +16 -16
- package/build/src/rules/intf_referencing_clas.js +3 -3
- package/build/src/rules/invalid_table_index.js +2 -2
- package/build/src/rules/line_break_style.js +2 -2
- package/build/src/rules/line_length.js +1 -1
- package/build/src/rules/line_only_punc.js +1 -1
- package/build/src/rules/local_variable_names.js +6 -6
- package/build/src/rules/macro_naming.js +2 -2
- package/build/src/rules/main_file_contents.js +4 -4
- package/build/src/rules/many_parentheses.js +10 -10
- package/build/src/rules/max_one_method_parameter_per_line.js +7 -7
- package/build/src/rules/max_one_statement.js +5 -5
- package/build/src/rules/method_length.js +2 -2
- package/build/src/rules/method_overwrites_builtin.js +12 -12
- package/build/src/rules/mix_returning.js +6 -6
- package/build/src/rules/nesting.js +1 -1
- package/build/src/rules/no_chained_assignment.js +1 -1
- package/build/src/rules/no_external_form_calls.js +2 -2
- package/build/src/rules/no_inline_in_optional_branches.js +11 -11
- package/build/src/rules/no_prefixes.js +6 -6
- package/build/src/rules/no_public_attributes.js +1 -1
- package/build/src/rules/no_yoda_conditions.js +4 -4
- package/build/src/rules/nrob_consistency.js +2 -2
- package/build/src/rules/obsolete_statement.js +51 -51
- package/build/src/rules/omit_parameter_name.js +3 -3
- package/build/src/rules/omit_receiving.js +13 -13
- package/build/src/rules/parser_702_chaining.js +2 -2
- package/build/src/rules/parser_error.js +2 -2
- package/build/src/rules/parser_missing_space.js +1 -1
- package/build/src/rules/prefer_inline.js +16 -16
- package/build/src/rules/prefer_is_not.js +9 -9
- package/build/src/rules/prefer_raise_exception_new.js +5 -5
- package/build/src/rules/prefer_returning_to_exporting.js +4 -4
- package/build/src/rules/prefer_xsdbool.js +2 -2
- package/build/src/rules/preferred_compare_operator.js +2 -2
- package/build/src/rules/reduce_procedural_code.js +17 -17
- package/build/src/rules/remove_descriptions.js +4 -4
- package/build/src/rules/rfc_error_handling.js +7 -7
- package/build/src/rules/select_add_order_by.js +5 -5
- package/build/src/rules/select_performance.js +5 -5
- package/build/src/rules/select_single_full_key.js +2 -2
- package/build/src/rules/sicf_consistency.js +2 -2
- package/build/src/rules/slow_parameter_passing.js +16 -16
- package/build/src/rules/space_before_dot.js +2 -2
- package/build/src/rules/sql_value_conversion.js +6 -6
- package/build/src/rules/start_at_tab.js +1 -1
- package/build/src/rules/strict_sql.js +6 -6
- package/build/src/rules/sy_modification.js +3 -3
- package/build/src/rules/tabl_enhancement_category.js +2 -2
- package/build/src/rules/tables_declared_locally.js +2 -2
- package/build/src/rules/type_form_parameters.js +2 -2
- package/build/src/rules/unnecessary_pragma.js +29 -29
- package/build/src/rules/unnecessary_return.js +11 -11
- package/build/src/rules/unused_macros.js +6 -6
- package/build/src/rules/unused_methods.js +12 -12
- package/build/src/rules/unused_variables.js +12 -12
- package/build/src/rules/use_bool_expression.js +8 -8
- package/build/src/rules/use_class_based_exceptions.js +8 -8
- package/build/src/rules/use_line_exists.js +6 -6
- package/build/src/rules/use_new.js +4 -4
- package/build/src/rules/when_others_last.js +6 -6
- package/package.json +70 -70
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
|
|
@@ -94,13 +94,13 @@ class FlowGraph {
|
|
|
94
94
|
this.label = label;
|
|
95
95
|
}
|
|
96
96
|
toDigraph() {
|
|
97
|
-
return `digraph G {
|
|
98
|
-
labelloc="t";
|
|
99
|
-
label="${this.label}";
|
|
100
|
-
graph [fontname = "helvetica"];
|
|
101
|
-
node [fontname = "helvetica", shape="box"];
|
|
102
|
-
edge [fontname = "helvetica"];
|
|
103
|
-
${this.toTextEdges()}
|
|
97
|
+
return `digraph G {
|
|
98
|
+
labelloc="t";
|
|
99
|
+
label="${this.label}";
|
|
100
|
+
graph [fontname = "helvetica"];
|
|
101
|
+
node [fontname = "helvetica", shape="box"];
|
|
102
|
+
edge [fontname = "helvetica"];
|
|
103
|
+
${this.toTextEdges()}
|
|
104
104
|
}`;
|
|
105
105
|
}
|
|
106
106
|
listSources(node) {
|
package/build/src/lsp/help.js
CHANGED
|
@@ -20,13 +20,13 @@ class Help {
|
|
|
20
20
|
/////////////////////////////////////////////////
|
|
21
21
|
static dumpABAP(file, reg, textDocument, position) {
|
|
22
22
|
let content = "";
|
|
23
|
-
content = `
|
|
24
|
-
<a href="#_tokens" rel="no-refresh">Tokens</a> |
|
|
25
|
-
<a href="#_statements" rel="no-refresh">Statements</a> |
|
|
26
|
-
<a href="#_structure" rel="no-refresh">Structure</a> |
|
|
27
|
-
<a href="#_files" rel="no-refresh">Files</a> |
|
|
28
|
-
<a href="#_info" rel="no-refresh">Info Dump</a>
|
|
29
|
-
<hr>
|
|
23
|
+
content = `
|
|
24
|
+
<a href="#_tokens" rel="no-refresh">Tokens</a> |
|
|
25
|
+
<a href="#_statements" rel="no-refresh">Statements</a> |
|
|
26
|
+
<a href="#_structure" rel="no-refresh">Structure</a> |
|
|
27
|
+
<a href="#_files" rel="no-refresh">Files</a> |
|
|
28
|
+
<a href="#_info" rel="no-refresh">Info Dump</a>
|
|
29
|
+
<hr>
|
|
30
30
|
` +
|
|
31
31
|
"<tt>" + textDocument.uri + " (" +
|
|
32
32
|
(position.line + 1) + ", " +
|
|
@@ -181,9 +181,9 @@ class Help {
|
|
|
181
181
|
return ret + "</ul>";
|
|
182
182
|
}
|
|
183
183
|
static tokens(file) {
|
|
184
|
-
let inner = `<table><tr><td><b>String</b></td><td><b>Type</b></td>
|
|
185
|
-
<td><b>Row</b></td><td><b>Column</b></td>
|
|
186
|
-
<td><b>vRow</b></td><td><b>vColumn</b></td>
|
|
184
|
+
let inner = `<table><tr><td><b>String</b></td><td><b>Type</b></td>
|
|
185
|
+
<td><b>Row</b></td><td><b>Column</b></td>
|
|
186
|
+
<td><b>vRow</b></td><td><b>vColumn</b></td>
|
|
187
187
|
</tr>`;
|
|
188
188
|
for (const token of file.getTokens()) {
|
|
189
189
|
const tStart = token.getStart();
|
package/build/src/registry.js
CHANGED
|
@@ -17,10 +17,10 @@ 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
|
-
|
|
22
|
-
https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abencharacter_set_guidl.htm
|
|
23
|
-
|
|
20
|
+
extendedInformation: `https://docs.abapopenchecks.org/checks/05/
|
|
21
|
+
|
|
22
|
+
https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abencharacter_set_guidl.htm
|
|
23
|
+
|
|
24
24
|
Checkes files with extensions ".abap" and ".asddls"`,
|
|
25
25
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
26
26
|
badExample: `WRITE '뽑'.`,
|
|
@@ -28,10 +28,10 @@ class Abapdoc extends _abap_rule_1.ABAPRule {
|
|
|
28
28
|
key: "abapdoc",
|
|
29
29
|
title: "Check abapdoc",
|
|
30
30
|
shortDescription: `Various checks regarding abapdoc.`,
|
|
31
|
-
extendedInformation: `Base rule checks for existence of abapdoc for public class methods and all interface methods.
|
|
32
|
-
|
|
33
|
-
Plus class and interface definitions.
|
|
34
|
-
|
|
31
|
+
extendedInformation: `Base rule checks for existence of abapdoc for public class methods and all interface methods.
|
|
32
|
+
|
|
33
|
+
Plus class and interface definitions.
|
|
34
|
+
|
|
35
35
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#abap-doc-only-for-public-apis`,
|
|
36
36
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
|
|
37
37
|
};
|
|
@@ -21,27 +21,27 @@ class AddTestAttributes extends _abap_rule_1.ABAPRule {
|
|
|
21
21
|
title: "Add test attributes for tests classes with test methods",
|
|
22
22
|
shortDescription: `Add test attributes DURATION and RISK LEVEL for tests classes with test methods`,
|
|
23
23
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
24
|
-
badExample: `CLASS ltcl_test1 DEFINITION FINAL FOR TESTING.
|
|
25
|
-
PUBLIC SECTION.
|
|
26
|
-
PROTECTED SECTION.
|
|
27
|
-
PRIVATE SECTION.
|
|
28
|
-
METHODS test FOR TESTING RAISING cx_static_check.
|
|
29
|
-
ENDCLASS.
|
|
30
|
-
|
|
31
|
-
CLASS ltcl_test1 IMPLEMENTATION.
|
|
32
|
-
METHOD test.
|
|
33
|
-
ENDMETHOD.
|
|
24
|
+
badExample: `CLASS ltcl_test1 DEFINITION FINAL FOR TESTING.
|
|
25
|
+
PUBLIC SECTION.
|
|
26
|
+
PROTECTED SECTION.
|
|
27
|
+
PRIVATE SECTION.
|
|
28
|
+
METHODS test FOR TESTING RAISING cx_static_check.
|
|
29
|
+
ENDCLASS.
|
|
30
|
+
|
|
31
|
+
CLASS ltcl_test1 IMPLEMENTATION.
|
|
32
|
+
METHOD test.
|
|
33
|
+
ENDMETHOD.
|
|
34
34
|
ENDCLASS.`,
|
|
35
|
-
goodExample: `CLASS ltcl_test2 DEFINITION FINAL FOR TESTING DURATION SHORT RISK LEVEL HARMLESS.
|
|
36
|
-
PUBLIC SECTION.
|
|
37
|
-
PROTECTED SECTION.
|
|
38
|
-
PRIVATE SECTION.
|
|
39
|
-
METHODS test FOR TESTING RAISING cx_static_check.
|
|
40
|
-
ENDCLASS.
|
|
41
|
-
|
|
42
|
-
CLASS ltcl_test2 IMPLEMENTATION.
|
|
43
|
-
METHOD test.
|
|
44
|
-
ENDMETHOD.
|
|
35
|
+
goodExample: `CLASS ltcl_test2 DEFINITION FINAL FOR TESTING DURATION SHORT RISK LEVEL HARMLESS.
|
|
36
|
+
PUBLIC SECTION.
|
|
37
|
+
PROTECTED SECTION.
|
|
38
|
+
PRIVATE SECTION.
|
|
39
|
+
METHODS test FOR TESTING RAISING cx_static_check.
|
|
40
|
+
ENDCLASS.
|
|
41
|
+
|
|
42
|
+
CLASS ltcl_test2 IMPLEMENTATION.
|
|
43
|
+
METHOD test.
|
|
44
|
+
ENDMETHOD.
|
|
45
45
|
ENDCLASS.`,
|
|
46
46
|
};
|
|
47
47
|
}
|
|
@@ -22,49 +22,49 @@ class AlignParameters extends _abap_rule_1.ABAPRule {
|
|
|
22
22
|
key: "align_parameters",
|
|
23
23
|
title: "Align Parameters",
|
|
24
24
|
shortDescription: `Checks for vertially aligned parameters`,
|
|
25
|
-
extendedInformation: `Checks:
|
|
26
|
-
* function module calls
|
|
27
|
-
* method calls
|
|
28
|
-
* VALUE constructors
|
|
29
|
-
* NEW constructors
|
|
30
|
-
* RAISE EXCEPTION statements
|
|
31
|
-
* CREATE OBJECT statements
|
|
32
|
-
* RAISE EVENT statements
|
|
33
|
-
|
|
34
|
-
https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
|
|
35
|
-
|
|
36
|
-
Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
|
|
37
|
-
|
|
38
|
-
If parameters are on the same row, no issues are reported, see
|
|
25
|
+
extendedInformation: `Checks:
|
|
26
|
+
* function module calls
|
|
27
|
+
* method calls
|
|
28
|
+
* VALUE constructors
|
|
29
|
+
* NEW constructors
|
|
30
|
+
* RAISE EXCEPTION statements
|
|
31
|
+
* CREATE OBJECT statements
|
|
32
|
+
* RAISE EVENT statements
|
|
33
|
+
|
|
34
|
+
https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
|
|
35
|
+
|
|
36
|
+
Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
|
|
37
|
+
|
|
38
|
+
If parameters are on the same row, no issues are reported, see
|
|
39
39
|
https://rules.abaplint.org/max_one_method_parameter_per_line/ for splitting parameters to lines`,
|
|
40
40
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix],
|
|
41
|
-
badExample: `CALL FUNCTION 'FOOBAR'
|
|
42
|
-
EXPORTING
|
|
43
|
-
foo = 2
|
|
44
|
-
parameter = 3.
|
|
45
|
-
|
|
46
|
-
foobar( moo = 1
|
|
47
|
-
param = 1 ).
|
|
48
|
-
|
|
49
|
-
foo = VALUE #(
|
|
50
|
-
foo = bar
|
|
41
|
+
badExample: `CALL FUNCTION 'FOOBAR'
|
|
42
|
+
EXPORTING
|
|
43
|
+
foo = 2
|
|
44
|
+
parameter = 3.
|
|
45
|
+
|
|
46
|
+
foobar( moo = 1
|
|
47
|
+
param = 1 ).
|
|
48
|
+
|
|
49
|
+
foo = VALUE #(
|
|
50
|
+
foo = bar
|
|
51
51
|
moo = 2 ).`,
|
|
52
|
-
goodExample: `CALL FUNCTION 'FOOBAR'
|
|
53
|
-
EXPORTING
|
|
54
|
-
foo = 2
|
|
55
|
-
parameter = 3.
|
|
56
|
-
|
|
57
|
-
foobar( moo = 1
|
|
58
|
-
param = 1 ).
|
|
59
|
-
|
|
60
|
-
foo = VALUE #(
|
|
61
|
-
foo = bar
|
|
62
|
-
moo = 2 ).
|
|
63
|
-
|
|
64
|
-
DATA(sdf) = VALUE type(
|
|
65
|
-
common_val = 2
|
|
66
|
-
another_common = 5
|
|
67
|
-
( row_value = 4
|
|
52
|
+
goodExample: `CALL FUNCTION 'FOOBAR'
|
|
53
|
+
EXPORTING
|
|
54
|
+
foo = 2
|
|
55
|
+
parameter = 3.
|
|
56
|
+
|
|
57
|
+
foobar( moo = 1
|
|
58
|
+
param = 1 ).
|
|
59
|
+
|
|
60
|
+
foo = VALUE #(
|
|
61
|
+
foo = bar
|
|
62
|
+
moo = 2 ).
|
|
63
|
+
|
|
64
|
+
DATA(sdf) = VALUE type(
|
|
65
|
+
common_val = 2
|
|
66
|
+
another_common = 5
|
|
67
|
+
( row_value = 4
|
|
68
68
|
value_foo = 5 ) ).`,
|
|
69
69
|
};
|
|
70
70
|
}
|
|
@@ -30,37 +30,37 @@ class AlignTypeExpressions extends _abap_rule_1.ABAPRule {
|
|
|
30
30
|
key: "align_type_expressions",
|
|
31
31
|
title: "Align TYPE expressions",
|
|
32
32
|
shortDescription: `Align TYPE expressions in statements`,
|
|
33
|
-
extendedInformation: `
|
|
34
|
-
Currently works for METHODS + BEGIN OF
|
|
35
|
-
|
|
36
|
-
If BEGIN OF has an INCLUDE TYPE its ignored
|
|
37
|
-
|
|
38
|
-
Also note that clean ABAP does not recommend aligning TYPE clauses:
|
|
33
|
+
extendedInformation: `
|
|
34
|
+
Currently works for METHODS + BEGIN OF
|
|
35
|
+
|
|
36
|
+
If BEGIN OF has an INCLUDE TYPE its ignored
|
|
37
|
+
|
|
38
|
+
Also note that clean ABAP does not recommend aligning TYPE clauses:
|
|
39
39
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-align-type-clauses`,
|
|
40
40
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix],
|
|
41
|
-
badExample: `
|
|
42
|
-
TYPES: BEGIN OF foo,
|
|
43
|
-
bar TYPE i,
|
|
44
|
-
foobar TYPE i,
|
|
45
|
-
END OF foo.
|
|
46
|
-
|
|
47
|
-
INTERFACE lif.
|
|
48
|
-
METHODS bar
|
|
49
|
-
IMPORTING
|
|
50
|
-
foo TYPE i
|
|
51
|
-
foobar TYPE i.
|
|
41
|
+
badExample: `
|
|
42
|
+
TYPES: BEGIN OF foo,
|
|
43
|
+
bar TYPE i,
|
|
44
|
+
foobar TYPE i,
|
|
45
|
+
END OF foo.
|
|
46
|
+
|
|
47
|
+
INTERFACE lif.
|
|
48
|
+
METHODS bar
|
|
49
|
+
IMPORTING
|
|
50
|
+
foo TYPE i
|
|
51
|
+
foobar TYPE i.
|
|
52
52
|
ENDINTERFACE.`,
|
|
53
|
-
goodExample: `
|
|
54
|
-
TYPES: BEGIN OF foo,
|
|
55
|
-
bar TYPE i,
|
|
56
|
-
foobar TYPE i,
|
|
57
|
-
END OF foo.
|
|
58
|
-
|
|
59
|
-
INTERFACE lif.
|
|
60
|
-
METHODS bar
|
|
61
|
-
IMPORTING
|
|
62
|
-
foo TYPE i
|
|
63
|
-
foobar TYPE i.
|
|
53
|
+
goodExample: `
|
|
54
|
+
TYPES: BEGIN OF foo,
|
|
55
|
+
bar TYPE i,
|
|
56
|
+
foobar TYPE i,
|
|
57
|
+
END OF foo.
|
|
58
|
+
|
|
59
|
+
INTERFACE lif.
|
|
60
|
+
METHODS bar
|
|
61
|
+
IMPORTING
|
|
62
|
+
foo TYPE i
|
|
63
|
+
foobar TYPE i.
|
|
64
64
|
ENDINTERFACE.`,
|
|
65
65
|
};
|
|
66
66
|
}
|
|
@@ -20,16 +20,16 @@ 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.
|
|
31
|
-
DELETE TABLE itab FROM 2.
|
|
32
|
-
MODIFY zfoo FROM @wa.
|
|
30
|
+
goodExample: `DELETE foo FROM @bar.
|
|
31
|
+
DELETE TABLE itab FROM 2.
|
|
32
|
+
MODIFY zfoo FROM @wa.
|
|
33
33
|
MODIFY TABLE foo FROM bar.`,
|
|
34
34
|
};
|
|
35
35
|
}
|
|
@@ -44,16 +44,16 @@ class AvoidUse extends _abap_rule_1.ABAPRule {
|
|
|
44
44
|
key: "avoid_use",
|
|
45
45
|
title: "Avoid use of certain statements",
|
|
46
46
|
shortDescription: `Detects usage of certain statements.`,
|
|
47
|
-
extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
|
|
48
|
-
|
|
49
|
-
Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
|
|
50
|
-
|
|
51
|
-
STATICS: use CLASS-DATA instead
|
|
52
|
-
|
|
53
|
-
DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
|
|
54
|
-
|
|
55
|
-
TEST-SEAMS: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-test-seams-as-temporary-workaround
|
|
56
|
-
|
|
47
|
+
extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
|
|
48
|
+
|
|
49
|
+
Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
|
|
50
|
+
|
|
51
|
+
STATICS: use CLASS-DATA instead
|
|
52
|
+
|
|
53
|
+
DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
|
|
54
|
+
|
|
55
|
+
TEST-SEAMS: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-test-seams-as-temporary-workaround
|
|
56
|
+
|
|
57
57
|
BREAK points`,
|
|
58
58
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
59
59
|
};
|
|
@@ -24,11 +24,11 @@ class BeginEndNames extends _abap_rule_1.ABAPRule {
|
|
|
24
24
|
title: "Check BEGIN END names",
|
|
25
25
|
shortDescription: `Check BEGIN OF and END OF names match, plus there must be statements between BEGIN and END`,
|
|
26
26
|
tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
27
|
-
badExample: `DATA: BEGIN OF stru,
|
|
28
|
-
field TYPE i,
|
|
27
|
+
badExample: `DATA: BEGIN OF stru,
|
|
28
|
+
field TYPE i,
|
|
29
29
|
END OF structure_not_the_same.`,
|
|
30
|
-
goodExample: `DATA: BEGIN OF stru,
|
|
31
|
-
field TYPE i,
|
|
30
|
+
goodExample: `DATA: BEGIN OF stru,
|
|
31
|
+
field TYPE i,
|
|
32
32
|
END OF stru.`,
|
|
33
33
|
};
|
|
34
34
|
}
|
|
@@ -21,20 +21,20 @@ 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
|
-
DATA field TYPE i.
|
|
37
|
-
INCLUDE STRUCTURE dselc.
|
|
35
|
+
goodExample: `DATA BEGIN OF foo.
|
|
36
|
+
DATA field TYPE i.
|
|
37
|
+
INCLUDE STRUCTURE dselc.
|
|
38
38
|
DATA END OF foo.`,
|
|
39
39
|
};
|
|
40
40
|
}
|
|
@@ -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
|
}
|
|
@@ -19,10 +19,10 @@ class CDSCommentStyle {
|
|
|
19
19
|
key: "cds_comment_style",
|
|
20
20
|
title: "CDS Comment Style",
|
|
21
21
|
shortDescription: `Check for obsolete comment style`,
|
|
22
|
-
extendedInformation: `Check for obsolete comment style
|
|
23
|
-
|
|
24
|
-
Comments starting with "--" are considered obsolete
|
|
25
|
-
|
|
22
|
+
extendedInformation: `Check for obsolete comment style
|
|
23
|
+
|
|
24
|
+
Comments starting with "--" are considered obsolete
|
|
25
|
+
|
|
26
26
|
https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abencds_general_syntax_rules.htm`,
|
|
27
27
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
28
28
|
badExample: "-- this is a comment",
|
|
@@ -18,10 +18,10 @@ class CDSLegacyView {
|
|
|
18
18
|
key: "cds_legacy_view",
|
|
19
19
|
title: "CDS Legacy View",
|
|
20
20
|
shortDescription: `Identify CDS Legacy Views`,
|
|
21
|
-
extendedInformation: `Use DEFINE VIEW ENTITY instead of DEFINE VIEW
|
|
22
|
-
|
|
23
|
-
https://blogs.sap.com/2021/10/16/a-new-generation-of-cds-views-how-to-migrate-your-cds-views-to-cds-view-entities/
|
|
24
|
-
|
|
21
|
+
extendedInformation: `Use DEFINE VIEW ENTITY instead of DEFINE VIEW
|
|
22
|
+
|
|
23
|
+
https://blogs.sap.com/2021/10/16/a-new-generation-of-cds-views-how-to-migrate-your-cds-views-to-cds-view-entities/
|
|
24
|
+
|
|
25
25
|
v755 and up`,
|
|
26
26
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Upport],
|
|
27
27
|
};
|
|
@@ -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.`,
|
|
@@ -29,17 +29,17 @@ class ChangeIfToCase extends _abap_rule_1.ABAPRule {
|
|
|
29
29
|
title: "Change IF to CASE",
|
|
30
30
|
shortDescription: `Finds IF constructs that can be changed to CASE`,
|
|
31
31
|
// eslint-disable-next-line max-len
|
|
32
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-case-to-else-if-for-multiple-alternative-conditions
|
|
33
|
-
|
|
32
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-case-to-else-if-for-multiple-alternative-conditions
|
|
33
|
+
|
|
34
34
|
If the first comparison is a boolean compare, no issue is reported.`,
|
|
35
35
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
|
|
36
|
-
badExample: `IF l_fcat-fieldname EQ 'FOO'.
|
|
37
|
-
ELSEIF l_fcat-fieldname = 'BAR'
|
|
38
|
-
OR l_fcat-fieldname = 'MOO'.
|
|
36
|
+
badExample: `IF l_fcat-fieldname EQ 'FOO'.
|
|
37
|
+
ELSEIF l_fcat-fieldname = 'BAR'
|
|
38
|
+
OR l_fcat-fieldname = 'MOO'.
|
|
39
39
|
ENDIF.`,
|
|
40
|
-
goodExample: `CASE l_fcat-fieldname.
|
|
41
|
-
WHEN 'FOO'.
|
|
42
|
-
WHEN 'BAR' OR 'MOO'.
|
|
40
|
+
goodExample: `CASE l_fcat-fieldname.
|
|
41
|
+
WHEN 'FOO'.
|
|
42
|
+
WHEN 'BAR' OR 'MOO'.
|
|
43
43
|
ENDCASE.`,
|
|
44
44
|
};
|
|
45
45
|
}
|
|
@@ -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
|
-
Detects end of line comments. Comments starting with "#EC" or "##" are ignored
|
|
34
|
-
|
|
32
|
+
extendedInformation: `
|
|
33
|
+
Detects 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
|
badExample: `WRITE 2. " descriptive comment`,
|
|
@@ -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
|
};
|
|
@@ -35,14 +35,14 @@ class CheckSubrc extends _abap_rule_1.ABAPRule {
|
|
|
35
35
|
key: "check_subrc",
|
|
36
36
|
title: "Check sy-subrc",
|
|
37
37
|
shortDescription: `Check sy-subrc`,
|
|
38
|
-
extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
|
|
39
|
-
|
|
40
|
-
If sy-dbcnt is checked after database statements, it is considered okay.
|
|
41
|
-
|
|
42
|
-
"SELECT SINGLE @abap_true FROM " is considered as an existence check, also "SELECT COUNT( * )" is considered okay
|
|
43
|
-
|
|
44
|
-
If IS ASSIGNED is checked after assigning, it is considered okay.
|
|
45
|
-
|
|
38
|
+
extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
|
|
39
|
+
|
|
40
|
+
If sy-dbcnt is checked after database statements, it is considered okay.
|
|
41
|
+
|
|
42
|
+
"SELECT SINGLE @abap_true FROM " is considered as an existence check, also "SELECT COUNT( * )" is considered okay
|
|
43
|
+
|
|
44
|
+
If IS ASSIGNED is checked after assigning, it is considered okay.
|
|
45
|
+
|
|
46
46
|
FIND statement with MATCH COUNT is considered okay if subrc is not checked`,
|
|
47
47
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
|
|
48
48
|
pseudoComment: "EC CI_SUBRC",
|
|
@@ -21,17 +21,17 @@ class ClassicExceptionsOverlap extends _abap_rule_1.ABAPRule {
|
|
|
21
21
|
shortDescription: `Find overlapping classic exceptions`,
|
|
22
22
|
extendedInformation: `When debugging its typically good to know exactly which exception is caught`,
|
|
23
23
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
24
|
-
badExample: `CALL FUNCTION 'SOMETHING'
|
|
25
|
-
EXCEPTIONS
|
|
26
|
-
system_failure = 1 MESSAGE lv_message
|
|
27
|
-
communication_failure = 1 MESSAGE lv_message
|
|
28
|
-
resource_failure = 1
|
|
24
|
+
badExample: `CALL FUNCTION 'SOMETHING'
|
|
25
|
+
EXCEPTIONS
|
|
26
|
+
system_failure = 1 MESSAGE lv_message
|
|
27
|
+
communication_failure = 1 MESSAGE lv_message
|
|
28
|
+
resource_failure = 1
|
|
29
29
|
OTHERS = 1.`,
|
|
30
|
-
goodExample: `CALL FUNCTION 'SOMETHING'
|
|
31
|
-
EXCEPTIONS
|
|
32
|
-
system_failure = 1 MESSAGE lv_message
|
|
33
|
-
communication_failure = 2 MESSAGE lv_message
|
|
34
|
-
resource_failure = 3
|
|
30
|
+
goodExample: `CALL FUNCTION 'SOMETHING'
|
|
31
|
+
EXCEPTIONS
|
|
32
|
+
system_failure = 1 MESSAGE lv_message
|
|
33
|
+
communication_failure = 2 MESSAGE lv_message
|
|
34
|
+
resource_failure = 3
|
|
35
35
|
OTHERS = 4.`,
|
|
36
36
|
};
|
|
37
37
|
}
|
|
@@ -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
|
badExample: `* WRITE 'hello world'.`,
|
|
@@ -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
|
};
|