@abaplint/core 2.90.5 → 2.90.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/build/abaplint.d.ts +2 -3
- package/build/src/abap/1_lexer/lexer.js +10 -7
- package/build/src/abap/2_statements/expressions/method_param_name.js +1 -1
- package/build/src/abap/flow/flow_graph.js +7 -7
- package/build/src/lsp/help.js +7 -7
- package/build/src/lsp/semantic.js +5 -5
- package/build/src/objects/table.js +22 -0
- package/build/src/registry.js +1 -1
- package/build/src/rules/7bit_ascii.js +2 -2
- package/build/src/rules/abapdoc.js +1 -1
- package/build/src/rules/align_parameters.js +33 -33
- package/build/src/rules/ambiguous_statement.js +5 -5
- package/build/src/rules/avoid_use.js +8 -8
- package/build/src/rules/begin_end_names.js +4 -4
- package/build/src/rules/begin_single_include.js +12 -12
- package/build/src/rules/call_transaction_authority_check.js +3 -3
- package/build/src/rules/chain_mainly_declarations.js +4 -4
- package/build/src/rules/check_abstract.js +2 -2
- package/build/src/rules/check_comments.js +4 -4
- package/build/src/rules/check_include.js +3 -3
- package/build/src/rules/check_subrc.js +8 -8
- package/build/src/rules/classic_exceptions_overlap.js +8 -8
- package/build/src/rules/commented_code.js +1 -1
- package/build/src/rules/constructor_visibility_public.js +4 -4
- package/build/src/rules/contains_tab.js +2 -2
- package/build/src/rules/dangerous_statement.js +6 -5
- package/build/src/rules/downport.js +65 -65
- package/build/src/rules/exit_or_check.js +3 -3
- package/build/src/rules/exporting.js +1 -1
- package/build/src/rules/forbidden_identifier.js +1 -1
- package/build/src/rules/forbidden_void_type.js +2 -2
- package/build/src/rules/functional_writing.js +17 -17
- package/build/src/rules/global_class.js +8 -8
- package/build/src/rules/identical_conditions.js +2 -2
- package/build/src/rules/identical_contents.js +14 -14
- package/build/src/rules/identical_descriptions.js +4 -4
- package/build/src/rules/if_in_if.js +7 -7
- package/build/src/rules/implement_methods.js +3 -3
- package/build/src/rules/in_statement_indentation.js +11 -11
- package/build/src/rules/intf_referencing_clas.js +3 -3
- package/build/src/rules/line_break_style.js +2 -2
- package/build/src/rules/line_length.js +1 -1
- package/build/src/rules/line_only_punc.js +1 -1
- package/build/src/rules/local_variable_names.js +2 -2
- package/build/src/rules/many_parentheses.js +10 -10
- package/build/src/rules/max_one_method_parameter_per_line.js +7 -7
- package/build/src/rules/max_one_statement.js +3 -3
- package/build/src/rules/method_overwrites_builtin.js +2 -2
- package/build/src/rules/nesting.js +1 -1
- package/build/src/rules/no_chained_assignment.js +1 -1
- package/build/src/rules/no_external_form_calls.js +2 -2
- package/build/src/rules/no_inline_in_optional_branches.js +11 -11
- package/build/src/rules/no_public_attributes.js +1 -1
- package/build/src/rules/no_yoda_conditions.js +4 -4
- package/build/src/rules/nrob_consistency.js +2 -2
- package/build/src/rules/obsolete_statement.js +40 -40
- package/build/src/rules/omit_parameter_name.js +3 -3
- package/build/src/rules/omit_receiving.js +13 -13
- package/build/src/rules/parser_702_chaining.js +2 -2
- package/build/src/rules/parser_error.js +2 -2
- package/build/src/rules/parser_missing_space.js +1 -1
- package/build/src/rules/prefer_inline.js +16 -16
- package/build/src/rules/prefer_is_not.js +7 -7
- package/build/src/rules/prefer_raise_exception_new.js +3 -3
- package/build/src/rules/prefer_returning_to_exporting.js +1 -1
- package/build/src/rules/prefer_xsdbool.js +2 -2
- package/build/src/rules/remove_descriptions.js +4 -4
- package/build/src/rules/rfc_error_handling.js +9 -9
- package/build/src/rules/select_add_order_by.js +5 -5
- package/build/src/rules/select_performance.js +2 -2
- package/build/src/rules/sicf_consistency.js +2 -2
- package/build/src/rules/slow_parameter_passing.js +1 -1
- package/build/src/rules/space_before_dot.js +2 -2
- package/build/src/rules/start_at_tab.js +1 -1
- package/build/src/rules/sy_modification.js +2 -2
- package/build/src/rules/tabl_enhancement_category.js +2 -2
- package/build/src/rules/unnecessary_pragma.js +14 -14
- package/build/src/rules/unused_methods.js +9 -9
- package/build/src/rules/unused_variables.js +6 -6
- package/build/src/rules/use_bool_expression.js +8 -8
- package/build/src/rules/use_line_exists.js +6 -6
- package/build/src/rules/use_new.js +4 -4
- package/build/src/rules/when_others_last.js +6 -6
- package/package.json +65 -66
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
# @abaplint/core
|
|
2
|
-
|
|
3
|
-
[abaplint](https://abaplint.org/) core library
|
|
4
|
-
|
|
5
|
-
Exposes functionality like the parser and rules, which can be used in other projects.
|
|
6
|
-
|
|
1
|
+
# @abaplint/core
|
|
2
|
+
|
|
3
|
+
[abaplint](https://abaplint.org/) core library
|
|
4
|
+
|
|
5
|
+
Exposes functionality like the parser and rules, which can be used in other projects.
|
|
6
|
+
|
|
7
7
|
For more information see https://github.com/abaplint/abaplint
|
package/build/abaplint.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import * as LServer from 'vscode-languageserver-types';
|
|
2
|
-
import * as SemanticProtocol from 'vscode-languageserver-protocol/lib/common/protocol.semanticTokens';
|
|
3
2
|
import { WorkspaceEdit } from 'vscode-languageserver-types';
|
|
4
3
|
|
|
5
4
|
export declare class ABAPFile extends AbstractFile {
|
|
@@ -3447,8 +3446,8 @@ export declare class LanguageServer {
|
|
|
3447
3446
|
documentHighlight(_params: ITextDocumentPositionParams): LServer.DocumentHighlight[];
|
|
3448
3447
|
implementation(params: ITextDocumentPositionParams): LServer.Location[];
|
|
3449
3448
|
references(params: ITextDocumentPositionParams): LServer.Location[];
|
|
3450
|
-
static semanticTokensLegend():
|
|
3451
|
-
semanticTokensRange(range: ITextDocumentRange):
|
|
3449
|
+
static semanticTokensLegend(): LServer.SemanticTokensLegend;
|
|
3450
|
+
semanticTokensRange(range: ITextDocumentRange): LServer.SemanticTokens;
|
|
3452
3451
|
help(textDocument: LServer.TextDocumentIdentifier, position: LServer.Position): string;
|
|
3453
3452
|
listDefinitionPositions(textDocument: LServer.TextDocumentIdentifier): LServer.Range[];
|
|
3454
3453
|
listReadPositions(textDocument: LServer.TextDocumentIdentifier): LServer.Range[];
|
|
@@ -69,6 +69,12 @@ class Stream {
|
|
|
69
69
|
nextNextChar() {
|
|
70
70
|
return this.raw.substr(this.offset + 1, 2);
|
|
71
71
|
}
|
|
72
|
+
getRaw() {
|
|
73
|
+
return this.raw;
|
|
74
|
+
}
|
|
75
|
+
getOffset() {
|
|
76
|
+
return this.offset;
|
|
77
|
+
}
|
|
72
78
|
}
|
|
73
79
|
class Lexer {
|
|
74
80
|
static run(file, virtual) {
|
|
@@ -84,10 +90,7 @@ class Lexer {
|
|
|
84
90
|
const col = this.stream.getCol();
|
|
85
91
|
const row = this.stream.getRow();
|
|
86
92
|
let whiteBefore = false;
|
|
87
|
-
|
|
88
|
-
if (s.length === 2) {
|
|
89
|
-
prev = this.stream.prevPrevChar().substr(0, 1);
|
|
90
|
-
}
|
|
93
|
+
const prev = this.stream.getRaw().substr(this.stream.getOffset() - s.length, 1);
|
|
91
94
|
if (prev === " " || prev === "\n" || prev === "\t" || prev === ":") {
|
|
92
95
|
whiteBefore = true;
|
|
93
96
|
}
|
|
@@ -113,13 +116,13 @@ class Lexer {
|
|
|
113
116
|
if (first === "|" && last === "|") {
|
|
114
117
|
tok = new Tokens.StringTemplate(pos, s);
|
|
115
118
|
}
|
|
116
|
-
else if (first === "|" && last === "{") {
|
|
119
|
+
else if (first === "|" && last === "{" && whiteAfter === true) {
|
|
117
120
|
tok = new Tokens.StringTemplateBegin(pos, s);
|
|
118
121
|
}
|
|
119
|
-
else if (first === "}" && last === "|") {
|
|
122
|
+
else if (first === "}" && last === "|" && whiteBefore === true) {
|
|
120
123
|
tok = new Tokens.StringTemplateEnd(pos, s);
|
|
121
124
|
}
|
|
122
|
-
else if (first === "}" && last === "{") {
|
|
125
|
+
else if (first === "}" && last === "{" && whiteAfter === true && whiteBefore === true) {
|
|
123
126
|
tok = new Tokens.StringTemplateMiddle(pos, s);
|
|
124
127
|
}
|
|
125
128
|
else {
|
|
@@ -4,7 +4,7 @@ exports.MethodParamName = void 0;
|
|
|
4
4
|
const combi_1 = require("../combi");
|
|
5
5
|
class MethodParamName extends combi_1.Expression {
|
|
6
6
|
getRunnable() {
|
|
7
|
-
const field = (0, combi_1.regex)(
|
|
7
|
+
const field = (0, combi_1.regex)(/^!?\w*(\/\w+\/)?\w+$/);
|
|
8
8
|
return field;
|
|
9
9
|
}
|
|
10
10
|
}
|
|
@@ -72,13 +72,13 @@ class FlowGraph {
|
|
|
72
72
|
this.label = label;
|
|
73
73
|
}
|
|
74
74
|
toDigraph() {
|
|
75
|
-
return `digraph G {
|
|
76
|
-
labelloc="t";
|
|
77
|
-
label="${this.label}";
|
|
78
|
-
graph [fontname = "helvetica"];
|
|
79
|
-
node [fontname = "helvetica", shape="box"];
|
|
80
|
-
edge [fontname = "helvetica"];
|
|
81
|
-
${this.toTextEdges()}
|
|
75
|
+
return `digraph G {
|
|
76
|
+
labelloc="t";
|
|
77
|
+
label="${this.label}";
|
|
78
|
+
graph [fontname = "helvetica"];
|
|
79
|
+
node [fontname = "helvetica", shape="box"];
|
|
80
|
+
edge [fontname = "helvetica"];
|
|
81
|
+
${this.toTextEdges()}
|
|
82
82
|
}`;
|
|
83
83
|
}
|
|
84
84
|
listSources(node) {
|
package/build/src/lsp/help.js
CHANGED
|
@@ -19,13 +19,13 @@ class Help {
|
|
|
19
19
|
/////////////////////////////////////////////////
|
|
20
20
|
static dumpABAP(file, reg, textDocument, position) {
|
|
21
21
|
let content = "";
|
|
22
|
-
content = `
|
|
23
|
-
<a href="#_tokens" rel="no-refresh">Tokens</a> |
|
|
24
|
-
<a href="#_statements" rel="no-refresh">Statements</a> |
|
|
25
|
-
<a href="#_structure" rel="no-refresh">Structure</a> |
|
|
26
|
-
<a href="#_files" rel="no-refresh">Files</a> |
|
|
27
|
-
<a href="#_info" rel="no-refresh">Info Dump</a>
|
|
28
|
-
<hr>
|
|
22
|
+
content = `
|
|
23
|
+
<a href="#_tokens" rel="no-refresh">Tokens</a> |
|
|
24
|
+
<a href="#_statements" rel="no-refresh">Statements</a> |
|
|
25
|
+
<a href="#_structure" rel="no-refresh">Structure</a> |
|
|
26
|
+
<a href="#_files" rel="no-refresh">Files</a> |
|
|
27
|
+
<a href="#_info" rel="no-refresh">Info Dump</a>
|
|
28
|
+
<hr>
|
|
29
29
|
` +
|
|
30
30
|
"<tt>" + textDocument.uri + " (" +
|
|
31
31
|
(position.line + 1) + ", " +
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.SemanticHighlighting = void 0;
|
|
4
|
-
const
|
|
4
|
+
const LServer = require("vscode-languageserver-types");
|
|
5
5
|
const position_1 = require("../position");
|
|
6
6
|
const tokens_1 = require("../abap/1_lexer/tokens");
|
|
7
7
|
const nodes_1 = require("../abap/nodes");
|
|
@@ -30,7 +30,7 @@ class SemanticHighlighting {
|
|
|
30
30
|
SemanticHighlighting.tokenTypes.push(SOURCE_ABAP);
|
|
31
31
|
SemanticHighlighting.tokenTypeMap[BLOCK_ABAP] = SemanticHighlighting.tokenTypes.length;
|
|
32
32
|
SemanticHighlighting.tokenTypes.push(BLOCK_ABAP);
|
|
33
|
-
for (const t in
|
|
33
|
+
for (const t in LServer.SemanticTokenTypes) {
|
|
34
34
|
SemanticHighlighting.tokenTypeMap[t] = SemanticHighlighting.tokenTypes.length;
|
|
35
35
|
SemanticHighlighting.tokenTypes.push(t);
|
|
36
36
|
}
|
|
@@ -58,7 +58,7 @@ class SemanticHighlighting {
|
|
|
58
58
|
const statementInstance = s.get();
|
|
59
59
|
for (const t of s.getTokenNodes()) {
|
|
60
60
|
const tokenInstance = t.get();
|
|
61
|
-
let tokenType =
|
|
61
|
+
let tokenType = LServer.SemanticTokenTypes.keyword;
|
|
62
62
|
if (tokenInstance instanceof tokens_1.Punctuation) {
|
|
63
63
|
tokenType = SOURCE_ABAP;
|
|
64
64
|
}
|
|
@@ -81,10 +81,10 @@ class SemanticHighlighting {
|
|
|
81
81
|
|| tokenInstance instanceof tokens_1.StringTemplateBegin
|
|
82
82
|
|| tokenInstance instanceof tokens_1.StringTemplateEnd
|
|
83
83
|
|| tokenInstance instanceof tokens_1.StringTemplateMiddle) {
|
|
84
|
-
tokenType =
|
|
84
|
+
tokenType = LServer.SemanticTokenTypes.string;
|
|
85
85
|
}
|
|
86
86
|
else if (tokenInstance instanceof tokens_1.Comment) {
|
|
87
|
-
tokenType =
|
|
87
|
+
tokenType = LServer.SemanticTokenTypes.comment;
|
|
88
88
|
}
|
|
89
89
|
else if (t instanceof nodes_1.TokenNodeRegex) {
|
|
90
90
|
tokenType = SOURCE_ABAP;
|
|
@@ -155,6 +155,27 @@ class Table extends _abstract_object_1.AbstractObject {
|
|
|
155
155
|
type: new basic_1.GenericObjectReferenceType()
|
|
156
156
|
});
|
|
157
157
|
}
|
|
158
|
+
else if (field.REFTYPE === "S") {
|
|
159
|
+
const lookup = ddic.lookupTableOrView(field.ROLLNAME);
|
|
160
|
+
components.push({ name: field.FIELDNAME, type: new basic_1.DataReference(lookup.type) });
|
|
161
|
+
if (lookup.object) {
|
|
162
|
+
references.push({ object: lookup.object });
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
else if (field.REFTYPE === "L") {
|
|
166
|
+
const lookup = ddic.lookupTableType(field.ROLLNAME);
|
|
167
|
+
components.push({ name: field.FIELDNAME, type: new basic_1.DataReference(lookup.type) });
|
|
168
|
+
if (lookup.object) {
|
|
169
|
+
references.push({ object: lookup.object });
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
else if (field.REFTYPE === "E") {
|
|
173
|
+
const lookup = ddic.lookupDataElement(field.ROLLNAME);
|
|
174
|
+
components.push({ name: field.FIELDNAME, type: new basic_1.DataReference(lookup.type) });
|
|
175
|
+
if (lookup.object) {
|
|
176
|
+
references.push({ object: lookup.object });
|
|
177
|
+
}
|
|
178
|
+
}
|
|
158
179
|
else {
|
|
159
180
|
const lookup = ddic.lookupObject(field.ROLLNAME);
|
|
160
181
|
components.push({ name: field.FIELDNAME, type: lookup.type });
|
|
@@ -245,6 +266,7 @@ class Table extends _abstract_object_1.AbstractObject {
|
|
|
245
266
|
DECIMALS: field.DECIMALS,
|
|
246
267
|
KEYFLAG: field.KEYFLAG,
|
|
247
268
|
GROUPNAME: field.GROUPNAME,
|
|
269
|
+
REFTYPE: field.REFTYPE,
|
|
248
270
|
});
|
|
249
271
|
}
|
|
250
272
|
}
|
package/build/src/registry.js
CHANGED
|
@@ -17,8 +17,8 @@ class SevenBitAscii {
|
|
|
17
17
|
key: "7bit_ascii",
|
|
18
18
|
title: "Check for 7bit ascii",
|
|
19
19
|
shortDescription: `Only allow characters from the 7bit ASCII set.`,
|
|
20
|
-
extendedInformation: `https://docs.abapopenchecks.org/checks/05/
|
|
21
|
-
|
|
20
|
+
extendedInformation: `https://docs.abapopenchecks.org/checks/05/
|
|
21
|
+
|
|
22
22
|
Checkes files with extension ".abap" and ".asddls"`,
|
|
23
23
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
24
24
|
};
|
|
@@ -23,7 +23,7 @@ class Abapdoc extends _abap_rule_1.ABAPRule {
|
|
|
23
23
|
return {
|
|
24
24
|
key: "abapdoc",
|
|
25
25
|
title: "Check abapdoc",
|
|
26
|
-
shortDescription: `Various checks regarding abapdoc.
|
|
26
|
+
shortDescription: `Various checks regarding abapdoc.
|
|
27
27
|
Base rule checks for existence of abapdoc for public class methods and all interface methods.`,
|
|
28
28
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
29
29
|
};
|
|
@@ -20,42 +20,42 @@ class AlignParameters extends _abap_rule_1.ABAPRule {
|
|
|
20
20
|
key: "align_parameters",
|
|
21
21
|
title: "Align Parameters",
|
|
22
22
|
shortDescription: `Checks for vertially aligned parameters`,
|
|
23
|
-
extendedInformation: `Checks:
|
|
24
|
-
* function module calls
|
|
25
|
-
* method calls
|
|
26
|
-
* VALUE constructors
|
|
27
|
-
* NEW constructors
|
|
28
|
-
* RAISE EXCEPTION statements
|
|
29
|
-
* CREATE OBJECT statements
|
|
30
|
-
* RAISE EVENT statements
|
|
31
|
-
|
|
32
|
-
https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
|
|
33
|
-
|
|
34
|
-
Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
|
|
35
|
-
|
|
23
|
+
extendedInformation: `Checks:
|
|
24
|
+
* function module calls
|
|
25
|
+
* method calls
|
|
26
|
+
* VALUE constructors
|
|
27
|
+
* NEW constructors
|
|
28
|
+
* RAISE EXCEPTION statements
|
|
29
|
+
* CREATE OBJECT statements
|
|
30
|
+
* RAISE EVENT statements
|
|
31
|
+
|
|
32
|
+
https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
|
|
33
|
+
|
|
34
|
+
Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
|
|
35
|
+
|
|
36
36
|
Also https://rules.abaplint.org/max_one_method_parameter_per_line/ can help aligning parameter syntax`,
|
|
37
37
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Styleguide],
|
|
38
|
-
badExample: `CALL FUNCTION 'FOOBAR'
|
|
39
|
-
EXPORTING
|
|
40
|
-
foo = 2
|
|
41
|
-
parameter = 3.
|
|
42
|
-
|
|
43
|
-
foobar( moo = 1
|
|
44
|
-
param = 1 ).
|
|
45
|
-
|
|
46
|
-
foo = VALUE #(
|
|
47
|
-
foo = bar
|
|
38
|
+
badExample: `CALL FUNCTION 'FOOBAR'
|
|
39
|
+
EXPORTING
|
|
40
|
+
foo = 2
|
|
41
|
+
parameter = 3.
|
|
42
|
+
|
|
43
|
+
foobar( moo = 1
|
|
44
|
+
param = 1 ).
|
|
45
|
+
|
|
46
|
+
foo = VALUE #(
|
|
47
|
+
foo = bar
|
|
48
48
|
moo = 2 ).`,
|
|
49
|
-
goodExample: `CALL FUNCTION 'FOOBAR'
|
|
50
|
-
EXPORTING
|
|
51
|
-
foo = 2
|
|
52
|
-
parameter = 3.
|
|
53
|
-
|
|
54
|
-
foobar( moo = 1
|
|
55
|
-
param = 1 ).
|
|
56
|
-
|
|
57
|
-
foo = VALUE #(
|
|
58
|
-
foo = bar
|
|
49
|
+
goodExample: `CALL FUNCTION 'FOOBAR'
|
|
50
|
+
EXPORTING
|
|
51
|
+
foo = 2
|
|
52
|
+
parameter = 3.
|
|
53
|
+
|
|
54
|
+
foobar( moo = 1
|
|
55
|
+
param = 1 ).
|
|
56
|
+
|
|
57
|
+
foo = VALUE #(
|
|
58
|
+
foo = bar
|
|
59
59
|
moo = 2 ).`,
|
|
60
60
|
};
|
|
61
61
|
}
|
|
@@ -20,14 +20,14 @@ class AmbiguousStatement extends _abap_rule_1.ABAPRule {
|
|
|
20
20
|
return {
|
|
21
21
|
key: "ambiguous_statement",
|
|
22
22
|
title: "Check for ambigious statements",
|
|
23
|
-
shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
|
|
24
|
-
Add "TABLE" keyword or "@" for escaping SQL variables
|
|
25
|
-
|
|
23
|
+
shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
|
|
24
|
+
Add "TABLE" keyword or "@" for escaping SQL variables
|
|
25
|
+
|
|
26
26
|
Only works if the target version is 740sp05 or above`,
|
|
27
27
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
28
|
-
badExample: `DELETE foo FROM bar.
|
|
28
|
+
badExample: `DELETE foo FROM bar.
|
|
29
29
|
MODIFY foo FROM bar.`,
|
|
30
|
-
goodExample: `DELETE foo FROM @bar.
|
|
30
|
+
goodExample: `DELETE foo FROM @bar.
|
|
31
31
|
MODIFY TABLE foo FROM bar.`,
|
|
32
32
|
};
|
|
33
33
|
}
|
|
@@ -37,14 +37,14 @@ class AvoidUse extends _abap_rule_1.ABAPRule {
|
|
|
37
37
|
key: "avoid_use",
|
|
38
38
|
title: "Avoid use of certain statements",
|
|
39
39
|
shortDescription: `Detects usage of certain statements.`,
|
|
40
|
-
extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
|
|
41
|
-
|
|
42
|
-
Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
|
|
43
|
-
|
|
44
|
-
STATICS: use CLASS-DATA instead
|
|
45
|
-
|
|
46
|
-
DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
|
|
47
|
-
|
|
40
|
+
extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
|
|
41
|
+
|
|
42
|
+
Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
|
|
43
|
+
|
|
44
|
+
STATICS: use CLASS-DATA instead
|
|
45
|
+
|
|
46
|
+
DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
|
|
47
|
+
|
|
48
48
|
TEST-SEAMS: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-test-seams-as-temporary-workaround`,
|
|
49
49
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
50
50
|
};
|
|
@@ -23,11 +23,11 @@ class BeginEndNames extends _abap_rule_1.ABAPRule {
|
|
|
23
23
|
title: "Check BEGIN END names",
|
|
24
24
|
shortDescription: `Check BEGIN OF and END OF names match, plus there must be statements between BEGIN and END`,
|
|
25
25
|
tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
26
|
-
badExample: `DATA: BEGIN OF stru,
|
|
27
|
-
field TYPE i,
|
|
26
|
+
badExample: `DATA: BEGIN OF stru,
|
|
27
|
+
field TYPE i,
|
|
28
28
|
END OF structure_not_the_same.`,
|
|
29
|
-
goodExample: `DATA: BEGIN OF stru,
|
|
30
|
-
field TYPE i,
|
|
29
|
+
goodExample: `DATA: BEGIN OF stru,
|
|
30
|
+
field TYPE i,
|
|
31
31
|
END OF stru.`,
|
|
32
32
|
};
|
|
33
33
|
}
|
|
@@ -21,19 +21,19 @@ class BeginSingleInclude extends _abap_rule_1.ABAPRule {
|
|
|
21
21
|
title: "BEGIN contains single INCLUDE",
|
|
22
22
|
shortDescription: `Finds TYPE BEGIN with just one INCLUDE TYPE, and DATA with single INCLUDE STRUCTURE`,
|
|
23
23
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
24
|
-
badExample: `TYPES: BEGIN OF dummy1.
|
|
25
|
-
INCLUDE TYPE dselc.
|
|
26
|
-
TYPES: END OF dummy1.
|
|
27
|
-
|
|
28
|
-
DATA BEGIN OF foo.
|
|
29
|
-
INCLUDE STRUCTURE syst.
|
|
30
|
-
DATA END OF foo.
|
|
31
|
-
|
|
32
|
-
STATICS BEGIN OF bar.
|
|
33
|
-
INCLUDE STRUCTURE syst.
|
|
24
|
+
badExample: `TYPES: BEGIN OF dummy1.
|
|
25
|
+
INCLUDE TYPE dselc.
|
|
26
|
+
TYPES: END OF dummy1.
|
|
27
|
+
|
|
28
|
+
DATA BEGIN OF foo.
|
|
29
|
+
INCLUDE STRUCTURE syst.
|
|
30
|
+
DATA END OF foo.
|
|
31
|
+
|
|
32
|
+
STATICS BEGIN OF bar.
|
|
33
|
+
INCLUDE STRUCTURE syst.
|
|
34
34
|
STATICS END OF bar.`,
|
|
35
|
-
goodExample: `DATA BEGIN OF foo.
|
|
36
|
-
INCLUDE STRUCTURE dselc.
|
|
35
|
+
goodExample: `DATA BEGIN OF foo.
|
|
36
|
+
INCLUDE STRUCTURE dselc.
|
|
37
37
|
DATA END OF foo.`,
|
|
38
38
|
};
|
|
39
39
|
}
|
|
@@ -24,9 +24,9 @@ class CallTransactionAuthorityCheck extends _abap_rule_1.ABAPRule {
|
|
|
24
24
|
extendedInformation: `https://docs.abapopenchecks.org/checks/54/`,
|
|
25
25
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
|
|
26
26
|
badExample: `CALL TRANSACTION 'FOO'.`,
|
|
27
|
-
goodExample: `TRY.
|
|
28
|
-
CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
|
|
29
|
-
CATCH cx_sy_authorization_error.
|
|
27
|
+
goodExample: `TRY.
|
|
28
|
+
CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
|
|
29
|
+
CATCH cx_sy_authorization_error.
|
|
30
30
|
ENDTRY.`,
|
|
31
31
|
};
|
|
32
32
|
}
|
|
@@ -45,10 +45,10 @@ class ChainMainlyDeclarations extends _abap_rule_1.ABAPRule {
|
|
|
45
45
|
key: "chain_mainly_declarations",
|
|
46
46
|
title: "Chain mainly declarations",
|
|
47
47
|
shortDescription: `Chain mainly declarations, allows chaining for the configured statements, reports errors for other statements.`,
|
|
48
|
-
extendedInformation: `
|
|
49
|
-
https://docs.abapopenchecks.org/checks/23/
|
|
50
|
-
|
|
51
|
-
https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
|
|
48
|
+
extendedInformation: `
|
|
49
|
+
https://docs.abapopenchecks.org/checks/23/
|
|
50
|
+
|
|
51
|
+
https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
|
|
52
52
|
`,
|
|
53
53
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
|
|
54
54
|
badExample: `CALL METHOD: bar.`,
|
|
@@ -23,8 +23,8 @@ class CheckAbstract extends _abap_rule_1.ABAPRule {
|
|
|
23
23
|
return {
|
|
24
24
|
key: "check_abstract",
|
|
25
25
|
title: "Check abstract methods and classes",
|
|
26
|
-
shortDescription: `Checks abstract methods and classes:
|
|
27
|
-
- class defined as abstract and final,
|
|
26
|
+
shortDescription: `Checks abstract methods and classes:
|
|
27
|
+
- class defined as abstract and final,
|
|
28
28
|
- non-abstract class contains abstract methods`,
|
|
29
29
|
extendedInformation: `If a class defines only constants, use an interface instead`,
|
|
30
30
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
@@ -27,11 +27,11 @@ class CheckComments extends _abap_rule_1.ABAPRule {
|
|
|
27
27
|
return {
|
|
28
28
|
key: "check_comments",
|
|
29
29
|
title: "Check Comments",
|
|
30
|
-
shortDescription: `
|
|
30
|
+
shortDescription: `
|
|
31
31
|
Various checks for comment usage.`,
|
|
32
|
-
extendedInformation: `
|
|
33
|
-
* End of line comments. Comments starting with "#EC" or "##" are ignored
|
|
34
|
-
|
|
32
|
+
extendedInformation: `
|
|
33
|
+
* End of line comments. Comments starting with "#EC" or "##" are ignored
|
|
34
|
+
|
|
35
35
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#put-comments-before-the-statement-they-relate-to`,
|
|
36
36
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
37
37
|
};
|
|
@@ -17,9 +17,9 @@ class CheckInclude {
|
|
|
17
17
|
key: "check_include",
|
|
18
18
|
title: "Check INCLUDEs",
|
|
19
19
|
shortDescription: `Checks INCLUDE statements`,
|
|
20
|
-
extendedInformation: `
|
|
21
|
-
* Reports unused includes
|
|
22
|
-
* Errors if the includes are not found
|
|
20
|
+
extendedInformation: `
|
|
21
|
+
* Reports unused includes
|
|
22
|
+
* Errors if the includes are not found
|
|
23
23
|
* Error if including a main program`,
|
|
24
24
|
tags: [_irule_1.RuleTag.Syntax],
|
|
25
25
|
};
|
|
@@ -34,14 +34,14 @@ class CheckSubrc extends _abap_rule_1.ABAPRule {
|
|
|
34
34
|
key: "check_subrc",
|
|
35
35
|
title: "Check sy-subrc",
|
|
36
36
|
shortDescription: `Check sy-subrc`,
|
|
37
|
-
extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
|
|
38
|
-
|
|
39
|
-
If sy-dbcnt is checked after database statements, it is considered okay.
|
|
40
|
-
|
|
41
|
-
"SELECT SINGLE @abap_true FROM " is considered as an existence check
|
|
42
|
-
|
|
43
|
-
If IS ASSIGNED is checked after assigning, it is considered okay.
|
|
44
|
-
|
|
37
|
+
extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
|
|
38
|
+
|
|
39
|
+
If sy-dbcnt is checked after database statements, it is considered okay.
|
|
40
|
+
|
|
41
|
+
"SELECT SINGLE @abap_true FROM " is considered as an existence check
|
|
42
|
+
|
|
43
|
+
If IS ASSIGNED is checked after assigning, it is considered okay.
|
|
44
|
+
|
|
45
45
|
FIND statement with MATCH COUNT is considered okay if subrc is not checked`,
|
|
46
46
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
47
47
|
pseudoComment: "EC CI_SUBRC",
|
|
@@ -21,15 +21,15 @@ class ClassicExceptionsOverlap extends _abap_rule_1.ABAPRule {
|
|
|
21
21
|
shortDescription: `Find overlapping classic exceptions`,
|
|
22
22
|
extendedInformation: `When debugging its typically good to know exactly which exception is caught`,
|
|
23
23
|
tags: [_irule_1.RuleTag.SingleFile],
|
|
24
|
-
badExample: ` EXCEPTIONS
|
|
25
|
-
system_failure = 1 MESSAGE lv_message
|
|
26
|
-
communication_failure = 1 MESSAGE lv_message
|
|
27
|
-
resource_failure = 1
|
|
24
|
+
badExample: ` EXCEPTIONS
|
|
25
|
+
system_failure = 1 MESSAGE lv_message
|
|
26
|
+
communication_failure = 1 MESSAGE lv_message
|
|
27
|
+
resource_failure = 1
|
|
28
28
|
OTHERS = 1.`,
|
|
29
|
-
goodExample: ` EXCEPTIONS
|
|
30
|
-
system_failure = 1 MESSAGE lv_message
|
|
31
|
-
communication_failure = 2 MESSAGE lv_message
|
|
32
|
-
resource_failure = 3
|
|
29
|
+
goodExample: ` EXCEPTIONS
|
|
30
|
+
system_failure = 1 MESSAGE lv_message
|
|
31
|
+
communication_failure = 2 MESSAGE lv_message
|
|
32
|
+
resource_failure = 3
|
|
33
33
|
OTHERS = 4.`,
|
|
34
34
|
};
|
|
35
35
|
}
|
|
@@ -30,7 +30,7 @@ class CommentedCode extends _abap_rule_1.ABAPRule {
|
|
|
30
30
|
key: "commented_code",
|
|
31
31
|
title: "Find commented code",
|
|
32
32
|
shortDescription: `Detects usage of commented out code.`,
|
|
33
|
-
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
|
|
33
|
+
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
|
|
34
34
|
https://docs.abapopenchecks.org/checks/14/`,
|
|
35
35
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
|
|
36
36
|
};
|
|
@@ -18,10 +18,10 @@ class ConstructorVisibilityPublic {
|
|
|
18
18
|
key: "constructor_visibility_public",
|
|
19
19
|
title: "Check constructor visibility is public",
|
|
20
20
|
shortDescription: `Constructor must be placed in the public section, even if the class is not CREATE PUBLIC.`,
|
|
21
|
-
extendedInformation: `
|
|
22
|
-
This only applies to global classes.
|
|
23
|
-
|
|
24
|
-
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
|
|
21
|
+
extendedInformation: `
|
|
22
|
+
This only applies to global classes.
|
|
23
|
+
|
|
24
|
+
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
|
|
25
25
|
https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abeninstance_constructor_guidl.htm`,
|
|
26
26
|
tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
27
27
|
};
|
|
@@ -25,8 +25,8 @@ class ContainsTab extends _abap_rule_1.ABAPRule {
|
|
|
25
25
|
key: "contains_tab",
|
|
26
26
|
title: "Code contains tab",
|
|
27
27
|
shortDescription: `Checks for usage of tabs (enable to enforce spaces)`,
|
|
28
|
-
extendedInformation: `
|
|
29
|
-
https://docs.abapopenchecks.org/checks/09/
|
|
28
|
+
extendedInformation: `
|
|
29
|
+
https://docs.abapopenchecks.org/checks/09/
|
|
30
30
|
https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#indent-and-snap-to-tab`,
|
|
31
31
|
tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
|
|
32
32
|
};
|
|
@@ -24,7 +24,7 @@ class DangerousStatementConf extends _basic_rule_config_1.BasicRuleConfig {
|
|
|
24
24
|
this.deleteReport = true;
|
|
25
25
|
this.deleteTextpool = true;
|
|
26
26
|
this.deleteDynpro = true;
|
|
27
|
-
this.
|
|
27
|
+
this.exportDynpro = true;
|
|
28
28
|
/** Finds instances of dynamic SQL: SELECT, UPDATE, DELETE, INSERT, MODIFY */
|
|
29
29
|
this.dynamicSQL = true;
|
|
30
30
|
}
|
|
@@ -40,7 +40,7 @@ class DangerousStatement extends _abap_rule_1.ABAPRule {
|
|
|
40
40
|
key: "dangerous_statement",
|
|
41
41
|
title: "Dangerous statement",
|
|
42
42
|
shortDescription: `Detects potentially dangerous statements`,
|
|
43
|
-
extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
|
|
43
|
+
extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
|
|
44
44
|
dynamic SQL can potentially create SQL injection problems`,
|
|
45
45
|
tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
|
|
46
46
|
};
|
|
@@ -89,8 +89,8 @@ dynamic SQL can potentially create SQL injection problems`,
|
|
|
89
89
|
else if (this.conf.deleteDynpro && statement instanceof Statements.DeleteDynpro) {
|
|
90
90
|
message = "DELETE DYNPRO";
|
|
91
91
|
}
|
|
92
|
-
else if (this.conf.
|
|
93
|
-
message = "
|
|
92
|
+
else if (this.conf.exportDynpro && statement instanceof Statements.ExportDynpro) {
|
|
93
|
+
message = "EXPORT DYNPRO";
|
|
94
94
|
}
|
|
95
95
|
if (message) {
|
|
96
96
|
issues.push(issue_1.Issue.atStatement(file, statementNode, this.getDescription(message), this.getMetadata().key, this.conf.severity));
|
|
@@ -112,7 +112,8 @@ dynamic SQL can potentially create SQL injection problems`,
|
|
|
112
112
|
|| statement instanceof Statements.InsertDatabase
|
|
113
113
|
|| statement instanceof Statements.ModifyDatabase
|
|
114
114
|
|| statement instanceof Statements.DeleteDatabase) {
|
|
115
|
-
|
|
115
|
+
const dyn = statementNode.findFirstExpression(Expressions.Dynamic);
|
|
116
|
+
if (dyn && dyn.findDirectExpression(Expressions.Constant) === undefined) {
|
|
116
117
|
return "Dynamic SQL";
|
|
117
118
|
}
|
|
118
119
|
}
|