@abaplint/cli 2.113.19 → 2.113.21
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 +4 -4
- package/abaplint +2 -2
- package/build/cli.js +843 -842
- package/package.json +63 -63
package/build/cli.js
CHANGED
|
@@ -35173,13 +35173,13 @@ class FlowGraph {
|
|
|
35173
35173
|
this.label = label;
|
|
35174
35174
|
}
|
|
35175
35175
|
toDigraph() {
|
|
35176
|
-
return `digraph G {
|
|
35177
|
-
labelloc="t";
|
|
35178
|
-
label="${this.label}";
|
|
35179
|
-
graph [fontname = "helvetica"];
|
|
35180
|
-
node [fontname = "helvetica", shape="box"];
|
|
35181
|
-
edge [fontname = "helvetica"];
|
|
35182
|
-
${this.toTextEdges()}
|
|
35176
|
+
return `digraph G {
|
|
35177
|
+
labelloc="t";
|
|
35178
|
+
label="${this.label}";
|
|
35179
|
+
graph [fontname = "helvetica"];
|
|
35180
|
+
node [fontname = "helvetica", shape="box"];
|
|
35181
|
+
edge [fontname = "helvetica"];
|
|
35182
|
+
${this.toTextEdges()}
|
|
35183
35183
|
}`;
|
|
35184
35184
|
}
|
|
35185
35185
|
listSources(node) {
|
|
@@ -35335,7 +35335,7 @@ class StatementFlow {
|
|
|
35335
35335
|
throw new Error("StatementFlow, unknown structure");
|
|
35336
35336
|
}
|
|
35337
35337
|
}
|
|
35338
|
-
if (obj instanceof objects_1.Program) {
|
|
35338
|
+
if (obj instanceof objects_1.Program || obj instanceof objects_1.FunctionGroup) {
|
|
35339
35339
|
// find the top level events
|
|
35340
35340
|
let inEvent = false;
|
|
35341
35341
|
let collected = [];
|
|
@@ -35362,7 +35362,8 @@ class StatementFlow {
|
|
|
35362
35362
|
if (inEvent === true) {
|
|
35363
35363
|
ret.push(this.runEvent(collected, name));
|
|
35364
35364
|
}
|
|
35365
|
-
else if (collected.length > 0
|
|
35365
|
+
else if (collected.length > 0
|
|
35366
|
+
&& !(obj instanceof objects_1.FunctionGroup)) {
|
|
35366
35367
|
// implicit START-OF-SELECTION
|
|
35367
35368
|
ret.push(this.runEvent(collected, "START-OF-SELECTION."));
|
|
35368
35369
|
}
|
|
@@ -43429,13 +43430,13 @@ class Help {
|
|
|
43429
43430
|
/////////////////////////////////////////////////
|
|
43430
43431
|
static dumpABAP(file, reg, textDocument, position) {
|
|
43431
43432
|
let content = "";
|
|
43432
|
-
content = `
|
|
43433
|
-
<a href="#_tokens" rel="no-refresh">Tokens</a> |
|
|
43434
|
-
<a href="#_statements" rel="no-refresh">Statements</a> |
|
|
43435
|
-
<a href="#_structure" rel="no-refresh">Structure</a> |
|
|
43436
|
-
<a href="#_files" rel="no-refresh">Files</a> |
|
|
43437
|
-
<a href="#_info" rel="no-refresh">Info Dump</a>
|
|
43438
|
-
<hr>
|
|
43433
|
+
content = `
|
|
43434
|
+
<a href="#_tokens" rel="no-refresh">Tokens</a> |
|
|
43435
|
+
<a href="#_statements" rel="no-refresh">Statements</a> |
|
|
43436
|
+
<a href="#_structure" rel="no-refresh">Structure</a> |
|
|
43437
|
+
<a href="#_files" rel="no-refresh">Files</a> |
|
|
43438
|
+
<a href="#_info" rel="no-refresh">Info Dump</a>
|
|
43439
|
+
<hr>
|
|
43439
43440
|
` +
|
|
43440
43441
|
"<tt>" + textDocument.uri + " (" +
|
|
43441
43442
|
(position.line + 1) + ", " +
|
|
@@ -52756,7 +52757,7 @@ class Registry {
|
|
|
52756
52757
|
}
|
|
52757
52758
|
static abaplintVersion() {
|
|
52758
52759
|
// magic, see build script "version.sh"
|
|
52759
|
-
return "2.113.
|
|
52760
|
+
return "2.113.21";
|
|
52760
52761
|
}
|
|
52761
52762
|
getDDICReferences() {
|
|
52762
52763
|
return this.ddicReferences;
|
|
@@ -53075,10 +53076,10 @@ class SevenBitAscii {
|
|
|
53075
53076
|
key: "7bit_ascii",
|
|
53076
53077
|
title: "Check for 7bit ascii",
|
|
53077
53078
|
shortDescription: `Only allow characters from the 7bit ASCII set.`,
|
|
53078
|
-
extendedInformation: `https://docs.abapopenchecks.org/checks/05/
|
|
53079
|
-
|
|
53080
|
-
https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abencharacter_set_guidl.htm
|
|
53081
|
-
|
|
53079
|
+
extendedInformation: `https://docs.abapopenchecks.org/checks/05/
|
|
53080
|
+
|
|
53081
|
+
https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abencharacter_set_guidl.htm
|
|
53082
|
+
|
|
53082
53083
|
Checkes files with extensions ".abap" and ".asddls"`,
|
|
53083
53084
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
53084
53085
|
badExample: `WRITE '뽑'.`,
|
|
@@ -53284,10 +53285,10 @@ class Abapdoc extends _abap_rule_1.ABAPRule {
|
|
|
53284
53285
|
key: "abapdoc",
|
|
53285
53286
|
title: "Check abapdoc",
|
|
53286
53287
|
shortDescription: `Various checks regarding abapdoc.`,
|
|
53287
|
-
extendedInformation: `Base rule checks for existence of abapdoc for public class methods and all interface methods.
|
|
53288
|
-
|
|
53289
|
-
Plus class and interface definitions.
|
|
53290
|
-
|
|
53288
|
+
extendedInformation: `Base rule checks for existence of abapdoc for public class methods and all interface methods.
|
|
53289
|
+
|
|
53290
|
+
Plus class and interface definitions.
|
|
53291
|
+
|
|
53291
53292
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#abap-doc-only-for-public-apis`,
|
|
53292
53293
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
|
|
53293
53294
|
};
|
|
@@ -53424,27 +53425,27 @@ class AddTestAttributes extends _abap_rule_1.ABAPRule {
|
|
|
53424
53425
|
title: "Add test attributes for tests classes with test methods",
|
|
53425
53426
|
shortDescription: `Add test attributes DURATION and RISK LEVEL for tests classes with test methods`,
|
|
53426
53427
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
53427
|
-
badExample: `CLASS ltcl_test1 DEFINITION FINAL FOR TESTING.
|
|
53428
|
-
PUBLIC SECTION.
|
|
53429
|
-
PROTECTED SECTION.
|
|
53430
|
-
PRIVATE SECTION.
|
|
53431
|
-
METHODS test FOR TESTING RAISING cx_static_check.
|
|
53432
|
-
ENDCLASS.
|
|
53433
|
-
|
|
53434
|
-
CLASS ltcl_test1 IMPLEMENTATION.
|
|
53435
|
-
METHOD test.
|
|
53436
|
-
ENDMETHOD.
|
|
53428
|
+
badExample: `CLASS ltcl_test1 DEFINITION FINAL FOR TESTING.
|
|
53429
|
+
PUBLIC SECTION.
|
|
53430
|
+
PROTECTED SECTION.
|
|
53431
|
+
PRIVATE SECTION.
|
|
53432
|
+
METHODS test FOR TESTING RAISING cx_static_check.
|
|
53433
|
+
ENDCLASS.
|
|
53434
|
+
|
|
53435
|
+
CLASS ltcl_test1 IMPLEMENTATION.
|
|
53436
|
+
METHOD test.
|
|
53437
|
+
ENDMETHOD.
|
|
53437
53438
|
ENDCLASS.`,
|
|
53438
|
-
goodExample: `CLASS ltcl_test2 DEFINITION FINAL FOR TESTING DURATION SHORT RISK LEVEL HARMLESS.
|
|
53439
|
-
PUBLIC SECTION.
|
|
53440
|
-
PROTECTED SECTION.
|
|
53441
|
-
PRIVATE SECTION.
|
|
53442
|
-
METHODS test FOR TESTING RAISING cx_static_check.
|
|
53443
|
-
ENDCLASS.
|
|
53444
|
-
|
|
53445
|
-
CLASS ltcl_test2 IMPLEMENTATION.
|
|
53446
|
-
METHOD test.
|
|
53447
|
-
ENDMETHOD.
|
|
53439
|
+
goodExample: `CLASS ltcl_test2 DEFINITION FINAL FOR TESTING DURATION SHORT RISK LEVEL HARMLESS.
|
|
53440
|
+
PUBLIC SECTION.
|
|
53441
|
+
PROTECTED SECTION.
|
|
53442
|
+
PRIVATE SECTION.
|
|
53443
|
+
METHODS test FOR TESTING RAISING cx_static_check.
|
|
53444
|
+
ENDCLASS.
|
|
53445
|
+
|
|
53446
|
+
CLASS ltcl_test2 IMPLEMENTATION.
|
|
53447
|
+
METHOD test.
|
|
53448
|
+
ENDMETHOD.
|
|
53448
53449
|
ENDCLASS.`,
|
|
53449
53450
|
};
|
|
53450
53451
|
}
|
|
@@ -53530,49 +53531,49 @@ class AlignParameters extends _abap_rule_1.ABAPRule {
|
|
|
53530
53531
|
key: "align_parameters",
|
|
53531
53532
|
title: "Align Parameters",
|
|
53532
53533
|
shortDescription: `Checks for vertially aligned parameters`,
|
|
53533
|
-
extendedInformation: `Checks:
|
|
53534
|
-
* function module calls
|
|
53535
|
-
* method calls
|
|
53536
|
-
* VALUE constructors
|
|
53537
|
-
* NEW constructors
|
|
53538
|
-
* RAISE EXCEPTION statements
|
|
53539
|
-
* CREATE OBJECT statements
|
|
53540
|
-
* RAISE EVENT statements
|
|
53541
|
-
|
|
53542
|
-
https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
|
|
53543
|
-
|
|
53544
|
-
Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
|
|
53545
|
-
|
|
53546
|
-
If parameters are on the same row, no issues are reported, see
|
|
53534
|
+
extendedInformation: `Checks:
|
|
53535
|
+
* function module calls
|
|
53536
|
+
* method calls
|
|
53537
|
+
* VALUE constructors
|
|
53538
|
+
* NEW constructors
|
|
53539
|
+
* RAISE EXCEPTION statements
|
|
53540
|
+
* CREATE OBJECT statements
|
|
53541
|
+
* RAISE EVENT statements
|
|
53542
|
+
|
|
53543
|
+
https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
|
|
53544
|
+
|
|
53545
|
+
Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
|
|
53546
|
+
|
|
53547
|
+
If parameters are on the same row, no issues are reported, see
|
|
53547
53548
|
https://rules.abaplint.org/max_one_method_parameter_per_line/ for splitting parameters to lines`,
|
|
53548
53549
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix],
|
|
53549
|
-
badExample: `CALL FUNCTION 'FOOBAR'
|
|
53550
|
-
EXPORTING
|
|
53551
|
-
foo = 2
|
|
53552
|
-
parameter = 3.
|
|
53553
|
-
|
|
53554
|
-
foobar( moo = 1
|
|
53555
|
-
param = 1 ).
|
|
53556
|
-
|
|
53557
|
-
foo = VALUE #(
|
|
53558
|
-
foo = bar
|
|
53550
|
+
badExample: `CALL FUNCTION 'FOOBAR'
|
|
53551
|
+
EXPORTING
|
|
53552
|
+
foo = 2
|
|
53553
|
+
parameter = 3.
|
|
53554
|
+
|
|
53555
|
+
foobar( moo = 1
|
|
53556
|
+
param = 1 ).
|
|
53557
|
+
|
|
53558
|
+
foo = VALUE #(
|
|
53559
|
+
foo = bar
|
|
53559
53560
|
moo = 2 ).`,
|
|
53560
|
-
goodExample: `CALL FUNCTION 'FOOBAR'
|
|
53561
|
-
EXPORTING
|
|
53562
|
-
foo = 2
|
|
53563
|
-
parameter = 3.
|
|
53564
|
-
|
|
53565
|
-
foobar( moo = 1
|
|
53566
|
-
param = 1 ).
|
|
53567
|
-
|
|
53568
|
-
foo = VALUE #(
|
|
53569
|
-
foo = bar
|
|
53570
|
-
moo = 2 ).
|
|
53571
|
-
|
|
53572
|
-
DATA(sdf) = VALUE type(
|
|
53573
|
-
common_val = 2
|
|
53574
|
-
another_common = 5
|
|
53575
|
-
( row_value = 4
|
|
53561
|
+
goodExample: `CALL FUNCTION 'FOOBAR'
|
|
53562
|
+
EXPORTING
|
|
53563
|
+
foo = 2
|
|
53564
|
+
parameter = 3.
|
|
53565
|
+
|
|
53566
|
+
foobar( moo = 1
|
|
53567
|
+
param = 1 ).
|
|
53568
|
+
|
|
53569
|
+
foo = VALUE #(
|
|
53570
|
+
foo = bar
|
|
53571
|
+
moo = 2 ).
|
|
53572
|
+
|
|
53573
|
+
DATA(sdf) = VALUE type(
|
|
53574
|
+
common_val = 2
|
|
53575
|
+
another_common = 5
|
|
53576
|
+
( row_value = 4
|
|
53576
53577
|
value_foo = 5 ) ).`,
|
|
53577
53578
|
};
|
|
53578
53579
|
}
|
|
@@ -54006,37 +54007,37 @@ class AlignTypeExpressions extends _abap_rule_1.ABAPRule {
|
|
|
54006
54007
|
key: "align_type_expressions",
|
|
54007
54008
|
title: "Align TYPE expressions",
|
|
54008
54009
|
shortDescription: `Align TYPE expressions in statements`,
|
|
54009
|
-
extendedInformation: `
|
|
54010
|
-
Currently works for METHODS + BEGIN OF
|
|
54011
|
-
|
|
54012
|
-
If BEGIN OF has an INCLUDE TYPE its ignored
|
|
54013
|
-
|
|
54014
|
-
Also note that clean ABAP does not recommend aligning TYPE clauses:
|
|
54010
|
+
extendedInformation: `
|
|
54011
|
+
Currently works for METHODS + BEGIN OF
|
|
54012
|
+
|
|
54013
|
+
If BEGIN OF has an INCLUDE TYPE its ignored
|
|
54014
|
+
|
|
54015
|
+
Also note that clean ABAP does not recommend aligning TYPE clauses:
|
|
54015
54016
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-align-type-clauses`,
|
|
54016
54017
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix],
|
|
54017
|
-
badExample: `
|
|
54018
|
-
TYPES: BEGIN OF foo,
|
|
54019
|
-
bar TYPE i,
|
|
54020
|
-
foobar TYPE i,
|
|
54021
|
-
END OF foo.
|
|
54022
|
-
|
|
54023
|
-
INTERFACE lif.
|
|
54024
|
-
METHODS bar
|
|
54025
|
-
IMPORTING
|
|
54026
|
-
foo TYPE i
|
|
54027
|
-
foobar TYPE i.
|
|
54018
|
+
badExample: `
|
|
54019
|
+
TYPES: BEGIN OF foo,
|
|
54020
|
+
bar TYPE i,
|
|
54021
|
+
foobar TYPE i,
|
|
54022
|
+
END OF foo.
|
|
54023
|
+
|
|
54024
|
+
INTERFACE lif.
|
|
54025
|
+
METHODS bar
|
|
54026
|
+
IMPORTING
|
|
54027
|
+
foo TYPE i
|
|
54028
|
+
foobar TYPE i.
|
|
54028
54029
|
ENDINTERFACE.`,
|
|
54029
|
-
goodExample: `
|
|
54030
|
-
TYPES: BEGIN OF foo,
|
|
54031
|
-
bar TYPE i,
|
|
54032
|
-
foobar TYPE i,
|
|
54033
|
-
END OF foo.
|
|
54034
|
-
|
|
54035
|
-
INTERFACE lif.
|
|
54036
|
-
METHODS bar
|
|
54037
|
-
IMPORTING
|
|
54038
|
-
foo TYPE i
|
|
54039
|
-
foobar TYPE i.
|
|
54030
|
+
goodExample: `
|
|
54031
|
+
TYPES: BEGIN OF foo,
|
|
54032
|
+
bar TYPE i,
|
|
54033
|
+
foobar TYPE i,
|
|
54034
|
+
END OF foo.
|
|
54035
|
+
|
|
54036
|
+
INTERFACE lif.
|
|
54037
|
+
METHODS bar
|
|
54038
|
+
IMPORTING
|
|
54039
|
+
foo TYPE i
|
|
54040
|
+
foobar TYPE i.
|
|
54040
54041
|
ENDINTERFACE.`,
|
|
54041
54042
|
};
|
|
54042
54043
|
}
|
|
@@ -54315,16 +54316,16 @@ class AmbiguousStatement extends _abap_rule_1.ABAPRule {
|
|
|
54315
54316
|
return {
|
|
54316
54317
|
key: "ambiguous_statement",
|
|
54317
54318
|
title: "Check for ambigious statements",
|
|
54318
|
-
shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
|
|
54319
|
-
Add "TABLE" keyword or "@" for escaping SQL variables
|
|
54320
|
-
|
|
54319
|
+
shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
|
|
54320
|
+
Add "TABLE" keyword or "@" for escaping SQL variables
|
|
54321
|
+
|
|
54321
54322
|
Only works if the target version is 740sp05 or above`,
|
|
54322
54323
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
54323
|
-
badExample: `DELETE foo FROM bar.
|
|
54324
|
+
badExample: `DELETE foo FROM bar.
|
|
54324
54325
|
MODIFY foo FROM bar.`,
|
|
54325
|
-
goodExample: `DELETE foo FROM @bar.
|
|
54326
|
-
DELETE TABLE itab FROM 2.
|
|
54327
|
-
MODIFY zfoo FROM @wa.
|
|
54326
|
+
goodExample: `DELETE foo FROM @bar.
|
|
54327
|
+
DELETE TABLE itab FROM 2.
|
|
54328
|
+
MODIFY zfoo FROM @wa.
|
|
54328
54329
|
MODIFY TABLE foo FROM bar.`,
|
|
54329
54330
|
};
|
|
54330
54331
|
}
|
|
@@ -54429,16 +54430,16 @@ class AvoidUse extends _abap_rule_1.ABAPRule {
|
|
|
54429
54430
|
key: "avoid_use",
|
|
54430
54431
|
title: "Avoid use of certain statements",
|
|
54431
54432
|
shortDescription: `Detects usage of certain statements.`,
|
|
54432
|
-
extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
|
|
54433
|
-
|
|
54434
|
-
Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
|
|
54435
|
-
|
|
54436
|
-
STATICS: use CLASS-DATA instead
|
|
54437
|
-
|
|
54438
|
-
DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
|
|
54439
|
-
|
|
54440
|
-
TEST-SEAMS: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-test-seams-as-temporary-workaround
|
|
54441
|
-
|
|
54433
|
+
extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
|
|
54434
|
+
|
|
54435
|
+
Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
|
|
54436
|
+
|
|
54437
|
+
STATICS: use CLASS-DATA instead
|
|
54438
|
+
|
|
54439
|
+
DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
|
|
54440
|
+
|
|
54441
|
+
TEST-SEAMS: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-test-seams-as-temporary-workaround
|
|
54442
|
+
|
|
54442
54443
|
BREAK points`,
|
|
54443
54444
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
54444
54445
|
};
|
|
@@ -54570,11 +54571,11 @@ class BeginEndNames extends _abap_rule_1.ABAPRule {
|
|
|
54570
54571
|
title: "Check BEGIN END names",
|
|
54571
54572
|
shortDescription: `Check BEGIN OF and END OF names match, plus there must be statements between BEGIN and END`,
|
|
54572
54573
|
tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
54573
|
-
badExample: `DATA: BEGIN OF stru,
|
|
54574
|
-
field TYPE i,
|
|
54574
|
+
badExample: `DATA: BEGIN OF stru,
|
|
54575
|
+
field TYPE i,
|
|
54575
54576
|
END OF structure_not_the_same.`,
|
|
54576
|
-
goodExample: `DATA: BEGIN OF stru,
|
|
54577
|
-
field TYPE i,
|
|
54577
|
+
goodExample: `DATA: BEGIN OF stru,
|
|
54578
|
+
field TYPE i,
|
|
54578
54579
|
END OF stru.`,
|
|
54579
54580
|
};
|
|
54580
54581
|
}
|
|
@@ -54671,20 +54672,20 @@ class BeginSingleInclude extends _abap_rule_1.ABAPRule {
|
|
|
54671
54672
|
title: "BEGIN contains single INCLUDE",
|
|
54672
54673
|
shortDescription: `Finds TYPE BEGIN with just one INCLUDE TYPE, and DATA with single INCLUDE STRUCTURE`,
|
|
54673
54674
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
54674
|
-
badExample: `TYPES: BEGIN OF dummy1.
|
|
54675
|
-
INCLUDE TYPE dselc.
|
|
54676
|
-
TYPES: END OF dummy1.
|
|
54677
|
-
|
|
54678
|
-
DATA BEGIN OF foo.
|
|
54679
|
-
INCLUDE STRUCTURE syst.
|
|
54680
|
-
DATA END OF foo.
|
|
54681
|
-
|
|
54682
|
-
STATICS BEGIN OF bar.
|
|
54683
|
-
INCLUDE STRUCTURE syst.
|
|
54675
|
+
badExample: `TYPES: BEGIN OF dummy1.
|
|
54676
|
+
INCLUDE TYPE dselc.
|
|
54677
|
+
TYPES: END OF dummy1.
|
|
54678
|
+
|
|
54679
|
+
DATA BEGIN OF foo.
|
|
54680
|
+
INCLUDE STRUCTURE syst.
|
|
54681
|
+
DATA END OF foo.
|
|
54682
|
+
|
|
54683
|
+
STATICS BEGIN OF bar.
|
|
54684
|
+
INCLUDE STRUCTURE syst.
|
|
54684
54685
|
STATICS END OF bar.`,
|
|
54685
|
-
goodExample: `DATA BEGIN OF foo.
|
|
54686
|
-
DATA field TYPE i.
|
|
54687
|
-
INCLUDE STRUCTURE dselc.
|
|
54686
|
+
goodExample: `DATA BEGIN OF foo.
|
|
54687
|
+
DATA field TYPE i.
|
|
54688
|
+
INCLUDE STRUCTURE dselc.
|
|
54688
54689
|
DATA END OF foo.`,
|
|
54689
54690
|
};
|
|
54690
54691
|
}
|
|
@@ -54774,9 +54775,9 @@ class CallTransactionAuthorityCheck extends _abap_rule_1.ABAPRule {
|
|
|
54774
54775
|
extendedInformation: `https://docs.abapopenchecks.org/checks/54/`,
|
|
54775
54776
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
|
|
54776
54777
|
badExample: `CALL TRANSACTION 'FOO'.`,
|
|
54777
|
-
goodExample: `TRY.
|
|
54778
|
-
CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
|
|
54779
|
-
CATCH cx_sy_authorization_error.
|
|
54778
|
+
goodExample: `TRY.
|
|
54779
|
+
CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
|
|
54780
|
+
CATCH cx_sy_authorization_error.
|
|
54780
54781
|
ENDTRY.`,
|
|
54781
54782
|
};
|
|
54782
54783
|
}
|
|
@@ -54841,10 +54842,10 @@ class CDSCommentStyle {
|
|
|
54841
54842
|
key: "cds_comment_style",
|
|
54842
54843
|
title: "CDS Comment Style",
|
|
54843
54844
|
shortDescription: `Check for obsolete comment style`,
|
|
54844
|
-
extendedInformation: `Check for obsolete comment style
|
|
54845
|
-
|
|
54846
|
-
Comments starting with "--" are considered obsolete
|
|
54847
|
-
|
|
54845
|
+
extendedInformation: `Check for obsolete comment style
|
|
54846
|
+
|
|
54847
|
+
Comments starting with "--" are considered obsolete
|
|
54848
|
+
|
|
54848
54849
|
https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abencds_general_syntax_rules.htm`,
|
|
54849
54850
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
54850
54851
|
badExample: "-- this is a comment",
|
|
@@ -54910,10 +54911,10 @@ class CDSLegacyView {
|
|
|
54910
54911
|
key: "cds_legacy_view",
|
|
54911
54912
|
title: "CDS Legacy View",
|
|
54912
54913
|
shortDescription: `Identify CDS Legacy Views`,
|
|
54913
|
-
extendedInformation: `Use DEFINE VIEW ENTITY instead of DEFINE VIEW
|
|
54914
|
-
|
|
54915
|
-
https://blogs.sap.com/2021/10/16/a-new-generation-of-cds-views-how-to-migrate-your-cds-views-to-cds-view-entities/
|
|
54916
|
-
|
|
54914
|
+
extendedInformation: `Use DEFINE VIEW ENTITY instead of DEFINE VIEW
|
|
54915
|
+
|
|
54916
|
+
https://blogs.sap.com/2021/10/16/a-new-generation-of-cds-views-how-to-migrate-your-cds-views-to-cds-view-entities/
|
|
54917
|
+
|
|
54917
54918
|
v755 and up`,
|
|
54918
54919
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Upport],
|
|
54919
54920
|
};
|
|
@@ -55068,10 +55069,10 @@ class ChainMainlyDeclarations extends _abap_rule_1.ABAPRule {
|
|
|
55068
55069
|
key: "chain_mainly_declarations",
|
|
55069
55070
|
title: "Chain mainly declarations",
|
|
55070
55071
|
shortDescription: `Chain mainly declarations, allows chaining for the configured statements, reports errors for other statements.`,
|
|
55071
|
-
extendedInformation: `
|
|
55072
|
-
https://docs.abapopenchecks.org/checks/23/
|
|
55073
|
-
|
|
55074
|
-
https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
|
|
55072
|
+
extendedInformation: `
|
|
55073
|
+
https://docs.abapopenchecks.org/checks/23/
|
|
55074
|
+
|
|
55075
|
+
https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
|
|
55075
55076
|
`,
|
|
55076
55077
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
|
|
55077
55078
|
badExample: `CALL METHOD: bar.`,
|
|
@@ -55247,17 +55248,17 @@ class ChangeIfToCase extends _abap_rule_1.ABAPRule {
|
|
|
55247
55248
|
title: "Change IF to CASE",
|
|
55248
55249
|
shortDescription: `Finds IF constructs that can be changed to CASE`,
|
|
55249
55250
|
// eslint-disable-next-line max-len
|
|
55250
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-case-to-else-if-for-multiple-alternative-conditions
|
|
55251
|
-
|
|
55251
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-case-to-else-if-for-multiple-alternative-conditions
|
|
55252
|
+
|
|
55252
55253
|
If the first comparison is a boolean compare, no issue is reported.`,
|
|
55253
55254
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
|
|
55254
|
-
badExample: `IF l_fcat-fieldname EQ 'FOO'.
|
|
55255
|
-
ELSEIF l_fcat-fieldname = 'BAR'
|
|
55256
|
-
OR l_fcat-fieldname = 'MOO'.
|
|
55255
|
+
badExample: `IF l_fcat-fieldname EQ 'FOO'.
|
|
55256
|
+
ELSEIF l_fcat-fieldname = 'BAR'
|
|
55257
|
+
OR l_fcat-fieldname = 'MOO'.
|
|
55257
55258
|
ENDIF.`,
|
|
55258
|
-
goodExample: `CASE l_fcat-fieldname.
|
|
55259
|
-
WHEN 'FOO'.
|
|
55260
|
-
WHEN 'BAR' OR 'MOO'.
|
|
55259
|
+
goodExample: `CASE l_fcat-fieldname.
|
|
55260
|
+
WHEN 'FOO'.
|
|
55261
|
+
WHEN 'BAR' OR 'MOO'.
|
|
55261
55262
|
ENDCASE.`,
|
|
55262
55263
|
};
|
|
55263
55264
|
}
|
|
@@ -55394,8 +55395,8 @@ class CheckAbstract extends _abap_rule_1.ABAPRule {
|
|
|
55394
55395
|
return {
|
|
55395
55396
|
key: "check_abstract",
|
|
55396
55397
|
title: "Check abstract methods and classes",
|
|
55397
|
-
shortDescription: `Checks abstract methods and classes:
|
|
55398
|
-
- class defined as abstract and final,
|
|
55398
|
+
shortDescription: `Checks abstract methods and classes:
|
|
55399
|
+
- class defined as abstract and final,
|
|
55399
55400
|
- non-abstract class contains abstract methods`,
|
|
55400
55401
|
extendedInformation: `If a class defines only constants, use an interface instead`,
|
|
55401
55402
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
@@ -55476,11 +55477,11 @@ class CheckComments extends _abap_rule_1.ABAPRule {
|
|
|
55476
55477
|
return {
|
|
55477
55478
|
key: "check_comments",
|
|
55478
55479
|
title: "Check Comments",
|
|
55479
|
-
shortDescription: `
|
|
55480
|
+
shortDescription: `
|
|
55480
55481
|
Various checks for comment usage.`,
|
|
55481
|
-
extendedInformation: `
|
|
55482
|
-
Detects end of line comments. Comments starting with "#EC" or "##" are ignored
|
|
55483
|
-
|
|
55482
|
+
extendedInformation: `
|
|
55483
|
+
Detects end of line comments. Comments starting with "#EC" or "##" are ignored
|
|
55484
|
+
|
|
55484
55485
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#put-comments-before-the-statement-they-relate-to`,
|
|
55485
55486
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
55486
55487
|
badExample: `WRITE 2. " descriptive comment`,
|
|
@@ -55642,9 +55643,9 @@ class CheckInclude {
|
|
|
55642
55643
|
key: "check_include",
|
|
55643
55644
|
title: "Check INCLUDEs",
|
|
55644
55645
|
shortDescription: `Checks INCLUDE statements`,
|
|
55645
|
-
extendedInformation: `
|
|
55646
|
-
* Reports unused includes
|
|
55647
|
-
* Errors if the includes are not found
|
|
55646
|
+
extendedInformation: `
|
|
55647
|
+
* Reports unused includes
|
|
55648
|
+
* Errors if the includes are not found
|
|
55648
55649
|
* Error if including a main program`,
|
|
55649
55650
|
tags: [_irule_1.RuleTag.Syntax],
|
|
55650
55651
|
};
|
|
@@ -55720,14 +55721,14 @@ class CheckSubrc extends _abap_rule_1.ABAPRule {
|
|
|
55720
55721
|
key: "check_subrc",
|
|
55721
55722
|
title: "Check sy-subrc",
|
|
55722
55723
|
shortDescription: `Check sy-subrc`,
|
|
55723
|
-
extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
|
|
55724
|
-
|
|
55725
|
-
If sy-dbcnt is checked after database statements, it is considered okay.
|
|
55726
|
-
|
|
55727
|
-
"SELECT SINGLE @abap_true FROM " is considered as an existence check, also "SELECT COUNT( * )" is considered okay
|
|
55728
|
-
|
|
55729
|
-
If IS ASSIGNED is checked after assigning, it is considered okay.
|
|
55730
|
-
|
|
55724
|
+
extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
|
|
55725
|
+
|
|
55726
|
+
If sy-dbcnt is checked after database statements, it is considered okay.
|
|
55727
|
+
|
|
55728
|
+
"SELECT SINGLE @abap_true FROM " is considered as an existence check, also "SELECT COUNT( * )" is considered okay
|
|
55729
|
+
|
|
55730
|
+
If IS ASSIGNED is checked after assigning, it is considered okay.
|
|
55731
|
+
|
|
55731
55732
|
FIND statement with MATCH COUNT is considered okay if subrc is not checked`,
|
|
55732
55733
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
|
|
55733
55734
|
pseudoComment: "EC CI_SUBRC",
|
|
@@ -56297,17 +56298,17 @@ class ClassicExceptionsOverlap extends _abap_rule_1.ABAPRule {
|
|
|
56297
56298
|
shortDescription: `Find overlapping classic exceptions`,
|
|
56298
56299
|
extendedInformation: `When debugging its typically good to know exactly which exception is caught`,
|
|
56299
56300
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
56300
|
-
badExample: `CALL FUNCTION 'SOMETHING'
|
|
56301
|
-
EXCEPTIONS
|
|
56302
|
-
system_failure = 1 MESSAGE lv_message
|
|
56303
|
-
communication_failure = 1 MESSAGE lv_message
|
|
56304
|
-
resource_failure = 1
|
|
56301
|
+
badExample: `CALL FUNCTION 'SOMETHING'
|
|
56302
|
+
EXCEPTIONS
|
|
56303
|
+
system_failure = 1 MESSAGE lv_message
|
|
56304
|
+
communication_failure = 1 MESSAGE lv_message
|
|
56305
|
+
resource_failure = 1
|
|
56305
56306
|
OTHERS = 1.`,
|
|
56306
|
-
goodExample: `CALL FUNCTION 'SOMETHING'
|
|
56307
|
-
EXCEPTIONS
|
|
56308
|
-
system_failure = 1 MESSAGE lv_message
|
|
56309
|
-
communication_failure = 2 MESSAGE lv_message
|
|
56310
|
-
resource_failure = 3
|
|
56307
|
+
goodExample: `CALL FUNCTION 'SOMETHING'
|
|
56308
|
+
EXCEPTIONS
|
|
56309
|
+
system_failure = 1 MESSAGE lv_message
|
|
56310
|
+
communication_failure = 2 MESSAGE lv_message
|
|
56311
|
+
resource_failure = 3
|
|
56311
56312
|
OTHERS = 4.`,
|
|
56312
56313
|
};
|
|
56313
56314
|
}
|
|
@@ -56553,7 +56554,7 @@ class CommentedCode extends _abap_rule_1.ABAPRule {
|
|
|
56553
56554
|
key: "commented_code",
|
|
56554
56555
|
title: "Find commented code",
|
|
56555
56556
|
shortDescription: `Detects usage of commented out code.`,
|
|
56556
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
|
|
56557
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
|
|
56557
56558
|
https://docs.abapopenchecks.org/checks/14/`,
|
|
56558
56559
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
56559
56560
|
badExample: `* WRITE 'hello world'.`,
|
|
@@ -56786,10 +56787,10 @@ class ConstructorVisibilityPublic {
|
|
|
56786
56787
|
key: "constructor_visibility_public",
|
|
56787
56788
|
title: "Check constructor visibility is public",
|
|
56788
56789
|
shortDescription: `Constructor must be placed in the public section, even if the class is not CREATE PUBLIC.`,
|
|
56789
|
-
extendedInformation: `
|
|
56790
|
-
This only applies to global classes.
|
|
56791
|
-
|
|
56792
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
|
|
56790
|
+
extendedInformation: `
|
|
56791
|
+
This only applies to global classes.
|
|
56792
|
+
|
|
56793
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
|
|
56793
56794
|
https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abeninstance_constructor_guidl.htm`,
|
|
56794
56795
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
56795
56796
|
};
|
|
@@ -56864,8 +56865,8 @@ class ContainsTab extends _abap_rule_1.ABAPRule {
|
|
|
56864
56865
|
key: "contains_tab",
|
|
56865
56866
|
title: "Code contains tab",
|
|
56866
56867
|
shortDescription: `Checks for usage of tabs (enable to enforce spaces)`,
|
|
56867
|
-
extendedInformation: `
|
|
56868
|
-
https://docs.abapopenchecks.org/checks/09/
|
|
56868
|
+
extendedInformation: `
|
|
56869
|
+
https://docs.abapopenchecks.org/checks/09/
|
|
56869
56870
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#indent-and-snap-to-tab`,
|
|
56870
56871
|
tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
56871
56872
|
badExample: `\tWRITE 'hello world'.`,
|
|
@@ -56952,10 +56953,10 @@ class CyclicOO {
|
|
|
56952
56953
|
key: "cyclic_oo",
|
|
56953
56954
|
title: "Cyclic OO",
|
|
56954
56955
|
shortDescription: `Finds cyclic/circular OO references`,
|
|
56955
|
-
extendedInformation: `Runs for global INTF + CLAS objects
|
|
56956
|
-
|
|
56957
|
-
Objects must be without syntax errors for this rule to take effect
|
|
56958
|
-
|
|
56956
|
+
extendedInformation: `Runs for global INTF + CLAS objects
|
|
56957
|
+
|
|
56958
|
+
Objects must be without syntax errors for this rule to take effect
|
|
56959
|
+
|
|
56959
56960
|
References in testclass includes are ignored`,
|
|
56960
56961
|
};
|
|
56961
56962
|
}
|
|
@@ -57198,7 +57199,7 @@ class DangerousStatement extends _abap_rule_1.ABAPRule {
|
|
|
57198
57199
|
key: "dangerous_statement",
|
|
57199
57200
|
title: "Dangerous statement",
|
|
57200
57201
|
shortDescription: `Detects potentially dangerous statements`,
|
|
57201
|
-
extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
|
|
57202
|
+
extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
|
|
57202
57203
|
dynamic SQL can potentially create SQL injection problems`,
|
|
57203
57204
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
|
|
57204
57205
|
};
|
|
@@ -57405,13 +57406,13 @@ class DefinitionsTop extends _abap_rule_1.ABAPRule {
|
|
|
57405
57406
|
shortDescription: `Checks that definitions are placed at the beginning of METHODs, FORMs and FUNCTIONs.`,
|
|
57406
57407
|
extendedInformation: `https://docs.abapopenchecks.org/checks/17/`,
|
|
57407
57408
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
|
|
57408
|
-
badExample: `FROM foo.
|
|
57409
|
-
WRITE 'hello'.
|
|
57410
|
-
DATA int TYPE i.
|
|
57409
|
+
badExample: `FROM foo.
|
|
57410
|
+
WRITE 'hello'.
|
|
57411
|
+
DATA int TYPE i.
|
|
57411
57412
|
ENDFORM.`,
|
|
57412
|
-
goodExample: `FROM foo.
|
|
57413
|
-
DATA int TYPE i.
|
|
57414
|
-
WRITE 'hello'.
|
|
57413
|
+
goodExample: `FROM foo.
|
|
57414
|
+
DATA int TYPE i.
|
|
57415
|
+
WRITE 'hello'.
|
|
57415
57416
|
ENDFORM.`,
|
|
57416
57417
|
};
|
|
57417
57418
|
}
|
|
@@ -57950,39 +57951,39 @@ class Downport {
|
|
|
57950
57951
|
key: "downport",
|
|
57951
57952
|
title: "Downport statement",
|
|
57952
57953
|
shortDescription: `Downport functionality`,
|
|
57953
|
-
extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
|
|
57954
|
-
a higher level language version. If successful, various rules are applied to downport the statement.
|
|
57955
|
-
Target downport version is always v702, thus rule is only enabled if target version is v702.
|
|
57956
|
-
|
|
57957
|
-
Current rules:
|
|
57958
|
-
* NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
|
|
57959
|
-
* DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
|
|
57960
|
-
* FIELD-SYMBOL() definitions are outlined
|
|
57961
|
-
* CONV is outlined
|
|
57962
|
-
* COND is outlined
|
|
57963
|
-
* REDUCE is outlined
|
|
57964
|
-
* SWITCH is outlined
|
|
57965
|
-
* FILTER is outlined
|
|
57966
|
-
* APPEND expression is outlined
|
|
57967
|
-
* INSERT expression is outlined
|
|
57968
|
-
* EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
|
|
57969
|
-
* CAST changed to ?=
|
|
57970
|
-
* LOOP AT method_call( ) is outlined
|
|
57971
|
-
* VALUE # with structure fields
|
|
57972
|
-
* VALUE # with internal table lines
|
|
57973
|
-
* Table Expressions are outlined
|
|
57974
|
-
* SELECT INTO @DATA definitions are outlined
|
|
57975
|
-
* Some occurrences of string template formatting option ALPHA changed to function module call
|
|
57976
|
-
* SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
|
|
57977
|
-
* PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
|
|
57978
|
-
* RAISE EXCEPTION ... MESSAGE
|
|
57979
|
-
* Moving with +=, -=, /=, *=, &&= is expanded
|
|
57980
|
-
* line_exists and line_index is downported to READ TABLE
|
|
57981
|
-
* ENUMs, but does not nessesarily give the correct type and value
|
|
57982
|
-
* MESSAGE with non simple source
|
|
57983
|
-
|
|
57984
|
-
Only one transformation is applied to a statement at a time, so multiple steps might be required to do the full downport.
|
|
57985
|
-
|
|
57954
|
+
extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
|
|
57955
|
+
a higher level language version. If successful, various rules are applied to downport the statement.
|
|
57956
|
+
Target downport version is always v702, thus rule is only enabled if target version is v702.
|
|
57957
|
+
|
|
57958
|
+
Current rules:
|
|
57959
|
+
* NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
|
|
57960
|
+
* DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
|
|
57961
|
+
* FIELD-SYMBOL() definitions are outlined
|
|
57962
|
+
* CONV is outlined
|
|
57963
|
+
* COND is outlined
|
|
57964
|
+
* REDUCE is outlined
|
|
57965
|
+
* SWITCH is outlined
|
|
57966
|
+
* FILTER is outlined
|
|
57967
|
+
* APPEND expression is outlined
|
|
57968
|
+
* INSERT expression is outlined
|
|
57969
|
+
* EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
|
|
57970
|
+
* CAST changed to ?=
|
|
57971
|
+
* LOOP AT method_call( ) is outlined
|
|
57972
|
+
* VALUE # with structure fields
|
|
57973
|
+
* VALUE # with internal table lines
|
|
57974
|
+
* Table Expressions are outlined
|
|
57975
|
+
* SELECT INTO @DATA definitions are outlined
|
|
57976
|
+
* Some occurrences of string template formatting option ALPHA changed to function module call
|
|
57977
|
+
* SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
|
|
57978
|
+
* PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
|
|
57979
|
+
* RAISE EXCEPTION ... MESSAGE
|
|
57980
|
+
* Moving with +=, -=, /=, *=, &&= is expanded
|
|
57981
|
+
* line_exists and line_index is downported to READ TABLE
|
|
57982
|
+
* ENUMs, but does not nessesarily give the correct type and value
|
|
57983
|
+
* MESSAGE with non simple source
|
|
57984
|
+
|
|
57985
|
+
Only one transformation is applied to a statement at a time, so multiple steps might be required to do the full downport.
|
|
57986
|
+
|
|
57986
57987
|
Make sure to test the downported code, it might not always be completely correct.`,
|
|
57987
57988
|
tags: [_irule_1.RuleTag.Downport, _irule_1.RuleTag.Quickfix],
|
|
57988
57989
|
};
|
|
@@ -58560,10 +58561,10 @@ Make sure to test the downported code, it might not always be completely correct
|
|
|
58560
58561
|
const fieldName = f.concatTokens();
|
|
58561
58562
|
fieldDefinition += indentation + " " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
|
|
58562
58563
|
}
|
|
58563
|
-
fieldDefinition = `DATA: BEGIN OF ${name},
|
|
58564
|
+
fieldDefinition = `DATA: BEGIN OF ${name},
|
|
58564
58565
|
${fieldDefinition}${indentation} END OF ${name}.`;
|
|
58565
58566
|
}
|
|
58566
|
-
const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
|
|
58567
|
+
const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
|
|
58567
58568
|
${indentation}`);
|
|
58568
58569
|
const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
|
|
58569
58570
|
const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
|
|
@@ -58622,12 +58623,12 @@ ${indentation}`);
|
|
|
58622
58623
|
}
|
|
58623
58624
|
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
|
|
58624
58625
|
const name = ((_g = inlineData.findFirstExpression(Expressions.TargetField)) === null || _g === void 0 ? void 0 : _g.concatTokens()) || "error";
|
|
58625
|
-
let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
|
|
58626
|
-
${fieldDefinitions}${indentation} END OF ${uniqueName}.
|
|
58627
|
-
${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
|
|
58626
|
+
let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
|
|
58627
|
+
${fieldDefinitions}${indentation} END OF ${uniqueName}.
|
|
58628
|
+
${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
|
|
58628
58629
|
${indentation}`);
|
|
58629
58630
|
if (fieldDefinitions === "") {
|
|
58630
|
-
fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
|
|
58631
|
+
fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
|
|
58631
58632
|
${indentation}`);
|
|
58632
58633
|
}
|
|
58633
58634
|
const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
|
|
@@ -58695,7 +58696,7 @@ ${indentation}`);
|
|
|
58695
58696
|
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
|
|
58696
58697
|
const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
|
|
58697
58698
|
const firstToken = high.getFirstToken();
|
|
58698
|
-
const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
|
|
58699
|
+
const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
|
|
58699
58700
|
${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
|
|
58700
58701
|
const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
|
|
58701
58702
|
const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
|
|
@@ -58749,7 +58750,7 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
|
|
|
58749
58750
|
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
|
|
58750
58751
|
const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
|
|
58751
58752
|
const firstToken = high.getFirstToken();
|
|
58752
|
-
const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
|
|
58753
|
+
const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
|
|
58753
58754
|
${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
|
|
58754
58755
|
const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
|
|
58755
58756
|
const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
|
|
@@ -58791,14 +58792,14 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
|
|
|
58791
58792
|
const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
|
|
58792
58793
|
const firstToken = high.getFirstToken();
|
|
58793
58794
|
// note that the tabix restore should be done before throwing the exception
|
|
58794
|
-
const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
|
|
58795
|
-
${indentation}DATA ${tabixBackup} LIKE sy-tabix.
|
|
58796
|
-
${indentation}${tabixBackup} = sy-tabix.
|
|
58797
|
-
${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
|
|
58798
|
-
${indentation}sy-tabix = ${tabixBackup}.
|
|
58799
|
-
${indentation}IF sy-subrc <> 0.
|
|
58800
|
-
${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
|
|
58801
|
-
${indentation}ENDIF.
|
|
58795
|
+
const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
|
|
58796
|
+
${indentation}DATA ${tabixBackup} LIKE sy-tabix.
|
|
58797
|
+
${indentation}${tabixBackup} = sy-tabix.
|
|
58798
|
+
${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
|
|
58799
|
+
${indentation}sy-tabix = ${tabixBackup}.
|
|
58800
|
+
${indentation}IF sy-subrc <> 0.
|
|
58801
|
+
${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
|
|
58802
|
+
${indentation}ENDIF.
|
|
58802
58803
|
${indentation}`);
|
|
58803
58804
|
const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, startToken.getStart(), tableExpression.getLastToken().getEnd(), uniqueName);
|
|
58804
58805
|
const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
|
|
@@ -58855,7 +58856,7 @@ ${indentation}`);
|
|
|
58855
58856
|
const className = classNames[0].concatTokens();
|
|
58856
58857
|
const targetName = (_b = target.findFirstExpression(Expressions.TargetField)) === null || _b === void 0 ? void 0 : _b.concatTokens();
|
|
58857
58858
|
const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
|
|
58858
|
-
const code = ` DATA ${targetName} TYPE REF TO ${className}.
|
|
58859
|
+
const code = ` DATA ${targetName} TYPE REF TO ${className}.
|
|
58859
58860
|
${indentation}CATCH ${className} INTO ${targetName}.`;
|
|
58860
58861
|
const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getStart(), node.getEnd(), code);
|
|
58861
58862
|
return issue_1.Issue.atToken(lowFile, node.getFirstToken(), "Outline DATA", this.getMetadata().key, this.conf.severity, fix);
|
|
@@ -59017,16 +59018,16 @@ ${indentation}CATCH ${className} INTO ${targetName}.`;
|
|
|
59017
59018
|
const uniqueName1 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
|
|
59018
59019
|
const uniqueName2 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
|
|
59019
59020
|
const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
|
|
59020
|
-
let abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
|
|
59021
|
-
${indentation}${uniqueName1}-msgid = ${id}.
|
|
59021
|
+
let abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
|
|
59022
|
+
${indentation}${uniqueName1}-msgid = ${id}.
|
|
59022
59023
|
${indentation}${uniqueName1}-msgno = ${number}.\n`;
|
|
59023
59024
|
if (withs.length > 0) {
|
|
59024
|
-
abap += `${indentation}${uniqueName1}-attr1 = 'IF_T100_DYN_MSG~MSGV1'.
|
|
59025
|
-
${indentation}${uniqueName1}-attr2 = 'IF_T100_DYN_MSG~MSGV2'.
|
|
59026
|
-
${indentation}${uniqueName1}-attr3 = 'IF_T100_DYN_MSG~MSGV3'.
|
|
59025
|
+
abap += `${indentation}${uniqueName1}-attr1 = 'IF_T100_DYN_MSG~MSGV1'.
|
|
59026
|
+
${indentation}${uniqueName1}-attr2 = 'IF_T100_DYN_MSG~MSGV2'.
|
|
59027
|
+
${indentation}${uniqueName1}-attr3 = 'IF_T100_DYN_MSG~MSGV3'.
|
|
59027
59028
|
${indentation}${uniqueName1}-attr4 = 'IF_T100_DYN_MSG~MSGV4'.\n`;
|
|
59028
59029
|
}
|
|
59029
|
-
abap += `${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
|
|
59030
|
+
abap += `${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
|
|
59030
59031
|
${indentation}CREATE OBJECT ${uniqueName2} EXPORTING textid = ${uniqueName1}.\n`;
|
|
59031
59032
|
if (withs.length > 0) {
|
|
59032
59033
|
abap += `${indentation}${uniqueName2}->if_t100_dyn_msg~msgty = 'E'.\n`;
|
|
@@ -59138,10 +59139,10 @@ ${indentation}CREATE OBJECT ${uniqueName2} EXPORTING textid = ${uniqueName1}.\n`
|
|
|
59138
59139
|
let code = "";
|
|
59139
59140
|
if (sourceRef.findFirstExpression(Expressions.TableExpression)) {
|
|
59140
59141
|
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
|
|
59141
|
-
code = `ASSIGN ${sourceRef.concatTokens()} TO FIELD-SYMBOL(<${uniqueName}>).
|
|
59142
|
-
IF sy-subrc <> 0.
|
|
59143
|
-
RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
|
|
59144
|
-
ENDIF.
|
|
59142
|
+
code = `ASSIGN ${sourceRef.concatTokens()} TO FIELD-SYMBOL(<${uniqueName}>).
|
|
59143
|
+
IF sy-subrc <> 0.
|
|
59144
|
+
RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
|
|
59145
|
+
ENDIF.
|
|
59145
59146
|
GET REFERENCE OF <${uniqueName}> INTO ${target.concatTokens()}`;
|
|
59146
59147
|
}
|
|
59147
59148
|
else {
|
|
@@ -59230,20 +59231,20 @@ GET REFERENCE OF <${uniqueName}> INTO ${target.concatTokens()}`;
|
|
|
59230
59231
|
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
|
|
59231
59232
|
const uniqueFS = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
|
|
59232
59233
|
const uniqueNameIndex = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
|
|
59233
|
-
code += ` items LIKE ${loopSourceName},
|
|
59234
|
-
END OF ${groupTargetName}type.
|
|
59235
|
-
DATA ${groupTargetName}tab TYPE STANDARD TABLE OF ${groupTargetName}type WITH DEFAULT KEY.
|
|
59236
|
-
DATA ${uniqueName} LIKE LINE OF ${groupTargetName}tab.
|
|
59234
|
+
code += ` items LIKE ${loopSourceName},
|
|
59235
|
+
END OF ${groupTargetName}type.
|
|
59236
|
+
DATA ${groupTargetName}tab TYPE STANDARD TABLE OF ${groupTargetName}type WITH DEFAULT KEY.
|
|
59237
|
+
DATA ${uniqueName} LIKE LINE OF ${groupTargetName}tab.
|
|
59237
59238
|
LOOP AT ${loopSourceName} ${(_l = high.findFirstExpression(Expressions.LoopTarget)) === null || _l === void 0 ? void 0 : _l.concatTokens()}.\n`;
|
|
59238
59239
|
if (groupIndexName !== undefined) {
|
|
59239
59240
|
code += `DATA(${uniqueNameIndex}) = sy-tabix.\n`;
|
|
59240
59241
|
}
|
|
59241
|
-
code += `READ TABLE ${groupTargetName}tab ASSIGNING FIELD-SYMBOL(<${uniqueFS}>) WITH KEY ${condition}.
|
|
59242
|
+
code += `READ TABLE ${groupTargetName}tab ASSIGNING FIELD-SYMBOL(<${uniqueFS}>) WITH KEY ${condition}.
|
|
59242
59243
|
IF sy-subrc = 0.\n`;
|
|
59243
59244
|
if (groupCountName !== undefined) {
|
|
59244
59245
|
code += ` <${uniqueFS}>-${groupCountName} = <${uniqueFS}>-${groupCountName} + 1.\n`;
|
|
59245
59246
|
}
|
|
59246
|
-
code += ` INSERT ${loopTargetName}${isReference ? "->*" : ""} INTO TABLE <${uniqueFS}>-items.
|
|
59247
|
+
code += ` INSERT ${loopTargetName}${isReference ? "->*" : ""} INTO TABLE <${uniqueFS}>-items.
|
|
59247
59248
|
ELSE.\n`;
|
|
59248
59249
|
code += ` CLEAR ${uniqueName}.\n`;
|
|
59249
59250
|
for (const c of group.findAllExpressions(Expressions.LoopGroupByComponent)) {
|
|
@@ -59264,8 +59265,8 @@ ELSE.\n`;
|
|
|
59264
59265
|
}
|
|
59265
59266
|
code += ` INSERT ${loopTargetName}${isReference ? "->*" : ""} INTO TABLE ${uniqueName}-items.\n`;
|
|
59266
59267
|
code += ` INSERT ${uniqueName} INTO TABLE ${groupTargetName}tab.\n`;
|
|
59267
|
-
code += `ENDIF.
|
|
59268
|
-
ENDLOOP.
|
|
59268
|
+
code += `ENDIF.
|
|
59269
|
+
ENDLOOP.
|
|
59269
59270
|
LOOP AT ${groupTargetName}tab ${groupTarget}.`;
|
|
59270
59271
|
let fix = edit_helper_1.EditHelper.replaceRange(lowFile, high.getFirstToken().getStart(), high.getLastToken().getEnd(), code);
|
|
59271
59272
|
for (const l of ((_m = highFile.getStructure()) === null || _m === void 0 ? void 0 : _m.findAllStructures(Structures.Loop)) || []) {
|
|
@@ -59437,7 +59438,7 @@ LOOP AT ${groupTargetName}tab ${groupTarget}.`;
|
|
|
59437
59438
|
const enumName = (_b = high.findExpressionAfterToken("ENUM")) === null || _b === void 0 ? void 0 : _b.concatTokens();
|
|
59438
59439
|
const structureName = (_c = high.findExpressionAfterToken("STRUCTURE")) === null || _c === void 0 ? void 0 : _c.concatTokens();
|
|
59439
59440
|
// all ENUMS are char like?
|
|
59440
|
-
let code = `TYPES ${enumName} TYPE string.
|
|
59441
|
+
let code = `TYPES ${enumName} TYPE string.
|
|
59441
59442
|
CONSTANTS: BEGIN OF ${structureName},\n`;
|
|
59442
59443
|
let count = 1;
|
|
59443
59444
|
for (const e of enumStructure.findDirectStatements(Statements.TypeEnum).concat(enumStructure.findDirectStatements(Statements.Type))) {
|
|
@@ -59481,14 +59482,14 @@ CONSTANTS: BEGIN OF ${structureName},\n`;
|
|
|
59481
59482
|
const tabixBackup = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
|
|
59482
59483
|
const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
|
|
59483
59484
|
// restore tabix before exeption
|
|
59484
|
-
const code = `FIELD-SYMBOLS ${uniqueName} LIKE LINE OF ${tName}.
|
|
59485
|
-
${indentation}DATA ${tabixBackup} LIKE sy-tabix.
|
|
59486
|
-
${indentation}${tabixBackup} = sy-tabix.
|
|
59487
|
-
${indentation}READ TABLE ${tName} ${condition}ASSIGNING ${uniqueName}.
|
|
59488
|
-
${indentation}sy-tabix = ${tabixBackup}.
|
|
59489
|
-
${indentation}IF sy-subrc <> 0.
|
|
59490
|
-
${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
|
|
59491
|
-
${indentation}ENDIF.
|
|
59485
|
+
const code = `FIELD-SYMBOLS ${uniqueName} LIKE LINE OF ${tName}.
|
|
59486
|
+
${indentation}DATA ${tabixBackup} LIKE sy-tabix.
|
|
59487
|
+
${indentation}${tabixBackup} = sy-tabix.
|
|
59488
|
+
${indentation}READ TABLE ${tName} ${condition}ASSIGNING ${uniqueName}.
|
|
59489
|
+
${indentation}sy-tabix = ${tabixBackup}.
|
|
59490
|
+
${indentation}IF sy-subrc <> 0.
|
|
59491
|
+
${indentation} RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
|
|
59492
|
+
${indentation}ENDIF.
|
|
59492
59493
|
${indentation}${uniqueName}`;
|
|
59493
59494
|
const start = target.getFirstToken().getStart();
|
|
59494
59495
|
const end = (_a = tableExpression.findDirectTokenByText("]")) === null || _a === void 0 ? void 0 : _a.getEnd();
|
|
@@ -59572,11 +59573,11 @@ ${indentation}${uniqueName}`;
|
|
|
59572
59573
|
const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
|
|
59573
59574
|
const source = (_b = templateSource === null || templateSource === void 0 ? void 0 : templateSource.findDirectExpression(Expressions.Source)) === null || _b === void 0 ? void 0 : _b.concatTokens();
|
|
59574
59575
|
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
|
|
59575
|
-
const code = `DATA ${uniqueName} TYPE string.
|
|
59576
|
-
${indentation}CALL FUNCTION '${functionName}'
|
|
59577
|
-
${indentation} EXPORTING
|
|
59578
|
-
${indentation} input = ${source}
|
|
59579
|
-
${indentation} IMPORTING
|
|
59576
|
+
const code = `DATA ${uniqueName} TYPE string.
|
|
59577
|
+
${indentation}CALL FUNCTION '${functionName}'
|
|
59578
|
+
${indentation} EXPORTING
|
|
59579
|
+
${indentation} input = ${source}
|
|
59580
|
+
${indentation} IMPORTING
|
|
59580
59581
|
${indentation} output = ${uniqueName}.\n`;
|
|
59581
59582
|
const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getFirstToken().getStart(), code);
|
|
59582
59583
|
const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, child.getFirstToken().getStart(), child.getLastToken().getEnd(), uniqueName);
|
|
@@ -60888,12 +60889,12 @@ class EasyToFindMessages {
|
|
|
60888
60889
|
key: "easy_to_find_messages",
|
|
60889
60890
|
title: "Easy to find messages",
|
|
60890
60891
|
shortDescription: `Make messages easy to find`,
|
|
60891
|
-
extendedInformation: `All messages must be statically referenced exactly once
|
|
60892
|
-
|
|
60893
|
-
Only MESSAGE and RAISE statments are counted as static references
|
|
60894
|
-
|
|
60895
|
-
Also see rule "message_exists"
|
|
60896
|
-
|
|
60892
|
+
extendedInformation: `All messages must be statically referenced exactly once
|
|
60893
|
+
|
|
60894
|
+
Only MESSAGE and RAISE statments are counted as static references
|
|
60895
|
+
|
|
60896
|
+
Also see rule "message_exists"
|
|
60897
|
+
|
|
60897
60898
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#make-messages-easy-to-find`,
|
|
60898
60899
|
tags: [_irule_1.RuleTag.Styleguide],
|
|
60899
60900
|
};
|
|
@@ -60974,13 +60975,13 @@ class EmptyEvent extends _abap_rule_1.ABAPRule {
|
|
|
60974
60975
|
shortDescription: `Empty selection screen or list processing event block`,
|
|
60975
60976
|
extendedInformation: ``,
|
|
60976
60977
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
60977
|
-
badExample: `
|
|
60978
|
-
INITIALIZATION.
|
|
60979
|
-
WRITE 'hello'.
|
|
60978
|
+
badExample: `
|
|
60979
|
+
INITIALIZATION.
|
|
60980
|
+
WRITE 'hello'.
|
|
60980
60981
|
END-OF-SELECTION.`,
|
|
60981
|
-
goodExample: `
|
|
60982
|
-
START-OF-SELECTION.
|
|
60983
|
-
PERFORM sdf.
|
|
60982
|
+
goodExample: `
|
|
60983
|
+
START-OF-SELECTION.
|
|
60984
|
+
PERFORM sdf.
|
|
60984
60985
|
COMMIT WORK.`,
|
|
60985
60986
|
};
|
|
60986
60987
|
}
|
|
@@ -61072,8 +61073,8 @@ class EmptyLineinStatement extends _abap_rule_1.ABAPRule {
|
|
|
61072
61073
|
key: "empty_line_in_statement",
|
|
61073
61074
|
title: "Find empty lines in statements",
|
|
61074
61075
|
shortDescription: `Checks that statements do not contain empty lines.`,
|
|
61075
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-obsess-with-separating-blank-lines
|
|
61076
|
-
|
|
61076
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-obsess-with-separating-blank-lines
|
|
61077
|
+
|
|
61077
61078
|
https://docs.abapopenchecks.org/checks/41/`,
|
|
61078
61079
|
tags: [_irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
|
|
61079
61080
|
badExample: `WRITE\n\nhello.`,
|
|
@@ -61249,13 +61250,13 @@ class EmptyStructure extends _abap_rule_1.ABAPRule {
|
|
|
61249
61250
|
shortDescription: `Checks that the code does not contain empty blocks.`,
|
|
61250
61251
|
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#no-empty-if-branches`,
|
|
61251
61252
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
61252
|
-
badExample: `IF foo = bar.
|
|
61253
|
-
ENDIF.
|
|
61254
|
-
|
|
61255
|
-
DO 2 TIMES.
|
|
61253
|
+
badExample: `IF foo = bar.
|
|
61254
|
+
ENDIF.
|
|
61255
|
+
|
|
61256
|
+
DO 2 TIMES.
|
|
61256
61257
|
ENDDO.`,
|
|
61257
|
-
goodExample: `LOOP AT itab WHERE qty = 0 OR date > sy-datum.
|
|
61258
|
-
ENDLOOP.
|
|
61258
|
+
goodExample: `LOOP AT itab WHERE qty = 0 OR date > sy-datum.
|
|
61259
|
+
ENDLOOP.
|
|
61259
61260
|
result = xsdbool( sy-subrc = 0 ).`,
|
|
61260
61261
|
};
|
|
61261
61262
|
}
|
|
@@ -61397,10 +61398,10 @@ class ExitOrCheck extends _abap_rule_1.ABAPRule {
|
|
|
61397
61398
|
return {
|
|
61398
61399
|
key: "exit_or_check",
|
|
61399
61400
|
title: "Find EXIT or CHECK outside loops",
|
|
61400
|
-
shortDescription: `Detects usages of EXIT or CHECK statements outside of loops.
|
|
61401
|
+
shortDescription: `Detects usages of EXIT or CHECK statements outside of loops.
|
|
61401
61402
|
Use RETURN to leave procesing blocks instead.`,
|
|
61402
|
-
extendedInformation: `https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenleave_processing_blocks.htm
|
|
61403
|
-
https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abapcheck_processing_blocks.htm
|
|
61403
|
+
extendedInformation: `https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenleave_processing_blocks.htm
|
|
61404
|
+
https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abapcheck_processing_blocks.htm
|
|
61404
61405
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#check-vs-return`,
|
|
61405
61406
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
|
|
61406
61407
|
};
|
|
@@ -61483,12 +61484,12 @@ class ExpandMacros extends _abap_rule_1.ABAPRule {
|
|
|
61483
61484
|
key: "expand_macros",
|
|
61484
61485
|
title: "Expand Macros",
|
|
61485
61486
|
shortDescription: `Allows expanding macro calls with quick fixes`,
|
|
61486
|
-
extendedInformation: `Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
|
|
61487
|
-
|
|
61487
|
+
extendedInformation: `Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
|
|
61488
|
+
|
|
61488
61489
|
Note that macros/DEFINE cannot be used in the ABAP Cloud programming model`,
|
|
61489
|
-
badExample: `DEFINE _hello.
|
|
61490
|
-
WRITE 'hello'.
|
|
61491
|
-
END-OF-DEFINITION.
|
|
61490
|
+
badExample: `DEFINE _hello.
|
|
61491
|
+
WRITE 'hello'.
|
|
61492
|
+
END-OF-DEFINITION.
|
|
61492
61493
|
_hello.`,
|
|
61493
61494
|
goodExample: `WRITE 'hello'.`,
|
|
61494
61495
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Upport],
|
|
@@ -61575,7 +61576,7 @@ class Exporting extends _abap_rule_1.ABAPRule {
|
|
|
61575
61576
|
shortDescription: `Detects EXPORTING statements which can be omitted.`,
|
|
61576
61577
|
badExample: `call_method( EXPORTING foo = bar ).`,
|
|
61577
61578
|
goodExample: `call_method( foo = bar ).`,
|
|
61578
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#omit-the-optional-keyword-exporting
|
|
61579
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#omit-the-optional-keyword-exporting
|
|
61579
61580
|
https://docs.abapopenchecks.org/checks/30/`,
|
|
61580
61581
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
61581
61582
|
};
|
|
@@ -61673,7 +61674,7 @@ class ForbiddenIdentifier extends _abap_rule_1.ABAPRule {
|
|
|
61673
61674
|
key: "forbidden_identifier",
|
|
61674
61675
|
title: "Forbidden Identifier",
|
|
61675
61676
|
shortDescription: `Forbid use of specified identifiers, list of regex.`,
|
|
61676
|
-
extendedInformation: `Used in the transpiler to find javascript keywords in ABAP identifiers,
|
|
61677
|
+
extendedInformation: `Used in the transpiler to find javascript keywords in ABAP identifiers,
|
|
61677
61678
|
https://github.com/abaplint/transpiler/blob/bda94b8b56e2b7f2f87be2168f12361aa530220e/packages/transpiler/src/validation.ts#L44`,
|
|
61678
61679
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
61679
61680
|
};
|
|
@@ -61915,8 +61916,8 @@ class ForbiddenVoidType {
|
|
|
61915
61916
|
key: "forbidden_void_type",
|
|
61916
61917
|
title: "Forbidden Void Types",
|
|
61917
61918
|
shortDescription: `Avoid usage of specified void types.`,
|
|
61918
|
-
extendedInformation: `Inspiration:
|
|
61919
|
-
BOOLEAN, BOOLE_D, CHAR01, CHAR1, CHAR10, CHAR12, CHAR128, CHAR2, CHAR20, CHAR4, CHAR70,
|
|
61919
|
+
extendedInformation: `Inspiration:
|
|
61920
|
+
BOOLEAN, BOOLE_D, CHAR01, CHAR1, CHAR10, CHAR12, CHAR128, CHAR2, CHAR20, CHAR4, CHAR70,
|
|
61920
61921
|
DATS, TIMS, DATUM, FLAG, INT4, NUMC3, NUMC4, SAP_BOOL, TEXT25, TEXT80, X255, XFELD`,
|
|
61921
61922
|
};
|
|
61922
61923
|
}
|
|
@@ -62159,7 +62160,7 @@ class FullyTypeITabs extends _abap_rule_1.ABAPRule {
|
|
|
62159
62160
|
key: "fully_type_itabs",
|
|
62160
62161
|
title: "Fully type internal tables",
|
|
62161
62162
|
shortDescription: `No implict table types or table keys`,
|
|
62162
|
-
badExample: `DATA lt_foo TYPE TABLE OF ty.
|
|
62163
|
+
badExample: `DATA lt_foo TYPE TABLE OF ty.
|
|
62163
62164
|
DATA lt_bar TYPE STANDARD TABLE OF ty.`,
|
|
62164
62165
|
goodExample: `DATA lt_foo TYPE STANDARD TABLE OF ty WITH EMPTY KEY.`,
|
|
62165
62166
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
@@ -62344,26 +62345,26 @@ class FunctionalWriting extends _abap_rule_1.ABAPRule {
|
|
|
62344
62345
|
key: "functional_writing",
|
|
62345
62346
|
title: "Use functional writing",
|
|
62346
62347
|
shortDescription: `Detects usage of call method when functional style calls can be used.`,
|
|
62347
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-functional-to-procedural-calls
|
|
62348
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-functional-to-procedural-calls
|
|
62348
62349
|
https://docs.abapopenchecks.org/checks/07/`,
|
|
62349
62350
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
62350
|
-
badExample: `CALL METHOD zcl_class=>method( ).
|
|
62351
|
-
CALL METHOD cl_abap_typedescr=>describe_by_name
|
|
62352
|
-
EXPORTING
|
|
62353
|
-
p_name = 'NAME'
|
|
62354
|
-
RECEIVING
|
|
62355
|
-
p_descr_ref = lr_typedescr
|
|
62356
|
-
EXCEPTIONS
|
|
62357
|
-
type_not_found = 1
|
|
62351
|
+
badExample: `CALL METHOD zcl_class=>method( ).
|
|
62352
|
+
CALL METHOD cl_abap_typedescr=>describe_by_name
|
|
62353
|
+
EXPORTING
|
|
62354
|
+
p_name = 'NAME'
|
|
62355
|
+
RECEIVING
|
|
62356
|
+
p_descr_ref = lr_typedescr
|
|
62357
|
+
EXCEPTIONS
|
|
62358
|
+
type_not_found = 1
|
|
62358
62359
|
OTHERS = 2.`,
|
|
62359
|
-
goodExample: `zcl_class=>method( ).
|
|
62360
|
-
cl_abap_typedescr=>describe_by_name(
|
|
62361
|
-
EXPORTING
|
|
62362
|
-
p_name = 'NAME'
|
|
62363
|
-
RECEIVING
|
|
62364
|
-
p_descr_ref = lr_typedescr
|
|
62365
|
-
EXCEPTIONS
|
|
62366
|
-
type_not_found = 1
|
|
62360
|
+
goodExample: `zcl_class=>method( ).
|
|
62361
|
+
cl_abap_typedescr=>describe_by_name(
|
|
62362
|
+
EXPORTING
|
|
62363
|
+
p_name = 'NAME'
|
|
62364
|
+
RECEIVING
|
|
62365
|
+
p_descr_ref = lr_typedescr
|
|
62366
|
+
EXCEPTIONS
|
|
62367
|
+
type_not_found = 1
|
|
62367
62368
|
OTHERS = 2 ).`,
|
|
62368
62369
|
};
|
|
62369
62370
|
}
|
|
@@ -62474,14 +62475,14 @@ class GlobalClass extends _abap_rule_1.ABAPRule {
|
|
|
62474
62475
|
key: "global_class",
|
|
62475
62476
|
title: "Global class checks",
|
|
62476
62477
|
shortDescription: `Checks related to global classes`,
|
|
62477
|
-
extendedInformation: `* global classes must be in own files
|
|
62478
|
-
|
|
62479
|
-
* file names must match class name
|
|
62480
|
-
|
|
62481
|
-
* file names must match interface name
|
|
62482
|
-
|
|
62483
|
-
* global classes must be global definitions
|
|
62484
|
-
|
|
62478
|
+
extendedInformation: `* global classes must be in own files
|
|
62479
|
+
|
|
62480
|
+
* file names must match class name
|
|
62481
|
+
|
|
62482
|
+
* file names must match interface name
|
|
62483
|
+
|
|
62484
|
+
* global classes must be global definitions
|
|
62485
|
+
|
|
62485
62486
|
* global interfaces must be global definitions`,
|
|
62486
62487
|
tags: [_irule_1.RuleTag.Syntax],
|
|
62487
62488
|
};
|
|
@@ -62580,21 +62581,21 @@ class IdenticalConditions extends _abap_rule_1.ABAPRule {
|
|
|
62580
62581
|
return {
|
|
62581
62582
|
key: "identical_conditions",
|
|
62582
62583
|
title: "Identical conditions",
|
|
62583
|
-
shortDescription: `Find identical conditions in IF + CASE + WHILE etc
|
|
62584
|
-
|
|
62584
|
+
shortDescription: `Find identical conditions in IF + CASE + WHILE etc
|
|
62585
|
+
|
|
62585
62586
|
Prerequsites: code is pretty printed with identical cAsE`,
|
|
62586
62587
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
62587
|
-
badExample: `IF foo = bar OR 1 = a OR foo = bar.
|
|
62588
|
-
ENDIF.
|
|
62589
|
-
CASE bar.
|
|
62590
|
-
WHEN '1'.
|
|
62591
|
-
WHEN 'A' OR '1'.
|
|
62588
|
+
badExample: `IF foo = bar OR 1 = a OR foo = bar.
|
|
62589
|
+
ENDIF.
|
|
62590
|
+
CASE bar.
|
|
62591
|
+
WHEN '1'.
|
|
62592
|
+
WHEN 'A' OR '1'.
|
|
62592
62593
|
ENDCASE.`,
|
|
62593
|
-
goodExample: `IF foo = bar OR 1 = a.
|
|
62594
|
-
ENDIF.
|
|
62595
|
-
CASE bar.
|
|
62596
|
-
WHEN '1'.
|
|
62597
|
-
WHEN 'A'.
|
|
62594
|
+
goodExample: `IF foo = bar OR 1 = a.
|
|
62595
|
+
ENDIF.
|
|
62596
|
+
CASE bar.
|
|
62597
|
+
WHEN '1'.
|
|
62598
|
+
WHEN 'A'.
|
|
62598
62599
|
ENDCASE.`,
|
|
62599
62600
|
};
|
|
62600
62601
|
}
|
|
@@ -62728,23 +62729,23 @@ class IdenticalContents extends _abap_rule_1.ABAPRule {
|
|
|
62728
62729
|
key: "identical_contents",
|
|
62729
62730
|
title: "Identical contents",
|
|
62730
62731
|
shortDescription: `Find identical contents in blocks inside IFs, both in the beginning and in the end.`,
|
|
62731
|
-
extendedInformation: `
|
|
62732
|
-
Prerequsites: code is pretty printed with identical cAsE
|
|
62733
|
-
|
|
62732
|
+
extendedInformation: `
|
|
62733
|
+
Prerequsites: code is pretty printed with identical cAsE
|
|
62734
|
+
|
|
62734
62735
|
Chained statments are ignored`,
|
|
62735
62736
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
62736
|
-
badExample: `IF foo = bar.
|
|
62737
|
-
WRITE 'bar'.
|
|
62738
|
-
WRITE 'world'.
|
|
62739
|
-
ELSE.
|
|
62740
|
-
WRITE 'foo'.
|
|
62741
|
-
WRITE 'world'.
|
|
62737
|
+
badExample: `IF foo = bar.
|
|
62738
|
+
WRITE 'bar'.
|
|
62739
|
+
WRITE 'world'.
|
|
62740
|
+
ELSE.
|
|
62741
|
+
WRITE 'foo'.
|
|
62742
|
+
WRITE 'world'.
|
|
62742
62743
|
ENDIF.`,
|
|
62743
|
-
goodExample: `IF foo = bar.
|
|
62744
|
-
WRITE 'bar'.
|
|
62745
|
-
ELSE.
|
|
62746
|
-
WRITE 'foo'.
|
|
62747
|
-
ENDIF.
|
|
62744
|
+
goodExample: `IF foo = bar.
|
|
62745
|
+
WRITE 'bar'.
|
|
62746
|
+
ELSE.
|
|
62747
|
+
WRITE 'foo'.
|
|
62748
|
+
ENDIF.
|
|
62748
62749
|
WRITE 'world'.`,
|
|
62749
62750
|
};
|
|
62750
62751
|
}
|
|
@@ -62852,12 +62853,12 @@ class IdenticalDescriptions {
|
|
|
62852
62853
|
key: "identical_descriptions",
|
|
62853
62854
|
title: "Identical descriptions",
|
|
62854
62855
|
shortDescription: `Searches for objects with the same type and same description`,
|
|
62855
|
-
extendedInformation: `Case insensitive
|
|
62856
|
-
|
|
62857
|
-
Only checks the master language descriptions
|
|
62858
|
-
|
|
62859
|
-
Dependencies are skipped
|
|
62860
|
-
|
|
62856
|
+
extendedInformation: `Case insensitive
|
|
62857
|
+
|
|
62858
|
+
Only checks the master language descriptions
|
|
62859
|
+
|
|
62860
|
+
Dependencies are skipped
|
|
62861
|
+
|
|
62861
62862
|
Works for: INTF, CLAS, DOMA, DTEL, FUNC in same FUGR`,
|
|
62862
62863
|
tags: [],
|
|
62863
62864
|
};
|
|
@@ -63031,43 +63032,43 @@ class IfInIf extends _abap_rule_1.ABAPRule {
|
|
|
63031
63032
|
key: "if_in_if",
|
|
63032
63033
|
title: "IF in IF",
|
|
63033
63034
|
shortDescription: `Detects nested ifs which can be refactored.`,
|
|
63034
|
-
extendedInformation: `
|
|
63035
|
-
Directly nested IFs without ELSE can be refactored to a single condition using AND.
|
|
63036
|
-
|
|
63037
|
-
ELSE condtions with directly nested IF refactored to ELSEIF, quickfixes are suggested for this case.
|
|
63038
|
-
|
|
63039
|
-
https://docs.abapopenchecks.org/checks/01/
|
|
63035
|
+
extendedInformation: `
|
|
63036
|
+
Directly nested IFs without ELSE can be refactored to a single condition using AND.
|
|
63037
|
+
|
|
63038
|
+
ELSE condtions with directly nested IF refactored to ELSEIF, quickfixes are suggested for this case.
|
|
63039
|
+
|
|
63040
|
+
https://docs.abapopenchecks.org/checks/01/
|
|
63040
63041
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-the-nesting-depth-low`,
|
|
63041
|
-
badExample: `IF condition1.
|
|
63042
|
-
IF condition2.
|
|
63043
|
-
...
|
|
63044
|
-
ENDIF.
|
|
63045
|
-
ENDIF.
|
|
63046
|
-
|
|
63047
|
-
IF condition1.
|
|
63048
|
-
...
|
|
63049
|
-
ELSE.
|
|
63050
|
-
IF condition2.
|
|
63051
|
-
...
|
|
63052
|
-
ENDIF.
|
|
63042
|
+
badExample: `IF condition1.
|
|
63043
|
+
IF condition2.
|
|
63044
|
+
...
|
|
63045
|
+
ENDIF.
|
|
63046
|
+
ENDIF.
|
|
63047
|
+
|
|
63048
|
+
IF condition1.
|
|
63049
|
+
...
|
|
63050
|
+
ELSE.
|
|
63051
|
+
IF condition2.
|
|
63052
|
+
...
|
|
63053
|
+
ENDIF.
|
|
63053
63054
|
ENDIF.`,
|
|
63054
|
-
goodExample: `IF ( condition1 ) AND ( condition2 ).
|
|
63055
|
-
...
|
|
63056
|
-
ENDIF.
|
|
63057
|
-
|
|
63058
|
-
IF condition1.
|
|
63059
|
-
...
|
|
63060
|
-
ELSEIF condition2.
|
|
63061
|
-
...
|
|
63062
|
-
ENDIF.
|
|
63063
|
-
|
|
63064
|
-
CASE variable.
|
|
63065
|
-
WHEN value1.
|
|
63066
|
-
...
|
|
63067
|
-
WHEN value2.
|
|
63068
|
-
IF condition2.
|
|
63069
|
-
...
|
|
63070
|
-
ENDIF.
|
|
63055
|
+
goodExample: `IF ( condition1 ) AND ( condition2 ).
|
|
63056
|
+
...
|
|
63057
|
+
ENDIF.
|
|
63058
|
+
|
|
63059
|
+
IF condition1.
|
|
63060
|
+
...
|
|
63061
|
+
ELSEIF condition2.
|
|
63062
|
+
...
|
|
63063
|
+
ENDIF.
|
|
63064
|
+
|
|
63065
|
+
CASE variable.
|
|
63066
|
+
WHEN value1.
|
|
63067
|
+
...
|
|
63068
|
+
WHEN value2.
|
|
63069
|
+
IF condition2.
|
|
63070
|
+
...
|
|
63071
|
+
ENDIF.
|
|
63071
63072
|
ENDCASE.`,
|
|
63072
63073
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
|
|
63073
63074
|
};
|
|
@@ -63252,9 +63253,9 @@ class ImplementMethods extends _abap_rule_1.ABAPRule {
|
|
|
63252
63253
|
for (const i of ((_a = file.getStructure()) === null || _a === void 0 ? void 0 : _a.findAllStatements(Statements.ClassImplementation)) || []) {
|
|
63253
63254
|
const name = (_b = i.findFirstExpression(Expressions.ClassName)) === null || _b === void 0 ? void 0 : _b.getFirstToken().getStr().toUpperCase();
|
|
63254
63255
|
if (name === impl.identifier.getName().toUpperCase()) {
|
|
63255
|
-
return edit_helper_1.EditHelper.insertAt(file, i.getLastToken().getEnd(), `
|
|
63256
|
-
METHOD ${methodName.toLowerCase()}.
|
|
63257
|
-
RETURN. " todo, implement method
|
|
63256
|
+
return edit_helper_1.EditHelper.insertAt(file, i.getLastToken().getEnd(), `
|
|
63257
|
+
METHOD ${methodName.toLowerCase()}.
|
|
63258
|
+
RETURN. " todo, implement method
|
|
63258
63259
|
ENDMETHOD.`);
|
|
63259
63260
|
}
|
|
63260
63261
|
}
|
|
@@ -63433,14 +63434,14 @@ class ImplicitStartOfSelection extends _abap_rule_1.ABAPRule {
|
|
|
63433
63434
|
key: "implicit_start_of_selection",
|
|
63434
63435
|
title: "Implicit START-OF-SELECTION",
|
|
63435
63436
|
shortDescription: `Add explicit selection screen event handling`,
|
|
63436
|
-
extendedInformation: `Only runs for executable programs
|
|
63437
|
-
|
|
63437
|
+
extendedInformation: `Only runs for executable programs
|
|
63438
|
+
|
|
63438
63439
|
https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapstart-of-selection.htm`,
|
|
63439
63440
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
63440
|
-
badExample: `REPORT zfoo.
|
|
63441
|
+
badExample: `REPORT zfoo.
|
|
63441
63442
|
WRITE 'hello'.`,
|
|
63442
|
-
goodExample: `
|
|
63443
|
-
START-OF-SELECTION.
|
|
63443
|
+
goodExample: `
|
|
63444
|
+
START-OF-SELECTION.
|
|
63444
63445
|
WRITE 'hello'.`,
|
|
63445
63446
|
};
|
|
63446
63447
|
}
|
|
@@ -63545,19 +63546,19 @@ class InStatementIndentation extends _abap_rule_1.ABAPRule {
|
|
|
63545
63546
|
key: "in_statement_indentation",
|
|
63546
63547
|
title: "In-statement indentation",
|
|
63547
63548
|
shortDescription: "Checks alignment within statements which span multiple lines.",
|
|
63548
|
-
extendedInformation: `Lines following the first line should be indented once (2 spaces).
|
|
63549
|
-
|
|
63550
|
-
For block declaration statements, lines after the first should be indented an additional time (default: +2 spaces)
|
|
63549
|
+
extendedInformation: `Lines following the first line should be indented once (2 spaces).
|
|
63550
|
+
|
|
63551
|
+
For block declaration statements, lines after the first should be indented an additional time (default: +2 spaces)
|
|
63551
63552
|
to distinguish them better from code within the block.`,
|
|
63552
|
-
badExample: `IF 1 = 1
|
|
63553
|
-
AND 2 = 2.
|
|
63554
|
-
WRITE 'hello' &&
|
|
63555
|
-
'world'.
|
|
63553
|
+
badExample: `IF 1 = 1
|
|
63554
|
+
AND 2 = 2.
|
|
63555
|
+
WRITE 'hello' &&
|
|
63556
|
+
'world'.
|
|
63556
63557
|
ENDIF.`,
|
|
63557
|
-
goodExample: `IF 1 = 1
|
|
63558
|
-
AND 2 = 2.
|
|
63559
|
-
WRITE 'hello' &&
|
|
63560
|
-
'world'.
|
|
63558
|
+
goodExample: `IF 1 = 1
|
|
63559
|
+
AND 2 = 2.
|
|
63560
|
+
WRITE 'hello' &&
|
|
63561
|
+
'world'.
|
|
63561
63562
|
ENDIF.`,
|
|
63562
63563
|
tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
63563
63564
|
};
|
|
@@ -63680,23 +63681,23 @@ class Indentation extends _abap_rule_1.ABAPRule {
|
|
|
63680
63681
|
title: "Indentation",
|
|
63681
63682
|
shortDescription: `Checks indentation`,
|
|
63682
63683
|
tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
63683
|
-
badExample: `CLASS lcl DEFINITION.
|
|
63684
|
-
PRIVATE SECTION.
|
|
63685
|
-
METHODS constructor.
|
|
63686
|
-
ENDCLASS.
|
|
63687
|
-
|
|
63688
|
-
CLASS lcl IMPLEMENTATION.
|
|
63689
|
-
METHOD constructor.
|
|
63690
|
-
ENDMETHOD.
|
|
63684
|
+
badExample: `CLASS lcl DEFINITION.
|
|
63685
|
+
PRIVATE SECTION.
|
|
63686
|
+
METHODS constructor.
|
|
63687
|
+
ENDCLASS.
|
|
63688
|
+
|
|
63689
|
+
CLASS lcl IMPLEMENTATION.
|
|
63690
|
+
METHOD constructor.
|
|
63691
|
+
ENDMETHOD.
|
|
63691
63692
|
ENDCLASS.`,
|
|
63692
|
-
goodExample: `CLASS lcl DEFINITION.
|
|
63693
|
-
PRIVATE SECTION.
|
|
63694
|
-
METHODS constructor.
|
|
63695
|
-
ENDCLASS.
|
|
63696
|
-
|
|
63697
|
-
CLASS lcl IMPLEMENTATION.
|
|
63698
|
-
METHOD constructor.
|
|
63699
|
-
ENDMETHOD.
|
|
63693
|
+
goodExample: `CLASS lcl DEFINITION.
|
|
63694
|
+
PRIVATE SECTION.
|
|
63695
|
+
METHODS constructor.
|
|
63696
|
+
ENDCLASS.
|
|
63697
|
+
|
|
63698
|
+
CLASS lcl IMPLEMENTATION.
|
|
63699
|
+
METHOD constructor.
|
|
63700
|
+
ENDMETHOD.
|
|
63700
63701
|
ENDCLASS.`,
|
|
63701
63702
|
};
|
|
63702
63703
|
}
|
|
@@ -64097,9 +64098,9 @@ class IntfReferencingClas {
|
|
|
64097
64098
|
key: "intf_referencing_clas",
|
|
64098
64099
|
title: "INTF referencing CLAS",
|
|
64099
64100
|
shortDescription: `Interface contains references to class`,
|
|
64100
|
-
extendedInformation: `Only global interfaces are checked.
|
|
64101
|
-
Only first level references are checked.
|
|
64102
|
-
Exception class references are ignored.
|
|
64101
|
+
extendedInformation: `Only global interfaces are checked.
|
|
64102
|
+
Only first level references are checked.
|
|
64103
|
+
Exception class references are ignored.
|
|
64103
64104
|
Void references are ignored.`,
|
|
64104
64105
|
};
|
|
64105
64106
|
}
|
|
@@ -64184,9 +64185,9 @@ class InvalidTableIndex extends _abap_rule_1.ABAPRule {
|
|
|
64184
64185
|
title: "Invalid Table Index",
|
|
64185
64186
|
shortDescription: `Issues error for constant table index zero, as ABAP starts from 1`,
|
|
64186
64187
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
|
|
64187
|
-
badExample: `DATA(first) = table[ 0 ].
|
|
64188
|
+
badExample: `DATA(first) = table[ 0 ].
|
|
64188
64189
|
READ TABLE gt_stack ASSIGNING <ls_stack> INDEX 0.`,
|
|
64189
|
-
goodExample: `DATA(first) = table[ 1 ].
|
|
64190
|
+
goodExample: `DATA(first) = table[ 1 ].
|
|
64190
64191
|
READ TABLE gt_stack ASSIGNING <ls_stack> INDEX 1.`,
|
|
64191
64192
|
};
|
|
64192
64193
|
}
|
|
@@ -64787,8 +64788,8 @@ class LineBreakStyle {
|
|
|
64787
64788
|
return {
|
|
64788
64789
|
key: "line_break_style",
|
|
64789
64790
|
title: "Makes sure line breaks are consistent in the ABAP code",
|
|
64790
|
-
shortDescription: `Enforces LF as newlines in ABAP files
|
|
64791
|
-
|
|
64791
|
+
shortDescription: `Enforces LF as newlines in ABAP files
|
|
64792
|
+
|
|
64792
64793
|
abapGit does not work with CRLF`,
|
|
64793
64794
|
tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.SingleFile],
|
|
64794
64795
|
};
|
|
@@ -64857,7 +64858,7 @@ class LineLength extends _abap_rule_1.ABAPRule {
|
|
|
64857
64858
|
key: "line_length",
|
|
64858
64859
|
title: "Line length",
|
|
64859
64860
|
shortDescription: `Detects lines exceeding the provided maximum length.`,
|
|
64860
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#stick-to-a-reasonable-line-length
|
|
64861
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#stick-to-a-reasonable-line-length
|
|
64861
64862
|
https://docs.abapopenchecks.org/checks/04/`,
|
|
64862
64863
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
64863
64864
|
};
|
|
@@ -64928,7 +64929,7 @@ class LineOnlyPunc extends _abap_rule_1.ABAPRule {
|
|
|
64928
64929
|
key: "line_only_punc",
|
|
64929
64930
|
title: "Line containing only punctuation",
|
|
64930
64931
|
shortDescription: `Detects lines containing only punctuation.`,
|
|
64931
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#close-brackets-at-line-end
|
|
64932
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#close-brackets-at-line-end
|
|
64932
64933
|
https://docs.abapopenchecks.org/checks/16/`,
|
|
64933
64934
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
64934
64935
|
badExample: "zcl_class=>method(\n).",
|
|
@@ -65191,15 +65192,15 @@ class LocalVariableNames extends _abap_rule_1.ABAPRule {
|
|
|
65191
65192
|
return {
|
|
65192
65193
|
key: "local_variable_names",
|
|
65193
65194
|
title: "Local variable naming conventions",
|
|
65194
|
-
shortDescription: `
|
|
65195
|
-
Allows you to enforce a pattern, such as a prefix, for local variables, constants and field symbols.
|
|
65195
|
+
shortDescription: `
|
|
65196
|
+
Allows you to enforce a pattern, such as a prefix, for local variables, constants and field symbols.
|
|
65196
65197
|
Regexes are case-insensitive.`,
|
|
65197
65198
|
tags: [_irule_1.RuleTag.Naming, _irule_1.RuleTag.SingleFile],
|
|
65198
|
-
badExample: `FORM bar.
|
|
65199
|
-
DATA foo.
|
|
65199
|
+
badExample: `FORM bar.
|
|
65200
|
+
DATA foo.
|
|
65200
65201
|
ENDFORM.`,
|
|
65201
|
-
goodExample: `FORM bar.
|
|
65202
|
-
DATA lv_foo.
|
|
65202
|
+
goodExample: `FORM bar.
|
|
65203
|
+
DATA lv_foo.
|
|
65203
65204
|
ENDFORM.`,
|
|
65204
65205
|
};
|
|
65205
65206
|
}
|
|
@@ -65351,9 +65352,9 @@ class MacroNaming extends _abap_rule_1.ABAPRule {
|
|
|
65351
65352
|
shortDescription: `Allows you to enforce a pattern for macro definitions`,
|
|
65352
65353
|
extendedInformation: `Use rule "avoid_use" to avoid macros altogether.`,
|
|
65353
65354
|
tags: [_irule_1.RuleTag.Naming, _irule_1.RuleTag.SingleFile],
|
|
65354
|
-
badExample: `DEFINE something.
|
|
65355
|
+
badExample: `DEFINE something.
|
|
65355
65356
|
END-OF-DEFINITION.`,
|
|
65356
|
-
goodExample: `DEFINE _something.
|
|
65357
|
+
goodExample: `DEFINE _something.
|
|
65357
65358
|
END-OF-DEFINITION.`,
|
|
65358
65359
|
};
|
|
65359
65360
|
}
|
|
@@ -65426,10 +65427,10 @@ class MainFileContents {
|
|
|
65426
65427
|
key: "main_file_contents",
|
|
65427
65428
|
title: "Main file contents",
|
|
65428
65429
|
shortDescription: `Checks related to report declarations.`,
|
|
65429
|
-
extendedInformation: `Does not run if the target version is Cloud
|
|
65430
|
-
|
|
65431
|
-
* PROGs must begin with "REPORT <name>." or "PROGRAM <name>.
|
|
65432
|
-
* TYPEs must begin with "TYPE-POOL <name>."
|
|
65430
|
+
extendedInformation: `Does not run if the target version is Cloud
|
|
65431
|
+
|
|
65432
|
+
* PROGs must begin with "REPORT <name>." or "PROGRAM <name>.
|
|
65433
|
+
* TYPEs must begin with "TYPE-POOL <name>."
|
|
65433
65434
|
`,
|
|
65434
65435
|
};
|
|
65435
65436
|
}
|
|
@@ -65545,17 +65546,17 @@ class ManyParentheses extends _abap_rule_1.ABAPRule {
|
|
|
65545
65546
|
title: "Too many parentheses",
|
|
65546
65547
|
shortDescription: `Searches for expressions where extra parentheses can safely be removed`,
|
|
65547
65548
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
|
|
65548
|
-
badExample: `
|
|
65549
|
-
IF ( destination IS INITIAL ).
|
|
65550
|
-
ENDIF.
|
|
65551
|
-
IF foo = boo AND ( bar = lar AND moo = loo ).
|
|
65552
|
-
ENDIF.
|
|
65549
|
+
badExample: `
|
|
65550
|
+
IF ( destination IS INITIAL ).
|
|
65551
|
+
ENDIF.
|
|
65552
|
+
IF foo = boo AND ( bar = lar AND moo = loo ).
|
|
65553
|
+
ENDIF.
|
|
65553
65554
|
`,
|
|
65554
|
-
goodExample: `
|
|
65555
|
-
IF destination IS INITIAL.
|
|
65556
|
-
ENDIF.
|
|
65557
|
-
IF foo = boo AND bar = lar AND moo = loo.
|
|
65558
|
-
ENDIF.
|
|
65555
|
+
goodExample: `
|
|
65556
|
+
IF destination IS INITIAL.
|
|
65557
|
+
ENDIF.
|
|
65558
|
+
IF foo = boo AND bar = lar AND moo = loo.
|
|
65559
|
+
ENDIF.
|
|
65559
65560
|
`,
|
|
65560
65561
|
};
|
|
65561
65562
|
}
|
|
@@ -65729,14 +65730,14 @@ class MaxOneMethodParameterPerLine extends _abap_rule_1.ABAPRule {
|
|
|
65729
65730
|
title: "Max one method parameter definition per line",
|
|
65730
65731
|
shortDescription: `Keep max one method parameter description per line`,
|
|
65731
65732
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace],
|
|
65732
|
-
badExample: `
|
|
65733
|
-
METHODS apps_scope_token
|
|
65734
|
-
IMPORTING
|
|
65733
|
+
badExample: `
|
|
65734
|
+
METHODS apps_scope_token
|
|
65735
|
+
IMPORTING
|
|
65735
65736
|
body TYPE bodyapps_scope_token client_id TYPE str.`,
|
|
65736
|
-
goodExample: `
|
|
65737
|
-
METHODS apps_scope_token
|
|
65738
|
-
IMPORTING
|
|
65739
|
-
body TYPE bodyapps_scope_token
|
|
65737
|
+
goodExample: `
|
|
65738
|
+
METHODS apps_scope_token
|
|
65739
|
+
IMPORTING
|
|
65740
|
+
body TYPE bodyapps_scope_token
|
|
65740
65741
|
client_id TYPE str.`,
|
|
65741
65742
|
};
|
|
65742
65743
|
}
|
|
@@ -65801,11 +65802,11 @@ class MaxOneStatement extends _abap_rule_1.ABAPRule {
|
|
|
65801
65802
|
key: "max_one_statement",
|
|
65802
65803
|
title: "Max one statement per line",
|
|
65803
65804
|
shortDescription: `Checks that each line contains only a single statement.`,
|
|
65804
|
-
extendedInformation: `Does not report empty statements, use rule empty_statement for detecting empty statements.
|
|
65805
|
-
|
|
65806
|
-
Does not report anything for chained statements.
|
|
65807
|
-
|
|
65808
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#no-more-than-one-statement-per-line
|
|
65805
|
+
extendedInformation: `Does not report empty statements, use rule empty_statement for detecting empty statements.
|
|
65806
|
+
|
|
65807
|
+
Does not report anything for chained statements.
|
|
65808
|
+
|
|
65809
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#no-more-than-one-statement-per-line
|
|
65809
65810
|
https://docs.abapopenchecks.org/checks/11/`,
|
|
65810
65811
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
65811
65812
|
badExample: `WRITE foo. WRITE bar.`,
|
|
@@ -66143,8 +66144,8 @@ class MethodLength {
|
|
|
66143
66144
|
key: "method_length",
|
|
66144
66145
|
title: "Method/Form Length",
|
|
66145
66146
|
shortDescription: `Checks relating to method/form length.`,
|
|
66146
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-methods-small
|
|
66147
|
-
|
|
66147
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-methods-small
|
|
66148
|
+
|
|
66148
66149
|
Abstract methods without statements are considered okay.`,
|
|
66149
66150
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
66150
66151
|
};
|
|
@@ -66249,20 +66250,20 @@ class MethodOverwritesBuiltIn extends _abap_rule_1.ABAPRule {
|
|
|
66249
66250
|
key: "method_overwrites_builtin",
|
|
66250
66251
|
title: "Method name overwrites builtin function",
|
|
66251
66252
|
shortDescription: `Checks Method names that overwrite builtin SAP functions`,
|
|
66252
|
-
extendedInformation: `https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abenbuilt_in_functions_overview.htm
|
|
66253
|
-
|
|
66254
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-obscuring-built-in-functions
|
|
66255
|
-
|
|
66253
|
+
extendedInformation: `https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abenbuilt_in_functions_overview.htm
|
|
66254
|
+
|
|
66255
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-obscuring-built-in-functions
|
|
66256
|
+
|
|
66256
66257
|
Interface method names are ignored`,
|
|
66257
66258
|
tags: [_irule_1.RuleTag.Naming, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
|
|
66258
|
-
badExample: `CLASS lcl DEFINITION.
|
|
66259
|
-
PUBLIC SECTION.
|
|
66260
|
-
METHODS matches.
|
|
66261
|
-
ENDCLASS.
|
|
66262
|
-
|
|
66263
|
-
CLASS lcl IMPLEMENTATION.
|
|
66264
|
-
METHOD matches.
|
|
66265
|
-
ENDMETHOD.
|
|
66259
|
+
badExample: `CLASS lcl DEFINITION.
|
|
66260
|
+
PUBLIC SECTION.
|
|
66261
|
+
METHODS matches.
|
|
66262
|
+
ENDCLASS.
|
|
66263
|
+
|
|
66264
|
+
CLASS lcl IMPLEMENTATION.
|
|
66265
|
+
METHOD matches.
|
|
66266
|
+
ENDMETHOD.
|
|
66266
66267
|
ENDCLASS.`,
|
|
66267
66268
|
};
|
|
66268
66269
|
}
|
|
@@ -66453,12 +66454,12 @@ class MixReturning extends _abap_rule_1.ABAPRule {
|
|
|
66453
66454
|
// eslint-disable-next-line max-len
|
|
66454
66455
|
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-either-returning-or-exporting-or-changing-but-not-a-combination`,
|
|
66455
66456
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
66456
|
-
badExample: `CLASS lcl DEFINITION.
|
|
66457
|
-
PUBLIC SECTION.
|
|
66458
|
-
METHODS
|
|
66459
|
-
foobar
|
|
66460
|
-
EXPORTING foo TYPE i
|
|
66461
|
-
RETURNING VALUE(rv_string) TYPE string.
|
|
66457
|
+
badExample: `CLASS lcl DEFINITION.
|
|
66458
|
+
PUBLIC SECTION.
|
|
66459
|
+
METHODS
|
|
66460
|
+
foobar
|
|
66461
|
+
EXPORTING foo TYPE i
|
|
66462
|
+
RETURNING VALUE(rv_string) TYPE string.
|
|
66462
66463
|
ENDCLASS.`,
|
|
66463
66464
|
};
|
|
66464
66465
|
}
|
|
@@ -66838,7 +66839,7 @@ class Nesting extends _abap_rule_1.ABAPRule {
|
|
|
66838
66839
|
key: "nesting",
|
|
66839
66840
|
title: "Check nesting depth",
|
|
66840
66841
|
shortDescription: `Checks for methods exceeding a maximum nesting depth`,
|
|
66841
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-the-nesting-depth-low
|
|
66842
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-the-nesting-depth-low
|
|
66842
66843
|
https://docs.abapopenchecks.org/checks/74/`,
|
|
66843
66844
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
66844
66845
|
};
|
|
@@ -67081,7 +67082,7 @@ class NoChainedAssignment extends _abap_rule_1.ABAPRule {
|
|
|
67081
67082
|
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-chain-assignments`,
|
|
67082
67083
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
|
|
67083
67084
|
badExample: `var1 = var2 = var3.`,
|
|
67084
|
-
goodExample: `var2 = var3.
|
|
67085
|
+
goodExample: `var2 = var3.
|
|
67085
67086
|
var1 = var2.`,
|
|
67086
67087
|
};
|
|
67087
67088
|
}
|
|
@@ -67140,8 +67141,8 @@ class NoExternalFormCalls extends _abap_rule_1.ABAPRule {
|
|
|
67140
67141
|
key: "no_external_form_calls",
|
|
67141
67142
|
title: "No external FORM calls",
|
|
67142
67143
|
shortDescription: `Detect external form calls`,
|
|
67143
|
-
badExample: `PERFORM foo IN PROGRAM bar.
|
|
67144
|
-
|
|
67144
|
+
badExample: `PERFORM foo IN PROGRAM bar.
|
|
67145
|
+
|
|
67145
67146
|
PERFORM foo(bar).`,
|
|
67146
67147
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
67147
67148
|
};
|
|
@@ -67202,17 +67203,17 @@ class NoInlineInOptionalBranches extends _abap_rule_1.ABAPRule {
|
|
|
67202
67203
|
key: "no_inline_in_optional_branches",
|
|
67203
67204
|
title: "Don't declare inline in optional branches",
|
|
67204
67205
|
shortDescription: `Don't declare inline in optional branches`,
|
|
67205
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-declare-inline-in-optional-branches
|
|
67206
|
-
|
|
67207
|
-
Considered optional branches:
|
|
67208
|
-
* inside IF/ELSEIF/ELSE
|
|
67209
|
-
* inside LOOP
|
|
67210
|
-
* inside WHILE
|
|
67211
|
-
* inside CASE/WHEN, CASE TYPE OF
|
|
67212
|
-
* inside DO
|
|
67213
|
-
* inside SELECT loops
|
|
67214
|
-
|
|
67215
|
-
Not considered optional branches:
|
|
67206
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-declare-inline-in-optional-branches
|
|
67207
|
+
|
|
67208
|
+
Considered optional branches:
|
|
67209
|
+
* inside IF/ELSEIF/ELSE
|
|
67210
|
+
* inside LOOP
|
|
67211
|
+
* inside WHILE
|
|
67212
|
+
* inside CASE/WHEN, CASE TYPE OF
|
|
67213
|
+
* inside DO
|
|
67214
|
+
* inside SELECT loops
|
|
67215
|
+
|
|
67216
|
+
Not considered optional branches:
|
|
67216
67217
|
* TRY/CATCH/CLEANUP`,
|
|
67217
67218
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
67218
67219
|
};
|
|
@@ -67312,12 +67313,12 @@ class NoPrefixes extends _abap_rule_1.ABAPRule {
|
|
|
67312
67313
|
key: "no_prefixes",
|
|
67313
67314
|
title: "No Prefixes",
|
|
67314
67315
|
shortDescription: `Dont use hungarian notation`,
|
|
67315
|
-
extendedInformation: `
|
|
67316
|
-
Note: not prefixing TYPES will require changing the errorNamespace in the abaplint configuration,
|
|
67317
|
-
allowing all types to become voided, abaplint will then provide less precise syntax errors.
|
|
67318
|
-
|
|
67319
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-encodings-esp-hungarian-notation-and-prefixes
|
|
67320
|
-
|
|
67316
|
+
extendedInformation: `
|
|
67317
|
+
Note: not prefixing TYPES will require changing the errorNamespace in the abaplint configuration,
|
|
67318
|
+
allowing all types to become voided, abaplint will then provide less precise syntax errors.
|
|
67319
|
+
|
|
67320
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-encodings-esp-hungarian-notation-and-prefixes
|
|
67321
|
+
|
|
67321
67322
|
https://github.com/SAP/styleguides/blob/main/clean-abap/sub-sections/AvoidEncodings.md`,
|
|
67322
67323
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
|
|
67323
67324
|
badExample: `DATA lv_foo TYPE i.`,
|
|
@@ -67496,7 +67497,7 @@ class NoPublicAttributes extends _abap_rule_1.ABAPRule {
|
|
|
67496
67497
|
return {
|
|
67497
67498
|
key: "no_public_attributes",
|
|
67498
67499
|
title: "No public attributes",
|
|
67499
|
-
shortDescription: `Checks that classes and interfaces don't contain any public attributes.
|
|
67500
|
+
shortDescription: `Checks that classes and interfaces don't contain any public attributes.
|
|
67500
67501
|
Exceptions are excluded from this rule.`,
|
|
67501
67502
|
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#members-private-by-default-protected-only-if-needed`,
|
|
67502
67503
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
@@ -67597,13 +67598,13 @@ class NoYodaConditions extends _abap_rule_1.ABAPRule {
|
|
|
67597
67598
|
key: "no_yoda_conditions",
|
|
67598
67599
|
title: "No Yoda conditions",
|
|
67599
67600
|
shortDescription: `Finds Yoda conditions and reports issues`,
|
|
67600
|
-
extendedInformation: `https://en.wikipedia.org/wiki/Yoda_conditions
|
|
67601
|
-
|
|
67601
|
+
extendedInformation: `https://en.wikipedia.org/wiki/Yoda_conditions
|
|
67602
|
+
|
|
67602
67603
|
Conditions with operators CP, NP, CS, NS, CA, NA, CO, CN are ignored`,
|
|
67603
67604
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
67604
|
-
badExample: `IF 0 <> sy-subrc.
|
|
67605
|
+
badExample: `IF 0 <> sy-subrc.
|
|
67605
67606
|
ENDIF.`,
|
|
67606
|
-
goodExample: `IF sy-subrc <> 0.
|
|
67607
|
+
goodExample: `IF sy-subrc <> 0.
|
|
67607
67608
|
ENDIF.`,
|
|
67608
67609
|
};
|
|
67609
67610
|
}
|
|
@@ -67704,8 +67705,8 @@ class NROBConsistency {
|
|
|
67704
67705
|
key: "nrob_consistency",
|
|
67705
67706
|
title: "Number range consistency",
|
|
67706
67707
|
shortDescription: `Consistency checks for number ranges`,
|
|
67707
|
-
extendedInformation: `Issue reported if percentage warning is over 50%
|
|
67708
|
-
|
|
67708
|
+
extendedInformation: `Issue reported if percentage warning is over 50%
|
|
67709
|
+
|
|
67709
67710
|
Issue reported if the referenced domain is not found(taking error namespace into account)`,
|
|
67710
67711
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
67711
67712
|
};
|
|
@@ -67982,58 +67983,58 @@ class ObsoleteStatement extends _abap_rule_1.ABAPRule {
|
|
|
67982
67983
|
title: "Obsolete statements",
|
|
67983
67984
|
shortDescription: `Checks for usages of certain obsolete statements`,
|
|
67984
67985
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix],
|
|
67985
|
-
extendedInformation: `
|
|
67986
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-functional-to-procedural-language-constructs
|
|
67987
|
-
|
|
67988
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-obsolete-language-elements
|
|
67989
|
-
|
|
67990
|
-
SET EXTENDED CHECK: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapset_extended_check.htm
|
|
67991
|
-
|
|
67992
|
-
IS REQUESTED: https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abenlogexp_requested.htm
|
|
67993
|
-
|
|
67994
|
-
WITH HEADER LINE: https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abapdata_header_line.htm
|
|
67995
|
-
|
|
67996
|
-
FIELD-SYMBOLS STRUCTURE: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapfield-symbols_obsolete_typing.htm
|
|
67997
|
-
|
|
67998
|
-
TYPE-POOLS: from 702, https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abennews-71-program_load.htm
|
|
67999
|
-
|
|
68000
|
-
LOAD addition: from 702, https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abennews-71-program_load.htm
|
|
68001
|
-
|
|
68002
|
-
COMMUICATION: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapcommunication.htm
|
|
68003
|
-
|
|
68004
|
-
OCCURS: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapdata_occurs.htm
|
|
68005
|
-
|
|
68006
|
-
PARAMETER: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abapparameter.htm
|
|
68007
|
-
|
|
68008
|
-
RANGES: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapranges.htm
|
|
68009
|
-
|
|
68010
|
-
PACK: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abappack.htm
|
|
68011
|
-
|
|
68012
|
-
MOVE: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapmove_obs.htm
|
|
68013
|
-
|
|
68014
|
-
SELECT without INTO: https://help.sap.com/doc/abapdocu_731_index_htm/7.31/en-US/abapselect_obsolete.htm
|
|
68015
|
-
SELECT COUNT(*) is considered okay
|
|
68016
|
-
|
|
68017
|
-
FREE MEMORY: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abapfree_mem_id_obsolete.htm
|
|
68018
|
-
|
|
68019
|
-
SORT BY FS: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapsort_itab_obsolete.htm
|
|
68020
|
-
|
|
68021
|
-
CALL TRANSFORMATION OBJECTS: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapcall_transformation_objects.htm
|
|
68022
|
-
|
|
68023
|
-
POSIX REGEX: https://help.sap.com/doc/abapdocu_755_index_htm/7.55/en-US/index.htm
|
|
68024
|
-
|
|
68025
|
-
OCCURENCES: check for OCCURENCES vs OCCURRENCES
|
|
68026
|
-
|
|
67986
|
+
extendedInformation: `
|
|
67987
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-functional-to-procedural-language-constructs
|
|
67988
|
+
|
|
67989
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-obsolete-language-elements
|
|
67990
|
+
|
|
67991
|
+
SET EXTENDED CHECK: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapset_extended_check.htm
|
|
67992
|
+
|
|
67993
|
+
IS REQUESTED: https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abenlogexp_requested.htm
|
|
67994
|
+
|
|
67995
|
+
WITH HEADER LINE: https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abapdata_header_line.htm
|
|
67996
|
+
|
|
67997
|
+
FIELD-SYMBOLS STRUCTURE: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapfield-symbols_obsolete_typing.htm
|
|
67998
|
+
|
|
67999
|
+
TYPE-POOLS: from 702, https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abennews-71-program_load.htm
|
|
68000
|
+
|
|
68001
|
+
LOAD addition: from 702, https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abennews-71-program_load.htm
|
|
68002
|
+
|
|
68003
|
+
COMMUICATION: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapcommunication.htm
|
|
68004
|
+
|
|
68005
|
+
OCCURS: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapdata_occurs.htm
|
|
68006
|
+
|
|
68007
|
+
PARAMETER: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abapparameter.htm
|
|
68008
|
+
|
|
68009
|
+
RANGES: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapranges.htm
|
|
68010
|
+
|
|
68011
|
+
PACK: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abappack.htm
|
|
68012
|
+
|
|
68013
|
+
MOVE: https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapmove_obs.htm
|
|
68014
|
+
|
|
68015
|
+
SELECT without INTO: https://help.sap.com/doc/abapdocu_731_index_htm/7.31/en-US/abapselect_obsolete.htm
|
|
68016
|
+
SELECT COUNT(*) is considered okay
|
|
68017
|
+
|
|
68018
|
+
FREE MEMORY: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abapfree_mem_id_obsolete.htm
|
|
68019
|
+
|
|
68020
|
+
SORT BY FS: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapsort_itab_obsolete.htm
|
|
68021
|
+
|
|
68022
|
+
CALL TRANSFORMATION OBJECTS: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abapcall_transformation_objects.htm
|
|
68023
|
+
|
|
68024
|
+
POSIX REGEX: https://help.sap.com/doc/abapdocu_755_index_htm/7.55/en-US/index.htm
|
|
68025
|
+
|
|
68026
|
+
OCCURENCES: check for OCCURENCES vs OCCURRENCES
|
|
68027
|
+
|
|
68027
68028
|
CLIENT SPECIFIED, from 754: https://help.sap.com/doc/abapdocu_latest_index_htm/latest/en-US/index.htm?file=abapselect_client_obsolete.htm`,
|
|
68028
|
-
badExample: `REFRESH itab.
|
|
68029
|
-
|
|
68030
|
-
COMPUTE foo = 2 + 2.
|
|
68031
|
-
|
|
68032
|
-
MULTIPLY lv_foo BY 2.
|
|
68033
|
-
|
|
68034
|
-
INTERFACE intf LOAD.
|
|
68035
|
-
|
|
68036
|
-
IF foo IS SUPPLIED.
|
|
68029
|
+
badExample: `REFRESH itab.
|
|
68030
|
+
|
|
68031
|
+
COMPUTE foo = 2 + 2.
|
|
68032
|
+
|
|
68033
|
+
MULTIPLY lv_foo BY 2.
|
|
68034
|
+
|
|
68035
|
+
INTERFACE intf LOAD.
|
|
68036
|
+
|
|
68037
|
+
IF foo IS SUPPLIED.
|
|
68037
68038
|
ENDIF.`,
|
|
68038
68039
|
};
|
|
68039
68040
|
}
|
|
@@ -68373,9 +68374,9 @@ class OmitParameterName {
|
|
|
68373
68374
|
key: "omit_parameter_name",
|
|
68374
68375
|
title: "Omit parameter name",
|
|
68375
68376
|
shortDescription: `Omit the parameter name in single parameter calls`,
|
|
68376
|
-
extendedInformation: `
|
|
68377
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#omit-the-parameter-name-in-single-parameter-calls
|
|
68378
|
-
|
|
68377
|
+
extendedInformation: `
|
|
68378
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#omit-the-parameter-name-in-single-parameter-calls
|
|
68379
|
+
|
|
68379
68380
|
EXPORTING must already be omitted for this rule to take effect, https://rules.abaplint.org/exporting/`,
|
|
68380
68381
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix],
|
|
68381
68382
|
badExample: `method( param = 2 ).`,
|
|
@@ -68581,20 +68582,20 @@ class OmitReceiving extends _abap_rule_1.ABAPRule {
|
|
|
68581
68582
|
shortDescription: `Omit RECEIVING`,
|
|
68582
68583
|
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#omit-receiving`,
|
|
68583
68584
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
68584
|
-
badExample: `
|
|
68585
|
-
upload_pack(
|
|
68586
|
-
EXPORTING
|
|
68587
|
-
io_client = lo_client
|
|
68588
|
-
iv_url = iv_url
|
|
68589
|
-
iv_deepen_level = iv_deepen_level
|
|
68590
|
-
it_hashes = lt_hashes
|
|
68591
|
-
RECEIVING
|
|
68585
|
+
badExample: `
|
|
68586
|
+
upload_pack(
|
|
68587
|
+
EXPORTING
|
|
68588
|
+
io_client = lo_client
|
|
68589
|
+
iv_url = iv_url
|
|
68590
|
+
iv_deepen_level = iv_deepen_level
|
|
68591
|
+
it_hashes = lt_hashes
|
|
68592
|
+
RECEIVING
|
|
68592
68593
|
rt_objects = et_objects ).`,
|
|
68593
|
-
goodExample: `
|
|
68594
|
-
et_objects = upload_pack(
|
|
68595
|
-
io_client = lo_client
|
|
68596
|
-
iv_url = iv_url
|
|
68597
|
-
iv_deepen_level = iv_deepen_level
|
|
68594
|
+
goodExample: `
|
|
68595
|
+
et_objects = upload_pack(
|
|
68596
|
+
io_client = lo_client
|
|
68597
|
+
iv_url = iv_url
|
|
68598
|
+
iv_deepen_level = iv_deepen_level
|
|
68598
68599
|
it_hashes = lt_hashes ).`,
|
|
68599
68600
|
};
|
|
68600
68601
|
}
|
|
@@ -68658,8 +68659,8 @@ class Parser702Chaining extends _abap_rule_1.ABAPRule {
|
|
|
68658
68659
|
return {
|
|
68659
68660
|
key: "parser_702_chaining",
|
|
68660
68661
|
title: "Parser Error, bad chanining on 702",
|
|
68661
|
-
shortDescription: `ABAP on 702 does not allow for method chaining with IMPORTING/EXPORTING/CHANGING keywords,
|
|
68662
|
-
this rule finds these and reports errors.
|
|
68662
|
+
shortDescription: `ABAP on 702 does not allow for method chaining with IMPORTING/EXPORTING/CHANGING keywords,
|
|
68663
|
+
this rule finds these and reports errors.
|
|
68663
68664
|
Only active on target version 702 and below.`,
|
|
68664
68665
|
tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.SingleFile],
|
|
68665
68666
|
};
|
|
@@ -68739,8 +68740,8 @@ class ParserError {
|
|
|
68739
68740
|
return {
|
|
68740
68741
|
key: "parser_error",
|
|
68741
68742
|
title: "Parser error",
|
|
68742
|
-
shortDescription: `Checks for syntax not recognized by abaplint.
|
|
68743
|
-
|
|
68743
|
+
shortDescription: `Checks for syntax not recognized by abaplint.
|
|
68744
|
+
|
|
68744
68745
|
See recognized syntax at https://syntax.abaplint.org`,
|
|
68745
68746
|
tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.SingleFile],
|
|
68746
68747
|
};
|
|
@@ -68825,7 +68826,7 @@ class ParserMissingSpace extends _abap_rule_1.ABAPRule {
|
|
|
68825
68826
|
return {
|
|
68826
68827
|
key: "parser_missing_space",
|
|
68827
68828
|
title: "Parser Error, missing space",
|
|
68828
|
-
shortDescription: `In special cases the ABAP language allows for not having spaces before or after string literals.
|
|
68829
|
+
shortDescription: `In special cases the ABAP language allows for not having spaces before or after string literals.
|
|
68829
68830
|
This rule makes sure the spaces are consistently required across the language.`,
|
|
68830
68831
|
tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.SingleFile],
|
|
68831
68832
|
badExample: `IF ( foo = 'bar').`,
|
|
@@ -69237,25 +69238,25 @@ class PreferInline {
|
|
|
69237
69238
|
key: "prefer_inline",
|
|
69238
69239
|
title: "Prefer Inline Declarations",
|
|
69239
69240
|
shortDescription: `Prefer inline to up-front declarations.`,
|
|
69240
|
-
extendedInformation: `EXPERIMENTAL
|
|
69241
|
-
|
|
69242
|
-
Activates if language version is v740sp02 or above.
|
|
69243
|
-
|
|
69244
|
-
Variables must be local(METHOD or FORM).
|
|
69245
|
-
|
|
69246
|
-
No generic or void typed variables. No syntax errors.
|
|
69247
|
-
|
|
69248
|
-
First position used must be a full/pure write.
|
|
69249
|
-
|
|
69250
|
-
Move statment is not a cast(?=)
|
|
69251
|
-
|
|
69241
|
+
extendedInformation: `EXPERIMENTAL
|
|
69242
|
+
|
|
69243
|
+
Activates if language version is v740sp02 or above.
|
|
69244
|
+
|
|
69245
|
+
Variables must be local(METHOD or FORM).
|
|
69246
|
+
|
|
69247
|
+
No generic or void typed variables. No syntax errors.
|
|
69248
|
+
|
|
69249
|
+
First position used must be a full/pure write.
|
|
69250
|
+
|
|
69251
|
+
Move statment is not a cast(?=)
|
|
69252
|
+
|
|
69252
69253
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-inline-to-up-front-declarations`,
|
|
69253
69254
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Upport, _irule_1.RuleTag.Experimental, _irule_1.RuleTag.Quickfix],
|
|
69254
|
-
badExample: `DATA foo TYPE i.
|
|
69255
|
-
foo = 2.
|
|
69256
|
-
DATA percentage TYPE decfloat34.
|
|
69255
|
+
badExample: `DATA foo TYPE i.
|
|
69256
|
+
foo = 2.
|
|
69257
|
+
DATA percentage TYPE decfloat34.
|
|
69257
69258
|
percentage = ( comment_number / abs_statement_number ) * 100.`,
|
|
69258
|
-
goodExample: `DATA(foo) = 2.
|
|
69259
|
+
goodExample: `DATA(foo) = 2.
|
|
69259
69260
|
DATA(percentage) = CONV decfloat34( comment_number / abs_statement_number ) * 100.`,
|
|
69260
69261
|
};
|
|
69261
69262
|
}
|
|
@@ -69469,18 +69470,18 @@ class PreferIsNot extends _abap_rule_1.ABAPRule {
|
|
|
69469
69470
|
key: "prefer_is_not",
|
|
69470
69471
|
title: "Prefer IS NOT to NOT IS",
|
|
69471
69472
|
shortDescription: `Prefer IS NOT to NOT IS`,
|
|
69472
|
-
extendedInformation: `
|
|
69473
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-is-not-to-not-is
|
|
69474
|
-
|
|
69473
|
+
extendedInformation: `
|
|
69474
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-is-not-to-not-is
|
|
69475
|
+
|
|
69475
69476
|
"if not is_valid( )." examples are skipped`,
|
|
69476
69477
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
69477
|
-
goodExample: `IF variable IS NOT INITIAL.
|
|
69478
|
-
IF variable NP 'TODO*'.
|
|
69479
|
-
IF variable <> 42.
|
|
69478
|
+
goodExample: `IF variable IS NOT INITIAL.
|
|
69479
|
+
IF variable NP 'TODO*'.
|
|
69480
|
+
IF variable <> 42.
|
|
69480
69481
|
IF variable CO 'hello'.`,
|
|
69481
|
-
badExample: `IF NOT variable IS INITIAL.
|
|
69482
|
-
IF NOT variable CP 'TODO*'.
|
|
69483
|
-
IF NOT variable = 42.
|
|
69482
|
+
badExample: `IF NOT variable IS INITIAL.
|
|
69483
|
+
IF NOT variable CP 'TODO*'.
|
|
69484
|
+
IF NOT variable = 42.
|
|
69484
69485
|
IF NOT variable CA 'hello'.`,
|
|
69485
69486
|
};
|
|
69486
69487
|
}
|
|
@@ -69668,14 +69669,14 @@ class PreferRaiseExceptionNew extends _abap_rule_1.ABAPRule {
|
|
|
69668
69669
|
key: "prefer_raise_exception_new",
|
|
69669
69670
|
title: "Prefer RAISE EXCEPTION NEW to RAISE EXCEPTION TYPE",
|
|
69670
69671
|
shortDescription: `Prefer RAISE EXCEPTION NEW to RAISE EXCEPTION TYPE`,
|
|
69671
|
-
extendedInformation: `
|
|
69672
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-raise-exception-new-to-raise-exception-type
|
|
69673
|
-
|
|
69672
|
+
extendedInformation: `
|
|
69673
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-raise-exception-new-to-raise-exception-type
|
|
69674
|
+
|
|
69674
69675
|
From 752 and up`,
|
|
69675
69676
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Upport],
|
|
69676
69677
|
goodExample: `RAISE EXCEPTION NEW cx_generation_error( previous = exception ).`,
|
|
69677
|
-
badExample: `RAISE EXCEPTION TYPE cx_generation_error
|
|
69678
|
-
EXPORTING
|
|
69678
|
+
badExample: `RAISE EXCEPTION TYPE cx_generation_error
|
|
69679
|
+
EXPORTING
|
|
69679
69680
|
previous = exception.`,
|
|
69680
69681
|
};
|
|
69681
69682
|
}
|
|
@@ -69753,12 +69754,12 @@ class PreferReturningToExporting extends _abap_rule_1.ABAPRule {
|
|
|
69753
69754
|
key: "prefer_returning_to_exporting",
|
|
69754
69755
|
title: "Prefer RETURNING to EXPORTING",
|
|
69755
69756
|
shortDescription: `Prefer RETURNING to EXPORTING. Generic types cannot be RETURNING.`,
|
|
69756
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-returning-to-exporting
|
|
69757
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-returning-to-exporting
|
|
69757
69758
|
https://docs.abapopenchecks.org/checks/44/`,
|
|
69758
69759
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
69759
|
-
badExample: `CLASS lcl DEFINITION.
|
|
69760
|
-
PUBLIC SECTION.
|
|
69761
|
-
METHODS test EXPORTING ev_foo TYPE i.
|
|
69760
|
+
badExample: `CLASS lcl DEFINITION.
|
|
69761
|
+
PUBLIC SECTION.
|
|
69762
|
+
METHODS test EXPORTING ev_foo TYPE i.
|
|
69762
69763
|
ENDCLASS.`,
|
|
69763
69764
|
};
|
|
69764
69765
|
}
|
|
@@ -69854,8 +69855,8 @@ class PreferXsdbool extends _abap_rule_1.ABAPRule {
|
|
|
69854
69855
|
key: "prefer_xsdbool",
|
|
69855
69856
|
title: "Prefer xsdbool over boolc",
|
|
69856
69857
|
shortDescription: `Prefer xsdbool over boolc`,
|
|
69857
|
-
extendedInformation: `Activates if language version is v740sp08 or above.
|
|
69858
|
-
|
|
69858
|
+
extendedInformation: `Activates if language version is v740sp08 or above.
|
|
69859
|
+
|
|
69859
69860
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-xsdbool-to-set-boolean-variables`,
|
|
69860
69861
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Upport, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
69861
69862
|
badExample: `DATA(sdf) = boolc( 1 = 2 ).`,
|
|
@@ -69927,9 +69928,9 @@ class PreferredCompareOperator extends _abap_rule_1.ABAPRule {
|
|
|
69927
69928
|
title: "Preferred compare operator",
|
|
69928
69929
|
shortDescription: `Configure undesired operator variants`,
|
|
69929
69930
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
|
|
69930
|
-
badExample: `IF foo EQ bar.
|
|
69931
|
+
badExample: `IF foo EQ bar.
|
|
69931
69932
|
ENDIF.`,
|
|
69932
|
-
goodExample: `IF foo = bar.
|
|
69933
|
+
goodExample: `IF foo = bar.
|
|
69933
69934
|
ENDIF.`,
|
|
69934
69935
|
};
|
|
69935
69936
|
}
|
|
@@ -70153,26 +70154,26 @@ class ReduceProceduralCode extends _abap_rule_1.ABAPRule {
|
|
|
70153
70154
|
key: "reduce_procedural_code",
|
|
70154
70155
|
title: "Reduce procedural code",
|
|
70155
70156
|
shortDescription: `Checks FORM and FUNCTION-MODULE have few statements`,
|
|
70156
|
-
extendedInformation: `Delegate logic to a class method instead of using FORM or FUNCTION-MODULE.
|
|
70157
|
-
|
|
70158
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-object-orientation-to-procedural-programming
|
|
70159
|
-
|
|
70157
|
+
extendedInformation: `Delegate logic to a class method instead of using FORM or FUNCTION-MODULE.
|
|
70158
|
+
|
|
70159
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-object-orientation-to-procedural-programming
|
|
70160
|
+
|
|
70160
70161
|
Comments are not counted as statements.`,
|
|
70161
70162
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
|
|
70162
|
-
badExample: `FORM foo.
|
|
70163
|
-
DATA lv_bar TYPE i.
|
|
70164
|
-
lv_bar = 2 + 2.
|
|
70165
|
-
IF lv_bar = 4.
|
|
70166
|
-
WRITE 'hello world'.
|
|
70167
|
-
ENDIF.
|
|
70168
|
-
DATA lv_bar TYPE i.
|
|
70169
|
-
lv_bar = 2 + 2.
|
|
70170
|
-
IF lv_bar = 4.
|
|
70171
|
-
WRITE 'hello world'.
|
|
70172
|
-
ENDIF.
|
|
70163
|
+
badExample: `FORM foo.
|
|
70164
|
+
DATA lv_bar TYPE i.
|
|
70165
|
+
lv_bar = 2 + 2.
|
|
70166
|
+
IF lv_bar = 4.
|
|
70167
|
+
WRITE 'hello world'.
|
|
70168
|
+
ENDIF.
|
|
70169
|
+
DATA lv_bar TYPE i.
|
|
70170
|
+
lv_bar = 2 + 2.
|
|
70171
|
+
IF lv_bar = 4.
|
|
70172
|
+
WRITE 'hello world'.
|
|
70173
|
+
ENDIF.
|
|
70173
70174
|
ENDFORM.`,
|
|
70174
|
-
goodExample: `FORM foo.
|
|
70175
|
-
NEW zcl_global_class( )->run_logic( ).
|
|
70175
|
+
goodExample: `FORM foo.
|
|
70176
|
+
NEW zcl_global_class( )->run_logic( ).
|
|
70176
70177
|
ENDFORM.`,
|
|
70177
70178
|
};
|
|
70178
70179
|
}
|
|
@@ -70416,10 +70417,10 @@ class RemoveDescriptions {
|
|
|
70416
70417
|
return {
|
|
70417
70418
|
key: "remove_descriptions",
|
|
70418
70419
|
title: "Remove descriptions",
|
|
70419
|
-
shortDescription: `Ensures you have no descriptions in metadata of methods, parameters, etc.
|
|
70420
|
-
|
|
70421
|
-
Class descriptions are required, see rule description_empty.
|
|
70422
|
-
|
|
70420
|
+
shortDescription: `Ensures you have no descriptions in metadata of methods, parameters, etc.
|
|
70421
|
+
|
|
70422
|
+
Class descriptions are required, see rule description_empty.
|
|
70423
|
+
|
|
70423
70424
|
Consider using ABAP Doc for documentation.`,
|
|
70424
70425
|
tags: [],
|
|
70425
70426
|
};
|
|
@@ -70544,14 +70545,14 @@ class RFCErrorHandling extends _abap_rule_1.ABAPRule {
|
|
|
70544
70545
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
70545
70546
|
shortDescription: `Checks that exceptions 'system_failure' and 'communication_failure' are handled in RFC calls`,
|
|
70546
70547
|
extendedInformation: `https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abenrfc_exception.htm`,
|
|
70547
|
-
badExample: `CALL FUNCTION 'ZRFC'
|
|
70548
|
+
badExample: `CALL FUNCTION 'ZRFC'
|
|
70548
70549
|
DESTINATION lv_rfc.`,
|
|
70549
|
-
goodExample: `CALL FUNCTION 'ZRFC'
|
|
70550
|
-
DESTINATION lv_rfc
|
|
70551
|
-
EXCEPTIONS
|
|
70552
|
-
system_failure = 1 MESSAGE msg
|
|
70553
|
-
communication_failure = 2 MESSAGE msg
|
|
70554
|
-
resource_failure = 3
|
|
70550
|
+
goodExample: `CALL FUNCTION 'ZRFC'
|
|
70551
|
+
DESTINATION lv_rfc
|
|
70552
|
+
EXCEPTIONS
|
|
70553
|
+
system_failure = 1 MESSAGE msg
|
|
70554
|
+
communication_failure = 2 MESSAGE msg
|
|
70555
|
+
resource_failure = 3
|
|
70555
70556
|
OTHERS = 4.`,
|
|
70556
70557
|
};
|
|
70557
70558
|
}
|
|
@@ -70635,11 +70636,11 @@ class SelectAddOrderBy {
|
|
|
70635
70636
|
key: "select_add_order_by",
|
|
70636
70637
|
title: "SELECT add ORDER BY",
|
|
70637
70638
|
shortDescription: `SELECTs add ORDER BY clause`,
|
|
70638
|
-
extendedInformation: `
|
|
70639
|
-
This will make sure that the SELECT statement returns results in the same sequence on different databases
|
|
70640
|
-
|
|
70641
|
-
add ORDER BY PRIMARY KEY if in doubt
|
|
70642
|
-
|
|
70639
|
+
extendedInformation: `
|
|
70640
|
+
This will make sure that the SELECT statement returns results in the same sequence on different databases
|
|
70641
|
+
|
|
70642
|
+
add ORDER BY PRIMARY KEY if in doubt
|
|
70643
|
+
|
|
70643
70644
|
If the target is a sorted/hashed table, no issue is reported`,
|
|
70644
70645
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
70645
70646
|
badExample: `SELECT * FROM db INTO TABLE @DATA(tab).`,
|
|
@@ -70770,14 +70771,14 @@ class SelectPerformance {
|
|
|
70770
70771
|
key: "select_performance",
|
|
70771
70772
|
title: "SELECT performance",
|
|
70772
70773
|
shortDescription: `Various checks regarding SELECT performance.`,
|
|
70773
|
-
extendedInformation: `ENDSELECT: not reported when the corresponding SELECT has PACKAGE SIZE
|
|
70774
|
-
|
|
70774
|
+
extendedInformation: `ENDSELECT: not reported when the corresponding SELECT has PACKAGE SIZE
|
|
70775
|
+
|
|
70775
70776
|
SELECT *: not reported if using INTO/APPENDING CORRESPONDING FIELDS OF`,
|
|
70776
70777
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Performance],
|
|
70777
|
-
badExample: `SELECT field1, field2 FROM table
|
|
70778
|
-
INTO @DATA(structure) UP TO 1 ROWS ORDER BY field3 DESCENDING.
|
|
70778
|
+
badExample: `SELECT field1, field2 FROM table
|
|
70779
|
+
INTO @DATA(structure) UP TO 1 ROWS ORDER BY field3 DESCENDING.
|
|
70779
70780
|
ENDSELECT.`,
|
|
70780
|
-
goodExample: `SELECT field1, field2 FROM table UP TO 1 ROWS
|
|
70781
|
+
goodExample: `SELECT field1, field2 FROM table UP TO 1 ROWS
|
|
70781
70782
|
INTO TABLE @DATA(table) ORDER BY field3 DESCENDING`,
|
|
70782
70783
|
};
|
|
70783
70784
|
}
|
|
@@ -70891,8 +70892,8 @@ class SelectSingleFullKey {
|
|
|
70891
70892
|
key: "select_single_full_key",
|
|
70892
70893
|
title: "Detect SELECT SINGLE which are possibily not unique",
|
|
70893
70894
|
shortDescription: `Detect SELECT SINGLE which are possibily not unique`,
|
|
70894
|
-
extendedInformation: `Table definitions must be known, ie. inside the errorNamespace
|
|
70895
|
-
|
|
70895
|
+
extendedInformation: `Table definitions must be known, ie. inside the errorNamespace
|
|
70896
|
+
|
|
70896
70897
|
If the statement contains a JOIN it is not checked`,
|
|
70897
70898
|
pseudoComment: "EC CI_NOORDER",
|
|
70898
70899
|
tags: [_irule_1.RuleTag.Quickfix],
|
|
@@ -71316,8 +71317,8 @@ class SICFConsistency {
|
|
|
71316
71317
|
key: "sicf_consistency",
|
|
71317
71318
|
title: "SICF consistency",
|
|
71318
71319
|
shortDescription: `Checks the validity of ICF services`,
|
|
71319
|
-
extendedInformation: `* Class defined in handler must exist
|
|
71320
|
-
* Class must not have any syntax errors
|
|
71320
|
+
extendedInformation: `* Class defined in handler must exist
|
|
71321
|
+
* Class must not have any syntax errors
|
|
71321
71322
|
* Class must implement interface IF_HTTP_EXTENSION`,
|
|
71322
71323
|
};
|
|
71323
71324
|
}
|
|
@@ -71429,23 +71430,23 @@ class SlowParameterPassing {
|
|
|
71429
71430
|
shortDescription: `Detects slow pass by value passing for methods where parameter is not changed`,
|
|
71430
71431
|
extendedInformation: `Method parameters defined in interfaces is not checked`,
|
|
71431
71432
|
tags: [_irule_1.RuleTag.Performance],
|
|
71432
|
-
badExample: `CLASS lcl DEFINITION.
|
|
71433
|
-
PUBLIC SECTION.
|
|
71434
|
-
METHODS bar IMPORTING VALUE(sdf) TYPE string.
|
|
71435
|
-
ENDCLASS.
|
|
71436
|
-
CLASS lcl IMPLEMENTATION.
|
|
71437
|
-
METHOD bar.
|
|
71438
|
-
WRITE sdf.
|
|
71439
|
-
ENDMETHOD.
|
|
71433
|
+
badExample: `CLASS lcl DEFINITION.
|
|
71434
|
+
PUBLIC SECTION.
|
|
71435
|
+
METHODS bar IMPORTING VALUE(sdf) TYPE string.
|
|
71436
|
+
ENDCLASS.
|
|
71437
|
+
CLASS lcl IMPLEMENTATION.
|
|
71438
|
+
METHOD bar.
|
|
71439
|
+
WRITE sdf.
|
|
71440
|
+
ENDMETHOD.
|
|
71440
71441
|
ENDCLASS.`,
|
|
71441
|
-
goodExample: `CLASS lcl DEFINITION.
|
|
71442
|
-
PUBLIC SECTION.
|
|
71443
|
-
METHODS bar IMPORTING sdf TYPE string.
|
|
71444
|
-
ENDCLASS.
|
|
71445
|
-
CLASS lcl IMPLEMENTATION.
|
|
71446
|
-
METHOD bar.
|
|
71447
|
-
WRITE sdf.
|
|
71448
|
-
ENDMETHOD.
|
|
71442
|
+
goodExample: `CLASS lcl DEFINITION.
|
|
71443
|
+
PUBLIC SECTION.
|
|
71444
|
+
METHODS bar IMPORTING sdf TYPE string.
|
|
71445
|
+
ENDCLASS.
|
|
71446
|
+
CLASS lcl IMPLEMENTATION.
|
|
71447
|
+
METHOD bar.
|
|
71448
|
+
WRITE sdf.
|
|
71449
|
+
ENDMETHOD.
|
|
71449
71450
|
ENDCLASS.`,
|
|
71450
71451
|
};
|
|
71451
71452
|
}
|
|
@@ -71702,8 +71703,8 @@ class SpaceBeforeDot extends _abap_rule_1.ABAPRule {
|
|
|
71702
71703
|
key: "space_before_dot",
|
|
71703
71704
|
title: "Space before dot",
|
|
71704
71705
|
shortDescription: `Checks for extra spaces before dots at the ends of statements`,
|
|
71705
|
-
extendedInformation: `
|
|
71706
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#be-consistent
|
|
71706
|
+
extendedInformation: `
|
|
71707
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#be-consistent
|
|
71707
71708
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#condense-your-code`,
|
|
71708
71709
|
tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
71709
71710
|
badExample: `WRITE bar .`,
|
|
@@ -71889,12 +71890,12 @@ class SQLValueConversion {
|
|
|
71889
71890
|
key: "sql_value_conversion",
|
|
71890
71891
|
title: "Implicit SQL Value Conversion",
|
|
71891
71892
|
shortDescription: `Ensure types match when selecting from database`,
|
|
71892
|
-
extendedInformation: `
|
|
71893
|
-
* Integer to CHAR conversion
|
|
71894
|
-
* Integer to NUMC conversion
|
|
71895
|
-
* NUMC to Integer conversion
|
|
71896
|
-
* CHAR to Integer conversion
|
|
71897
|
-
* Source field longer than database field, CHAR -> CHAR
|
|
71893
|
+
extendedInformation: `
|
|
71894
|
+
* Integer to CHAR conversion
|
|
71895
|
+
* Integer to NUMC conversion
|
|
71896
|
+
* NUMC to Integer conversion
|
|
71897
|
+
* CHAR to Integer conversion
|
|
71898
|
+
* Source field longer than database field, CHAR -> CHAR
|
|
71898
71899
|
* Source field longer than database field, NUMC -> NUMC`,
|
|
71899
71900
|
tags: [],
|
|
71900
71901
|
};
|
|
@@ -71966,7 +71967,7 @@ class StartAtTab extends _abap_rule_1.ABAPRule {
|
|
|
71966
71967
|
key: "start_at_tab",
|
|
71967
71968
|
title: "Start at tab",
|
|
71968
71969
|
shortDescription: `Checks that statements start at tabstops.`,
|
|
71969
|
-
extendedInformation: `Reports max 100 issues per file
|
|
71970
|
+
extendedInformation: `Reports max 100 issues per file
|
|
71970
71971
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#indent-and-snap-to-tab`,
|
|
71971
71972
|
tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
71972
71973
|
badExample: ` WRITE a.`,
|
|
@@ -72143,12 +72144,12 @@ class StrictSQL extends _abap_rule_1.ABAPRule {
|
|
|
72143
72144
|
key: "strict_sql",
|
|
72144
72145
|
title: "Strict SQL",
|
|
72145
72146
|
shortDescription: `Strict SQL`,
|
|
72146
|
-
extendedInformation: `https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abapinto_clause.htm
|
|
72147
|
-
|
|
72148
|
-
https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abenopensql_strict_mode_750.htm
|
|
72149
|
-
|
|
72150
|
-
Also see separate rule sql_escape_host_variables
|
|
72151
|
-
|
|
72147
|
+
extendedInformation: `https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abapinto_clause.htm
|
|
72148
|
+
|
|
72149
|
+
https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abenopensql_strict_mode_750.htm
|
|
72150
|
+
|
|
72151
|
+
Also see separate rule sql_escape_host_variables
|
|
72152
|
+
|
|
72152
72153
|
Activates from v750 and up`,
|
|
72153
72154
|
tags: [_irule_1.RuleTag.Upport, _irule_1.RuleTag.Quickfix],
|
|
72154
72155
|
badExample: `SELECT * FROM ztabl INTO TABLE @rt_content WHERE type = @iv_type ORDER BY PRIMARY KEY.`,
|
|
@@ -72402,11 +72403,11 @@ class SyModification extends _abap_rule_1.ABAPRule {
|
|
|
72402
72403
|
key: "sy_modification",
|
|
72403
72404
|
title: "Modification of SY fields",
|
|
72404
72405
|
shortDescription: `Finds modification of sy fields`,
|
|
72405
|
-
extendedInformation: `https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abensystem_fields.htm
|
|
72406
|
-
|
|
72406
|
+
extendedInformation: `https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abensystem_fields.htm
|
|
72407
|
+
|
|
72407
72408
|
Changes to SY-TVAR* fields are not reported`,
|
|
72408
72409
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
72409
|
-
badExample: `sy-uname = 2.
|
|
72410
|
+
badExample: `sy-uname = 2.
|
|
72410
72411
|
sy = sy.`,
|
|
72411
72412
|
};
|
|
72412
72413
|
}
|
|
@@ -72468,8 +72469,8 @@ class TABLEnhancementCategory {
|
|
|
72468
72469
|
key: "tabl_enhancement_category",
|
|
72469
72470
|
title: "TABL enhancement category must be set",
|
|
72470
72471
|
shortDescription: `Checks that tables do not have the enhancement category 'not classified'.`,
|
|
72471
|
-
extendedInformation: `SAP note 3063227 changes the default to 'Cannot be enhanced'.
|
|
72472
|
-
|
|
72472
|
+
extendedInformation: `SAP note 3063227 changes the default to 'Cannot be enhanced'.
|
|
72473
|
+
|
|
72473
72474
|
You may use standard report RS_DDIC_CLASSIFICATION_FINAL for adjustment.`,
|
|
72474
72475
|
tags: [],
|
|
72475
72476
|
};
|
|
@@ -72534,8 +72535,8 @@ class TablesDeclaredLocally extends _abap_rule_1.ABAPRule {
|
|
|
72534
72535
|
shortDescription: `TABLES are always global, so declare them globally`,
|
|
72535
72536
|
extendedInformation: `https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abaptables.htm`,
|
|
72536
72537
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
72537
|
-
badExample: `FORM foo.
|
|
72538
|
-
TABLES t100.
|
|
72538
|
+
badExample: `FORM foo.
|
|
72539
|
+
TABLES t100.
|
|
72539
72540
|
ENDFORM.`,
|
|
72540
72541
|
goodExample: `TABLES t000.`,
|
|
72541
72542
|
};
|
|
@@ -72663,9 +72664,9 @@ class TypeFormParameters extends _abap_rule_1.ABAPRule {
|
|
|
72663
72664
|
title: "Type FORM parameters",
|
|
72664
72665
|
shortDescription: `Checks for untyped FORM parameters`,
|
|
72665
72666
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
72666
|
-
badExample: `FORM foo USING bar.
|
|
72667
|
+
badExample: `FORM foo USING bar.
|
|
72667
72668
|
ENDFORM.`,
|
|
72668
|
-
goodExample: `FORM foo USING bar TYPE string.
|
|
72669
|
+
goodExample: `FORM foo USING bar TYPE string.
|
|
72669
72670
|
ENDFORM.`,
|
|
72670
72671
|
};
|
|
72671
72672
|
}
|
|
@@ -73338,38 +73339,38 @@ class UnnecessaryPragma extends _abap_rule_1.ABAPRule {
|
|
|
73338
73339
|
key: "unnecessary_pragma",
|
|
73339
73340
|
title: "Unnecessary Pragma",
|
|
73340
73341
|
shortDescription: `Finds pragmas which can be removed`,
|
|
73341
|
-
extendedInformation: `* NO_HANDLER with handler
|
|
73342
|
-
|
|
73343
|
-
* NEEDED without definition
|
|
73344
|
-
|
|
73345
|
-
* NO_TEXT without texts
|
|
73346
|
-
|
|
73347
|
-
* SUBRC_OK where sy-subrc is checked
|
|
73348
|
-
|
|
73342
|
+
extendedInformation: `* NO_HANDLER with handler
|
|
73343
|
+
|
|
73344
|
+
* NEEDED without definition
|
|
73345
|
+
|
|
73346
|
+
* NO_TEXT without texts
|
|
73347
|
+
|
|
73348
|
+
* SUBRC_OK where sy-subrc is checked
|
|
73349
|
+
|
|
73349
73350
|
NO_HANDLER inside macros are not checked`,
|
|
73350
73351
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
73351
|
-
badExample: `TRY.
|
|
73352
|
-
...
|
|
73353
|
-
CATCH zcx_abapgit_exception ##NO_HANDLER.
|
|
73354
|
-
RETURN. " it has a handler
|
|
73355
|
-
ENDTRY.
|
|
73356
|
-
MESSAGE w125(zbar) WITH c_foo INTO message ##NEEDED ##NO_TEXT.
|
|
73357
|
-
SELECT SINGLE * FROM tadir INTO @DATA(sdfs) ##SUBRC_OK.
|
|
73358
|
-
IF sy-subrc <> 0.
|
|
73352
|
+
badExample: `TRY.
|
|
73353
|
+
...
|
|
73354
|
+
CATCH zcx_abapgit_exception ##NO_HANDLER.
|
|
73355
|
+
RETURN. " it has a handler
|
|
73356
|
+
ENDTRY.
|
|
73357
|
+
MESSAGE w125(zbar) WITH c_foo INTO message ##NEEDED ##NO_TEXT.
|
|
73358
|
+
SELECT SINGLE * FROM tadir INTO @DATA(sdfs) ##SUBRC_OK.
|
|
73359
|
+
IF sy-subrc <> 0.
|
|
73359
73360
|
ENDIF.`,
|
|
73360
|
-
goodExample: `TRY.
|
|
73361
|
-
...
|
|
73362
|
-
CATCH zcx_abapgit_exception.
|
|
73363
|
-
RETURN.
|
|
73364
|
-
ENDTRY.
|
|
73365
|
-
MESSAGE w125(zbar) WITH c_foo INTO message.
|
|
73366
|
-
SELECT SINGLE * FROM tadir INTO @DATA(sdfs).
|
|
73367
|
-
IF sy-subrc <> 0.
|
|
73368
|
-
ENDIF.
|
|
73369
|
-
|
|
73370
|
-
DATA: BEGIN OF blah ##NEEDED,
|
|
73371
|
-
test1 TYPE string,
|
|
73372
|
-
test2 TYPE string,
|
|
73361
|
+
goodExample: `TRY.
|
|
73362
|
+
...
|
|
73363
|
+
CATCH zcx_abapgit_exception.
|
|
73364
|
+
RETURN.
|
|
73365
|
+
ENDTRY.
|
|
73366
|
+
MESSAGE w125(zbar) WITH c_foo INTO message.
|
|
73367
|
+
SELECT SINGLE * FROM tadir INTO @DATA(sdfs).
|
|
73368
|
+
IF sy-subrc <> 0.
|
|
73369
|
+
ENDIF.
|
|
73370
|
+
|
|
73371
|
+
DATA: BEGIN OF blah ##NEEDED,
|
|
73372
|
+
test1 TYPE string,
|
|
73373
|
+
test2 TYPE string,
|
|
73373
73374
|
END OF blah.`,
|
|
73374
73375
|
};
|
|
73375
73376
|
}
|
|
@@ -73536,18 +73537,18 @@ class UnnecessaryReturn extends _abap_rule_1.ABAPRule {
|
|
|
73536
73537
|
shortDescription: `Finds unnecessary RETURN statements`,
|
|
73537
73538
|
extendedInformation: `Finds unnecessary RETURN statements`,
|
|
73538
73539
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
|
|
73539
|
-
badExample: `FORM hello1.
|
|
73540
|
-
WRITE 'world'.
|
|
73541
|
-
RETURN.
|
|
73542
|
-
ENDFORM.
|
|
73543
|
-
|
|
73544
|
-
FORM foo.
|
|
73545
|
-
IF 1 = 2.
|
|
73546
|
-
RETURN.
|
|
73547
|
-
ENDIF.
|
|
73540
|
+
badExample: `FORM hello1.
|
|
73541
|
+
WRITE 'world'.
|
|
73542
|
+
RETURN.
|
|
73543
|
+
ENDFORM.
|
|
73544
|
+
|
|
73545
|
+
FORM foo.
|
|
73546
|
+
IF 1 = 2.
|
|
73547
|
+
RETURN.
|
|
73548
|
+
ENDIF.
|
|
73548
73549
|
ENDFORM.`,
|
|
73549
|
-
goodExample: `FORM hello2.
|
|
73550
|
-
WRITE 'world'.
|
|
73550
|
+
goodExample: `FORM hello2.
|
|
73551
|
+
WRITE 'world'.
|
|
73551
73552
|
ENDFORM.`,
|
|
73552
73553
|
};
|
|
73553
73554
|
}
|
|
@@ -73898,13 +73899,13 @@ class UnusedMacros {
|
|
|
73898
73899
|
title: "Unused macros",
|
|
73899
73900
|
shortDescription: `Checks for unused macro definitions definitions`,
|
|
73900
73901
|
tags: [_irule_1.RuleTag.Quickfix],
|
|
73901
|
-
badExample: `DEFINE foobar1.
|
|
73902
|
-
WRITE 'hello'.
|
|
73902
|
+
badExample: `DEFINE foobar1.
|
|
73903
|
+
WRITE 'hello'.
|
|
73903
73904
|
END-OF-DEFINITION.`,
|
|
73904
|
-
goodExample: `DEFINE foobar2.
|
|
73905
|
-
WRITE 'hello'.
|
|
73906
|
-
END-OF-DEFINITION.
|
|
73907
|
-
|
|
73905
|
+
goodExample: `DEFINE foobar2.
|
|
73906
|
+
WRITE 'hello'.
|
|
73907
|
+
END-OF-DEFINITION.
|
|
73908
|
+
|
|
73908
73909
|
foobar2.`,
|
|
73909
73910
|
};
|
|
73910
73911
|
}
|
|
@@ -74016,18 +74017,18 @@ class UnusedMethods {
|
|
|
74016
74017
|
key: "unused_methods",
|
|
74017
74018
|
title: "Unused methods",
|
|
74018
74019
|
shortDescription: `Checks for unused methods`,
|
|
74019
|
-
extendedInformation: `Checks private and protected methods.
|
|
74020
|
-
|
|
74021
|
-
Unused methods are not reported if the object contains parser or syntax errors.
|
|
74022
|
-
Quick fixes only appears for private methods or projected methods where the class doesnt have any subclasses.
|
|
74023
|
-
|
|
74024
|
-
Skips:
|
|
74025
|
-
* methods FOR TESTING
|
|
74026
|
-
* methods SETUP + TEARDOWN + CLASS_SETUP + CLASS_TEARDOWN in testclasses
|
|
74027
|
-
* class_constructor + constructor methods
|
|
74028
|
-
* event handlers
|
|
74029
|
-
* methods that are redefined
|
|
74030
|
-
* INCLUDEs
|
|
74020
|
+
extendedInformation: `Checks private and protected methods.
|
|
74021
|
+
|
|
74022
|
+
Unused methods are not reported if the object contains parser or syntax errors.
|
|
74023
|
+
Quick fixes only appears for private methods or projected methods where the class doesnt have any subclasses.
|
|
74024
|
+
|
|
74025
|
+
Skips:
|
|
74026
|
+
* methods FOR TESTING
|
|
74027
|
+
* methods SETUP + TEARDOWN + CLASS_SETUP + CLASS_TEARDOWN in testclasses
|
|
74028
|
+
* class_constructor + constructor methods
|
|
74029
|
+
* event handlers
|
|
74030
|
+
* methods that are redefined
|
|
74031
|
+
* INCLUDEs
|
|
74031
74032
|
`,
|
|
74032
74033
|
tags: [_irule_1.RuleTag.Quickfix],
|
|
74033
74034
|
pragma: "##CALLED",
|
|
@@ -74503,23 +74504,23 @@ class UnusedVariables {
|
|
|
74503
74504
|
key: "unused_variables",
|
|
74504
74505
|
title: "Unused variables",
|
|
74505
74506
|
shortDescription: `Checks for unused variables and constants`,
|
|
74506
|
-
extendedInformation: `Skips event parameters.
|
|
74507
|
-
|
|
74508
|
-
Note that this currently does not work if the source code uses macros.
|
|
74509
|
-
|
|
74510
|
-
Unused variables are not reported if the object contains parser or syntax errors.
|
|
74511
|
-
|
|
74507
|
+
extendedInformation: `Skips event parameters.
|
|
74508
|
+
|
|
74509
|
+
Note that this currently does not work if the source code uses macros.
|
|
74510
|
+
|
|
74511
|
+
Unused variables are not reported if the object contains parser or syntax errors.
|
|
74512
|
+
|
|
74512
74513
|
Errors found in INCLUDES are reported for the main program.`,
|
|
74513
74514
|
tags: [_irule_1.RuleTag.Quickfix],
|
|
74514
74515
|
pragma: "##NEEDED",
|
|
74515
74516
|
pseudoComment: "EC NEEDED",
|
|
74516
|
-
badExample: `DATA: BEGIN OF blah1,
|
|
74517
|
-
test TYPE string,
|
|
74518
|
-
test2 TYPE string,
|
|
74517
|
+
badExample: `DATA: BEGIN OF blah1,
|
|
74518
|
+
test TYPE string,
|
|
74519
|
+
test2 TYPE string,
|
|
74519
74520
|
END OF blah1.`,
|
|
74520
|
-
goodExample: `DATA: BEGIN OF blah2 ##NEEDED,
|
|
74521
|
-
test TYPE string,
|
|
74522
|
-
test2 TYPE string,
|
|
74521
|
+
goodExample: `DATA: BEGIN OF blah2 ##NEEDED,
|
|
74522
|
+
test TYPE string,
|
|
74523
|
+
test2 TYPE string,
|
|
74523
74524
|
END OF blah2.`,
|
|
74524
74525
|
};
|
|
74525
74526
|
}
|
|
@@ -74738,15 +74739,15 @@ class UseBoolExpression extends _abap_rule_1.ABAPRule {
|
|
|
74738
74739
|
shortDescription: `Use boolean expression, xsdbool from 740sp08 and up, boolc from 702 and up`,
|
|
74739
74740
|
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-xsdbool-to-set-boolean-variables`,
|
|
74740
74741
|
tags: [_irule_1.RuleTag.Upport, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
74741
|
-
badExample: `IF line IS INITIAL.
|
|
74742
|
-
has_entries = abap_false.
|
|
74743
|
-
ELSE.
|
|
74744
|
-
has_entries = abap_true.
|
|
74745
|
-
ENDIF.
|
|
74746
|
-
|
|
74742
|
+
badExample: `IF line IS INITIAL.
|
|
74743
|
+
has_entries = abap_false.
|
|
74744
|
+
ELSE.
|
|
74745
|
+
has_entries = abap_true.
|
|
74746
|
+
ENDIF.
|
|
74747
|
+
|
|
74747
74748
|
DATA(fsdf) = COND #( WHEN foo <> bar THEN abap_true ELSE abap_false ).`,
|
|
74748
|
-
goodExample: `DATA(has_entries) = xsdbool( line IS NOT INITIAL ).
|
|
74749
|
-
|
|
74749
|
+
goodExample: `DATA(has_entries) = xsdbool( line IS NOT INITIAL ).
|
|
74750
|
+
|
|
74750
74751
|
DATA(fsdf) = xsdbool( foo <> bar ).`,
|
|
74751
74752
|
};
|
|
74752
74753
|
}
|
|
@@ -74864,15 +74865,15 @@ class UseClassBasedExceptions extends _abap_rule_1.ABAPRule {
|
|
|
74864
74865
|
shortDescription: `Use class based exceptions, checks interface and class definitions`,
|
|
74865
74866
|
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-class-based-exceptions`,
|
|
74866
74867
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
74867
|
-
badExample: `INTERFACE lif.
|
|
74868
|
-
METHODS load_data
|
|
74869
|
-
EXCEPTIONS
|
|
74870
|
-
invalid_parameter.
|
|
74868
|
+
badExample: `INTERFACE lif.
|
|
74869
|
+
METHODS load_data
|
|
74870
|
+
EXCEPTIONS
|
|
74871
|
+
invalid_parameter.
|
|
74871
74872
|
ENDINTERFACE.`,
|
|
74872
|
-
goodExample: `INTERFACE lif.
|
|
74873
|
-
METHODS load_data
|
|
74874
|
-
RAISING
|
|
74875
|
-
cx_something.
|
|
74873
|
+
goodExample: `INTERFACE lif.
|
|
74874
|
+
METHODS load_data
|
|
74875
|
+
RAISING
|
|
74876
|
+
cx_something.
|
|
74876
74877
|
ENDINTERFACE.`,
|
|
74877
74878
|
};
|
|
74878
74879
|
}
|
|
@@ -74932,15 +74933,15 @@ class UseLineExists extends _abap_rule_1.ABAPRule {
|
|
|
74932
74933
|
key: "use_line_exists",
|
|
74933
74934
|
title: "Use line_exists",
|
|
74934
74935
|
shortDescription: `Use line_exists, from 740sp02 and up`,
|
|
74935
|
-
extendedInformation: `
|
|
74936
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-line_exists-to-read-table-or-loop-at
|
|
74937
|
-
|
|
74936
|
+
extendedInformation: `
|
|
74937
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-line_exists-to-read-table-or-loop-at
|
|
74938
|
+
|
|
74938
74939
|
Not reported if the READ TABLE statement contains BINARY SEARCH.`,
|
|
74939
74940
|
tags: [_irule_1.RuleTag.Upport, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
74940
|
-
badExample: `READ TABLE my_table TRANSPORTING NO FIELDS WITH KEY key = 'A'.
|
|
74941
|
-
IF sy-subrc = 0.
|
|
74941
|
+
badExample: `READ TABLE my_table TRANSPORTING NO FIELDS WITH KEY key = 'A'.
|
|
74942
|
+
IF sy-subrc = 0.
|
|
74942
74943
|
ENDIF.`,
|
|
74943
|
-
goodExample: `IF line_exists( my_table[ key = 'A' ] ).
|
|
74944
|
+
goodExample: `IF line_exists( my_table[ key = 'A' ] ).
|
|
74944
74945
|
ENDIF.`,
|
|
74945
74946
|
};
|
|
74946
74947
|
}
|
|
@@ -75050,10 +75051,10 @@ class UseNew extends _abap_rule_1.ABAPRule {
|
|
|
75050
75051
|
key: "use_new",
|
|
75051
75052
|
title: "Use NEW",
|
|
75052
75053
|
shortDescription: `Checks for deprecated CREATE OBJECT statements.`,
|
|
75053
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-new-to-create-object
|
|
75054
|
-
|
|
75055
|
-
If the target variable is referenced in the CREATE OBJECT statement, no errors are issued
|
|
75056
|
-
|
|
75054
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-new-to-create-object
|
|
75055
|
+
|
|
75056
|
+
If the target variable is referenced in the CREATE OBJECT statement, no errors are issued
|
|
75057
|
+
|
|
75057
75058
|
Applicable from v740sp02 and up`,
|
|
75058
75059
|
badExample: `CREATE OBJECT ref.`,
|
|
75059
75060
|
goodExample: `ref = NEW #( ).`,
|
|
@@ -75151,13 +75152,13 @@ class WhenOthersLast extends _abap_rule_1.ABAPRule {
|
|
|
75151
75152
|
title: "WHEN OTHERS last",
|
|
75152
75153
|
shortDescription: `Checks that WHEN OTHERS is placed the last within a CASE statement.`,
|
|
75153
75154
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
75154
|
-
badExample: `CASE bar.
|
|
75155
|
-
WHEN OTHERS.
|
|
75156
|
-
WHEN 2.
|
|
75155
|
+
badExample: `CASE bar.
|
|
75156
|
+
WHEN OTHERS.
|
|
75157
|
+
WHEN 2.
|
|
75157
75158
|
ENDCASE.`,
|
|
75158
|
-
goodExample: `CASE bar.
|
|
75159
|
-
WHEN 2.
|
|
75160
|
-
WHEN OTHERS.
|
|
75159
|
+
goodExample: `CASE bar.
|
|
75160
|
+
WHEN 2.
|
|
75161
|
+
WHEN OTHERS.
|
|
75161
75162
|
ENDCASE.`,
|
|
75162
75163
|
};
|
|
75163
75164
|
}
|