@abaplint/core 2.80.0 → 2.80.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/README.md +6 -6
  2. package/build/src/abap/2_statements/statements/replace.js +1 -1
  3. package/build/src/abap/5_syntax/basic_types.js +1 -0
  4. package/build/src/abap/flow/statement_flow.js +21 -5
  5. package/build/src/abap/types/method_definition.js +7 -1
  6. package/build/src/lsp/help.js +7 -7
  7. package/build/src/lsp/language_server.js +1 -1
  8. package/build/src/registry.js +1 -1
  9. package/build/src/rules/abapdoc.js +1 -1
  10. package/build/src/rules/align_parameters.js +208 -18
  11. package/build/src/rules/ambiguous_statement.js +5 -5
  12. package/build/src/rules/avoid_use.js +6 -6
  13. package/build/src/rules/begin_end_names.js +4 -4
  14. package/build/src/rules/begin_single_include.js +12 -12
  15. package/build/src/rules/call_transaction_authority_check.js +3 -3
  16. package/build/src/rules/chain_mainly_declarations.js +4 -4
  17. package/build/src/rules/check_abstract.js +2 -2
  18. package/build/src/rules/check_comments.js +3 -3
  19. package/build/src/rules/check_include.js +3 -3
  20. package/build/src/rules/check_no_handler_pragma.js +8 -8
  21. package/build/src/rules/check_subrc.js +8 -8
  22. package/build/src/rules/commented_code.js +1 -1
  23. package/build/src/rules/constructor_visibility_public.js +4 -4
  24. package/build/src/rules/contains_tab.js +2 -2
  25. package/build/src/rules/dangerous_statement.js +1 -1
  26. package/build/src/rules/downport.js +35 -35
  27. package/build/src/rules/exit_or_check.js +3 -3
  28. package/build/src/rules/exporting.js +1 -1
  29. package/build/src/rules/forbidden_identifier.js +1 -1
  30. package/build/src/rules/forbidden_void_type.js +2 -2
  31. package/build/src/rules/functional_writing.js +17 -17
  32. package/build/src/rules/global_class.js +10 -10
  33. package/build/src/rules/identical_conditions.js +2 -2
  34. package/build/src/rules/identical_contents.js +15 -15
  35. package/build/src/rules/identical_descriptions.js +4 -4
  36. package/build/src/rules/if_in_if.js +7 -7
  37. package/build/src/rules/implement_methods.js +3 -3
  38. package/build/src/rules/in_statement_indentation.js +11 -11
  39. package/build/src/rules/intf_referencing_clas.js +3 -3
  40. package/build/src/rules/line_break_style.js +2 -2
  41. package/build/src/rules/line_length.js +1 -1
  42. package/build/src/rules/line_only_punc.js +1 -1
  43. package/build/src/rules/local_variable_names.js +2 -2
  44. package/build/src/rules/many_parentheses.js +10 -10
  45. package/build/src/rules/max_one_method_parameter_per_line.js +7 -7
  46. package/build/src/rules/max_one_statement.js +3 -3
  47. package/build/src/rules/nesting.js +1 -1
  48. package/build/src/rules/no_public_attributes.js +1 -1
  49. package/build/src/rules/no_yoda_conditions.js +4 -4
  50. package/build/src/rules/obsolete_statement.js +36 -36
  51. package/build/src/rules/omit_parameter_name.js +3 -3
  52. package/build/src/rules/omit_receiving.js +13 -13
  53. package/build/src/rules/parser_702_chaining.js +2 -2
  54. package/build/src/rules/parser_error.js +2 -2
  55. package/build/src/rules/parser_missing_space.js +1 -1
  56. package/build/src/rules/prefer_inline.js +16 -16
  57. package/build/src/rules/prefer_is_not.js +7 -7
  58. package/build/src/rules/prefer_raise_exception_new.js +3 -3
  59. package/build/src/rules/prefer_returning_to_exporting.js +1 -1
  60. package/build/src/rules/prefer_xsdbool.js +2 -2
  61. package/build/src/rules/remove_descriptions.js +4 -4
  62. package/build/src/rules/rfc_error_handling.js +9 -9
  63. package/build/src/rules/select_add_order_by.js +5 -5
  64. package/build/src/rules/select_performance.js +2 -2
  65. package/build/src/rules/sicf_consistency.js +4 -4
  66. package/build/src/rules/space_before_dot.js +2 -2
  67. package/build/src/rules/start_at_tab.js +1 -1
  68. package/build/src/rules/sy_modification.js +2 -2
  69. package/build/src/rules/tabl_enhancement_category.js +2 -2
  70. package/build/src/rules/unused_methods.js +9 -9
  71. package/build/src/rules/unused_variables.js +6 -6
  72. package/build/src/rules/use_bool_expression.js +8 -8
  73. package/build/src/rules/use_line_exists.js +6 -6
  74. package/build/src/rules/use_new.js +2 -2
  75. package/build/src/rules/when_others_last.js +6 -6
  76. package/package.json +76 -76
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
- # @abaplint/core
2
-
3
- [abaplint](https://abaplint.org/) core library
4
-
5
- Exposes functionallity 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 functionallity like the parser and rules, which can be used in other projects.
6
+
7
7
  For more information see https://github.com/abaplint/abaplint
@@ -7,7 +7,7 @@ class Replace {
7
7
  getMatcher() {
8
8
  const length = (0, combi_1.seq)("LENGTH", expressions_1.Source);
9
9
  const offset = (0, combi_1.seq)("OFFSET", expressions_1.Source);
10
- const section = (0, combi_1.seq)((0, combi_1.opt)("IN"), "SECTION", (0, combi_1.per)(offset, length), "OF", expressions_1.Source);
10
+ const section = (0, combi_1.seq)((0, combi_1.opt)("IN"), "SECTION", (0, combi_1.per)(offset, length), "OF", expressions_1.Target);
11
11
  const source = (0, combi_1.seq)((0, combi_1.opt)("OF"), expressions_1.FindType, expressions_1.Source);
12
12
  const cas = (0, combi_1.alt)("IGNORING CASE", "RESPECTING CASE");
13
13
  const repl = (0, combi_1.seq)("REPLACEMENT COUNT", expressions_1.Target);
@@ -455,6 +455,7 @@ class BasicTypes {
455
455
  // lookup in local and global scope
456
456
  const obj = this.scope.findObjectDefinition(className);
457
457
  if (obj === undefined && this.scope.getDDIC().inErrorNamespace(className) === false) {
458
+ this.scope.addReference(expr.getFirstToken(), undefined, _reference_1.ReferenceType.ObjectOrientedVoidReference, this.filename, { ooName: className.toUpperCase() });
458
459
  return new Types.VoidType(className);
459
460
  }
460
461
  else if (obj === undefined) {
@@ -1,14 +1,23 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.StatementFlow = exports.dumpFlow = void 0;
3
+ exports.StatementFlow = exports.dumpFlows = exports.dumpFlowsWithDescription = void 0;
4
4
  const nodes_1 = require("../nodes");
5
5
  const Structures = require("../3_structures/structures");
6
6
  const Statements = require("../2_statements/statements");
7
- function dumpFlow(flows) {
7
+ const Expressions = require("../2_statements/expressions");
8
+ function dumpFlowsWithDescription(flows) {
9
+ let ret = "";
10
+ for (const f of flows) {
11
+ ret += f.description + ": [" + f.statements.map(b => b === null || b === void 0 ? void 0 : b.get().constructor.name).join(",") + "]\n";
12
+ }
13
+ return ret.trim();
14
+ }
15
+ exports.dumpFlowsWithDescription = dumpFlowsWithDescription;
16
+ function dumpFlows(flows) {
8
17
  const ret = "[" + flows.map(f => "[" + f.statements.map(b => b === null || b === void 0 ? void 0 : b.get().constructor.name).join(",") + "]").join(",");
9
18
  return ret + "]";
10
19
  }
11
- exports.dumpFlow = dumpFlow;
20
+ exports.dumpFlows = dumpFlows;
12
21
  function findBody(f) {
13
22
  var _a;
14
23
  return ((_a = f.findDirectStructure(Structures.Body)) === null || _a === void 0 ? void 0 : _a.getChildren()) || [];
@@ -52,14 +61,21 @@ function pruneByStatement(flows, type) {
52
61
  ////////////////////////////////////////////////////////////////
53
62
  class StatementFlow {
54
63
  build(stru) {
64
+ var _a, _b;
55
65
  const ret = [];
56
66
  const forms = stru.findAllStructures(Structures.Form);
57
67
  for (const f of forms) {
58
- ret.push(...this.traverseBody(findBody(f)));
68
+ let body = this.traverseBody(findBody(f));
69
+ const formName = (_a = f.findFirstExpression(Expressions.FormName)) === null || _a === void 0 ? void 0 : _a.concatTokens();
70
+ body = body.map((b) => { return { description: "FORM " + formName, statements: b.statements }; });
71
+ ret.push(...body);
59
72
  }
60
73
  const methods = stru.findAllStructures(Structures.Method);
61
74
  for (const f of methods) {
62
- ret.push(...this.traverseBody(findBody(f)));
75
+ let body = this.traverseBody(findBody(f));
76
+ const methodName = (_b = f.findFirstExpression(Expressions.MethodName)) === null || _b === void 0 ? void 0 : _b.concatTokens();
77
+ body = body.map((b) => { return { description: "METHOD " + methodName, statements: b.statements }; });
78
+ ret.push(...body);
63
79
  }
64
80
  return ret;
65
81
  }
@@ -49,7 +49,13 @@ class MethodDefinition extends _identifier_1.Identifier {
49
49
  this.raising.push(name);
50
50
  const clas = scope.findClassDefinition(name);
51
51
  if (clas) {
52
- scope.addReference(token, clas, _reference_1.ReferenceType.ObjectOrientedReference, filename);
52
+ scope.addReference(token, clas, _reference_1.ReferenceType.ObjectOrientedReference, filename, { ooName: name.toUpperCase(), ooType: "CLAS" });
53
+ }
54
+ else if (scope.getDDIC().inErrorNamespace(name) === false) {
55
+ scope.addReference(token, clas, _reference_1.ReferenceType.ObjectOrientedVoidReference, filename, { ooName: name.toUpperCase(), ooType: "CLAS" });
56
+ }
57
+ else {
58
+ scope.addReference(token, clas, _reference_1.ReferenceType.ObjectOrientedUnknownReference, filename, { ooName: name.toUpperCase(), ooType: "CLAS" });
53
59
  }
54
60
  }
55
61
  this.visibility = visibility;
@@ -9,13 +9,13 @@ const dump_scope_1 = require("./dump_scope");
9
9
  class Help {
10
10
  static find(reg, textDocument, position) {
11
11
  let content = "";
12
- content = `
13
- <a href="#_tokens" rel="no-refresh">Tokens</a> |
14
- <a href="#_statements" rel="no-refresh">Statements</a> |
15
- <a href="#_structure" rel="no-refresh">Structure</a> |
16
- <a href="#_files" rel="no-refresh">Files</a> |
17
- <a href="#_info" rel="no-refresh">Info Dump</a>
18
- <hr>
12
+ content = `
13
+ <a href="#_tokens" rel="no-refresh">Tokens</a> |
14
+ <a href="#_statements" rel="no-refresh">Statements</a> |
15
+ <a href="#_structure" rel="no-refresh">Structure</a> |
16
+ <a href="#_files" rel="no-refresh">Files</a> |
17
+ <a href="#_info" rel="no-refresh">Info Dump</a>
18
+ <hr>
19
19
  ` +
20
20
  "<tt>" + textDocument.uri + " (" +
21
21
  (position.line + 1) + ", " +
@@ -121,7 +121,7 @@ class LanguageServer {
121
121
  if (stru === undefined) {
122
122
  return "empty structure";
123
123
  }
124
- return (0, statement_flow_1.dumpFlow)(new statement_flow_1.StatementFlow().build(stru)).replace(/\],\[/, "],\n[");
124
+ return (0, statement_flow_1.dumpFlowsWithDescription)(new statement_flow_1.StatementFlow().build(stru)).replace(/\],\[/, "],\n[");
125
125
  }
126
126
  }
127
127
  exports.LanguageServer = LanguageServer;
@@ -68,7 +68,7 @@ class Registry {
68
68
  }
69
69
  static abaplintVersion() {
70
70
  // magic, see build script "version.sh"
71
- return "2.80.0";
71
+ return "2.80.4";
72
72
  }
73
73
  getDDICReferences() {
74
74
  return this.references;
@@ -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
  };
@@ -6,6 +6,7 @@ const Expressions = require("../abap/2_statements/expressions");
6
6
  const _abap_rule_1 = require("./_abap_rule");
7
7
  const _basic_rule_config_1 = require("./_basic_rule_config");
8
8
  const _irule_1 = require("./_irule");
9
+ const __1 = require("..");
9
10
  class AlignParametersConf extends _basic_rule_config_1.BasicRuleConfig {
10
11
  }
11
12
  exports.AlignParametersConf = AlignParametersConf;
@@ -18,17 +19,44 @@ class AlignParameters extends _abap_rule_1.ABAPRule {
18
19
  return {
19
20
  key: "align_parameters",
20
21
  title: "Align Parameters",
21
- shortDescription: `Checks for aligned parameters in function module calls.`,
22
- extendedInformation: `https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters`,
23
- tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
24
- badExample: `CALL FUNCTION 'FOOBAR'
25
- EXPORTING
26
- foo = 2
27
- parameter = 3.`,
28
- goodExample: `CALL FUNCTION 'FOOBAR'
29
- EXPORTING
30
- foo = 2
31
- parameter = 3.`,
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
+
36
+ Also https://rules.abaplint.org/max_one_method_parameter_per_line/ can help aligning parameter syntax`,
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
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
59
+ moo = 2 ).`,
32
60
  };
33
61
  }
34
62
  getConfig() {
@@ -45,11 +73,10 @@ class AlignParameters extends _abap_rule_1.ABAPRule {
45
73
  }
46
74
  const candidates = [];
47
75
  candidates.push(...this.functionParameterCandidates(stru));
48
- /* TODO,
49
- stru.findAllExpressionsRecursive(Expressions.MethodCallParam);
50
- stru.findAllExpressionsRecursive(Expressions.MethodParameters);
51
- stru.findAllExpressionsRecursive(Expressions.ValueBody);
52
- */
76
+ candidates.push(...this.methodCallParamCandidates(stru));
77
+ candidates.push(...this.valueBodyCandidates(stru));
78
+ candidates.push(...this.raiseAndCreateCandidates(stru));
79
+ candidates.push(...this.newCandidates(stru));
53
80
  for (const c of candidates) {
54
81
  const i = this.checkCandidate(c, file);
55
82
  if (i) {
@@ -71,13 +98,176 @@ class AlignParameters extends _abap_rule_1.ABAPRule {
71
98
  }
72
99
  for (const p of candidate.parameters) {
73
100
  if (p.eq.getCol() !== expectedEqualsColumn) {
74
- const pos = candidate.parameters[0].eq;
75
101
  const message = "Align parameters to column " + expectedEqualsColumn;
76
- return issue_1.Issue.atPosition(file, pos, message, this.getMetadata().key);
102
+ return issue_1.Issue.atPosition(file, p.eq, message, this.getMetadata().key);
77
103
  }
78
104
  }
79
105
  return undefined;
80
106
  }
107
+ newCandidates(stru) {
108
+ const candidates = [];
109
+ for (const vb of stru.findAllExpressionsRecursive(Expressions.NewObject)) {
110
+ const parameters = [];
111
+ const fieldAssignments = vb.findDirectExpressions(Expressions.FieldAssignment);
112
+ if (fieldAssignments.length >= 2) {
113
+ for (const fs of fieldAssignments) {
114
+ const children = fs.getChildren();
115
+ if (children.length < 3) {
116
+ continue; // unexpected
117
+ }
118
+ parameters.push({
119
+ left: children[0],
120
+ eq: children[1].getFirstToken().getStart(),
121
+ right: children[2],
122
+ });
123
+ }
124
+ if (parameters.length > 0) {
125
+ candidates.push({ parameters });
126
+ continue;
127
+ }
128
+ }
129
+ const list = vb.findDirectExpression(Expressions.ParameterListS);
130
+ if (list) {
131
+ for (const c of list.getChildren()) {
132
+ const children = c.getChildren();
133
+ if (children.length < 3) {
134
+ continue; // unexpected
135
+ }
136
+ parameters.push({
137
+ left: children[0],
138
+ eq: children[1].getFirstToken().getStart(),
139
+ right: children[2],
140
+ });
141
+ }
142
+ if (parameters.length > 0) {
143
+ candidates.push({ parameters });
144
+ }
145
+ }
146
+ }
147
+ return candidates;
148
+ }
149
+ valueBodyCandidates(stru) {
150
+ const candidates = [];
151
+ for (const vb of stru.findAllExpressionsRecursive(Expressions.ValueBody)) {
152
+ const parameters = [];
153
+ const fieldAssignments = vb.findDirectExpressions(Expressions.FieldAssignment);
154
+ if (fieldAssignments.length <= 1) {
155
+ continue;
156
+ }
157
+ for (const fs of fieldAssignments) {
158
+ const children = fs.getChildren();
159
+ if (children.length < 3) {
160
+ continue; // unexpected
161
+ }
162
+ parameters.push({
163
+ left: children[0],
164
+ eq: children[1].getFirstToken().getStart(),
165
+ right: children[2],
166
+ });
167
+ }
168
+ if (parameters.length > 0) {
169
+ candidates.push({ parameters });
170
+ }
171
+ }
172
+ return candidates;
173
+ }
174
+ raiseAndCreateCandidates(stru) {
175
+ const candidates = [];
176
+ const statements = stru.findAllStatements(__1.Statements.Raise);
177
+ statements.push(...stru.findAllStatements(__1.Statements.CreateObject));
178
+ statements.push(...stru.findAllStatements(__1.Statements.RaiseEvent));
179
+ for (const raise of statements) {
180
+ const parameters = [];
181
+ const param = raise.findDirectExpression(Expressions.ParameterListS);
182
+ for (const p of (param === null || param === void 0 ? void 0 : param.getChildren()) || []) {
183
+ const children = p.getChildren();
184
+ if (children.length < 3) {
185
+ continue; // unexpected
186
+ }
187
+ parameters.push({
188
+ left: children[0],
189
+ eq: children[1].getFirstToken().getStart(),
190
+ right: children[2],
191
+ });
192
+ }
193
+ if (parameters.length > 0) {
194
+ candidates.push({ parameters });
195
+ }
196
+ }
197
+ return candidates;
198
+ }
199
+ methodCallParamCandidates(stru) {
200
+ var _a, _b, _c;
201
+ const candidates = [];
202
+ for (const mcp of stru.findAllExpressionsRecursive(Expressions.MethodCallParam)) {
203
+ const parameters = [];
204
+ for (const param of ((_a = mcp.findDirectExpression(Expressions.ParameterListS)) === null || _a === void 0 ? void 0 : _a.getChildren()) || []) {
205
+ const children = param.getChildren();
206
+ if (children.length < 3) {
207
+ continue; // unexpected
208
+ }
209
+ parameters.push({
210
+ left: children[0],
211
+ eq: children[1].getFirstToken().getStart(),
212
+ right: children[2],
213
+ });
214
+ }
215
+ const mp = mcp.findDirectExpression(Expressions.MethodParameters);
216
+ if (mp) {
217
+ for (const p of ((_b = mp.findDirectExpression(Expressions.ParameterListS)) === null || _b === void 0 ? void 0 : _b.getChildren()) || []) {
218
+ const children = p.getChildren();
219
+ if (children.length < 3) {
220
+ continue; // unexpected
221
+ }
222
+ parameters.push({
223
+ left: children[0],
224
+ eq: children[1].getFirstToken().getStart(),
225
+ right: children[2],
226
+ });
227
+ }
228
+ for (const l of mp.findDirectExpressions(Expressions.ParameterListT)) {
229
+ for (const p of l.findDirectExpressions(Expressions.ParameterT) || []) {
230
+ const children = p.getChildren();
231
+ if (children.length < 3) {
232
+ continue; // unexpected
233
+ }
234
+ parameters.push({
235
+ left: children[0],
236
+ eq: children[1].getFirstToken().getStart(),
237
+ right: children[2],
238
+ });
239
+ }
240
+ }
241
+ const rec = mp.findDirectExpression(Expressions.ParameterT);
242
+ if (rec) {
243
+ const children = rec.getChildren();
244
+ if (children.length < 3) {
245
+ continue; // unexpected
246
+ }
247
+ parameters.push({
248
+ left: children[0],
249
+ eq: children[1].getFirstToken().getStart(),
250
+ right: children[2],
251
+ });
252
+ }
253
+ for (const ex of ((_c = mp.findDirectExpression(Expressions.ParameterListExceptions)) === null || _c === void 0 ? void 0 : _c.getChildren()) || []) {
254
+ const children = ex.getChildren();
255
+ if (children.length < 3) {
256
+ continue; // unexpected
257
+ }
258
+ parameters.push({
259
+ left: children[0],
260
+ eq: children[1].getFirstToken().getStart(),
261
+ right: children[2],
262
+ });
263
+ }
264
+ }
265
+ if (parameters.length > 0) {
266
+ candidates.push({ parameters });
267
+ }
268
+ }
269
+ return candidates;
270
+ }
81
271
  functionParameterCandidates(stru) {
82
272
  const candidates = [];
83
273
  for (const fp of stru.findAllExpressionsRecursive(Expressions.FunctionParameters)) {
@@ -20,14 +20,14 @@ class AmbiguousStatement extends _abap_rule_1.ABAPRule {
20
20
  return {
21
21
  key: "ambiguous_statement",
22
22
  title: "Check for ambigious statements",
23
- shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
24
- Add "TABLE" keyword or "@" for escaping SQL variables
25
-
23
+ shortDescription: `Checks for ambiguity between deleting or modifying from internal and database table
24
+ Add "TABLE" keyword or "@" for escaping SQL variables
25
+
26
26
  Only works if the target version is 740sp05 or above`,
27
27
  tags: [_irule_1.RuleTag.SingleFile],
28
- badExample: `DELETE foo FROM bar.
28
+ badExample: `DELETE foo FROM bar.
29
29
  MODIFY foo FROM bar.`,
30
- goodExample: `DELETE foo FROM @bar.
30
+ goodExample: `DELETE foo FROM @bar.
31
31
  MODIFY TABLE foo FROM bar.`,
32
32
  };
33
33
  }
@@ -35,12 +35,12 @@ class AvoidUse extends _abap_rule_1.ABAPRule {
35
35
  key: "avoid_use",
36
36
  title: "Avoid use of certain statements",
37
37
  shortDescription: `Detects usage of certain statements.`,
38
- extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
39
-
40
- Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
41
-
42
- STATICS: use CLASS-DATA instead
43
-
38
+ extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
39
+
40
+ Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
41
+
42
+ STATICS: use CLASS-DATA instead
43
+
44
44
  DESCRIBE TABLE LINES: use lines() instead (quickfix exists)`,
45
45
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
46
46
  };
@@ -23,11 +23,11 @@ class BeginEndNames extends _abap_rule_1.ABAPRule {
23
23
  title: "Check BEGIN END names",
24
24
  shortDescription: `Check BEGIN OF and END OF names match, plus there must be statements between BEGIN and END`,
25
25
  tags: [_irule_1.RuleTag.Syntax, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
26
- badExample: `DATA: BEGIN OF stru,
27
- field TYPE i,
26
+ badExample: `DATA: BEGIN OF stru,
27
+ field TYPE i,
28
28
  END OF structure_not_the_same.`,
29
- goodExample: `DATA: BEGIN OF stru,
30
- field TYPE i,
29
+ goodExample: `DATA: BEGIN OF stru,
30
+ field TYPE i,
31
31
  END OF stru.`,
32
32
  };
33
33
  }
@@ -21,19 +21,19 @@ class BeginSingleInclude extends _abap_rule_1.ABAPRule {
21
21
  title: "BEGIN contains single INCLUDE",
22
22
  shortDescription: `Finds TYPE BEGIN with just one INCLUDE TYPE, and DATA with single INCLUDE STRUCTURE`,
23
23
  tags: [_irule_1.RuleTag.SingleFile],
24
- badExample: `TYPES: BEGIN OF dummy1.
25
- INCLUDE TYPE dselc.
26
- TYPES: END OF dummy1.
27
-
28
- DATA BEGIN OF foo.
29
- INCLUDE STRUCTURE syst.
30
- DATA END OF foo.
31
-
32
- STATICS BEGIN OF bar.
33
- INCLUDE STRUCTURE syst.
24
+ badExample: `TYPES: BEGIN OF dummy1.
25
+ INCLUDE TYPE dselc.
26
+ TYPES: END OF dummy1.
27
+
28
+ DATA BEGIN OF foo.
29
+ INCLUDE STRUCTURE syst.
30
+ DATA END OF foo.
31
+
32
+ STATICS BEGIN OF bar.
33
+ INCLUDE STRUCTURE syst.
34
34
  STATICS END OF bar.`,
35
- goodExample: `DATA BEGIN OF foo.
36
- INCLUDE STRUCTURE dselc.
35
+ goodExample: `DATA BEGIN OF foo.
36
+ INCLUDE STRUCTURE dselc.
37
37
  DATA END OF foo.`,
38
38
  };
39
39
  }
@@ -24,9 +24,9 @@ class CallTransactionAuthorityCheck extends _abap_rule_1.ABAPRule {
24
24
  extendedInformation: `https://docs.abapopenchecks.org/checks/54/`,
25
25
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
26
26
  badExample: `CALL TRANSACTION 'FOO'.`,
27
- goodExample: `TRY.
28
- CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
29
- CATCH cx_sy_authorization_error.
27
+ goodExample: `TRY.
28
+ CALL TRANSACTION 'FOO' WITH AUTHORITY-CHECK.
29
+ CATCH cx_sy_authorization_error.
30
30
  ENDTRY.`,
31
31
  };
32
32
  }
@@ -45,10 +45,10 @@ class ChainMainlyDeclarations extends _abap_rule_1.ABAPRule {
45
45
  key: "chain_mainly_declarations",
46
46
  title: "Chain mainly declarations",
47
47
  shortDescription: `Chain mainly declarations, allows chaining for the configured statements, reports errors for other statements.`,
48
- extendedInformation: `
49
- https://docs.abapopenchecks.org/checks/23/
50
-
51
- https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
48
+ extendedInformation: `
49
+ https://docs.abapopenchecks.org/checks/23/
50
+
51
+ https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
52
52
  `,
53
53
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
54
54
  badExample: `CALL METHOD: bar.`,
@@ -23,8 +23,8 @@ class CheckAbstract extends _abap_rule_1.ABAPRule {
23
23
  return {
24
24
  key: "check_abstract",
25
25
  title: "Check abstract methods and classes",
26
- shortDescription: `Checks abstract methods and classes:
27
- - class defined as abstract and final,
26
+ shortDescription: `Checks abstract methods and classes:
27
+ - class defined as abstract and final,
28
28
  - non-abstract class contains abstract methods`,
29
29
  extendedInformation: `If a class defines only constants, use an interface instead`,
30
30
  tags: [_irule_1.RuleTag.SingleFile],
@@ -27,9 +27,9 @@ class CheckComments extends _abap_rule_1.ABAPRule {
27
27
  return {
28
28
  key: "check_comments",
29
29
  title: "Check Comments",
30
- shortDescription: `
31
- Various checks for comment usage.
32
-
30
+ shortDescription: `
31
+ Various checks for comment usage.
32
+
33
33
  * End of line comments. Comments starting with "#EC" or "##" are ignored`,
34
34
  extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#put-comments-before-the-statement-they-relate-to`,
35
35
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
@@ -17,9 +17,9 @@ class CheckInclude {
17
17
  key: "check_include",
18
18
  title: "Check INCLUDEs",
19
19
  shortDescription: `Checks INCLUDE statements`,
20
- extendedInformation: `
21
- * Reports unused includes
22
- * Errors if the includes are not found
20
+ extendedInformation: `
21
+ * Reports unused includes
22
+ * Errors if the includes are not found
23
23
  * Error if including a main program`,
24
24
  tags: [_irule_1.RuleTag.Syntax],
25
25
  };
@@ -21,15 +21,15 @@ class CheckNoHandlerPragma extends _abap_rule_1.ABAPRule {
21
21
  title: "Check if NO_HANDLER can be removed",
22
22
  shortDescription: `Checks NO_HANDLER pragmas that can be removed`,
23
23
  tags: [_irule_1.RuleTag.SingleFile],
24
- badExample: `TRY.
25
- ...
26
- CATCH zcx_abapgit_exception ##NO_HANDLER.
27
- RETURN. " it has a handler
24
+ badExample: `TRY.
25
+ ...
26
+ CATCH zcx_abapgit_exception ##NO_HANDLER.
27
+ RETURN. " it has a handler
28
28
  ENDTRY.`,
29
- goodExample: `TRY.
30
- ...
31
- CATCH zcx_abapgit_exception.
32
- RETURN.
29
+ goodExample: `TRY.
30
+ ...
31
+ CATCH zcx_abapgit_exception.
32
+ RETURN.
33
33
  ENDTRY.`,
34
34
  };
35
35
  }
@@ -34,14 +34,14 @@ class CheckSubrc extends _abap_rule_1.ABAPRule {
34
34
  key: "check_subrc",
35
35
  title: "Check sy-subrc",
36
36
  shortDescription: `Check sy-subrc`,
37
- extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
38
-
39
- If sy-dbcnt is checked after database statements, it is considered okay.
40
-
41
- "SELECT SINGLE @abap_true FROM " is considered as an existence check
42
-
43
- If IS ASSIGNED is checked after assigning, it is considered okay.
44
-
37
+ extendedInformation: `Pseudo comment "#EC CI_SUBRC can be added to suppress findings
38
+
39
+ If sy-dbcnt is checked after database statements, it is considered okay.
40
+
41
+ "SELECT SINGLE @abap_true FROM " is considered as an existence check
42
+
43
+ If IS ASSIGNED is checked after assigning, it is considered okay.
44
+
45
45
  FIND statement with MATCH COUNT is considered okay if subrc is not checked`,
46
46
  tags: [_irule_1.RuleTag.SingleFile],
47
47
  pseudoComment: "EC CI_SUBRC",
@@ -30,7 +30,7 @@ class CommentedCode extends _abap_rule_1.ABAPRule {
30
30
  key: "commented_code",
31
31
  title: "Find commented code",
32
32
  shortDescription: `Detects usage of commented out code.`,
33
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
33
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
34
34
  https://docs.abapopenchecks.org/checks/14/`,
35
35
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
36
36
  };
@@ -18,10 +18,10 @@ class ConstructorVisibilityPublic {
18
18
  key: "constructor_visibility_public",
19
19
  title: "Check constructor visibility is public",
20
20
  shortDescription: `Constructor must be placed in the public section, even if the class is not CREATE PUBLIC.`,
21
- extendedInformation: `
22
- This only applies to global classes.
23
-
24
- https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
21
+ extendedInformation: `
22
+ This only applies to global classes.
23
+
24
+ https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#if-your-global-class-is-create-private-leave-the-constructor-public
25
25
  https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abeninstance_constructor_guidl.htm`,
26
26
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
27
27
  };