@abaplint/core 2.82.13 → 2.82.17

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 (85) hide show
  1. package/README.md +6 -6
  2. package/build/abaplint.d.ts +13 -18
  3. package/build/src/abap/5_syntax/statements/get_badi.js +1 -1
  4. package/build/src/abap/5_syntax/structures/type_enum.js +2 -1
  5. package/build/src/abap/flow/flow_graph.js +7 -7
  6. package/build/src/ddic.js +2 -2
  7. package/build/src/lsp/help.js +7 -7
  8. package/build/src/objects/concepts_of_package.js +1 -0
  9. package/build/src/objects/data_element.js +6 -1
  10. package/build/src/objects/domain.js +2 -2
  11. package/build/src/objects/namespace.js +1 -0
  12. package/build/src/objects/table.js +1 -1
  13. package/build/src/objects/web_mime.js +1 -0
  14. package/build/src/registry.js +1 -1
  15. package/build/src/rules/abapdoc.js +1 -1
  16. package/build/src/rules/align_parameters.js +33 -33
  17. package/build/src/rules/allowed_object_naming.js +6 -5
  18. package/build/src/rules/ambiguous_statement.js +5 -5
  19. package/build/src/rules/avoid_use.js +6 -6
  20. package/build/src/rules/begin_end_names.js +4 -4
  21. package/build/src/rules/begin_single_include.js +12 -12
  22. package/build/src/rules/call_transaction_authority_check.js +3 -3
  23. package/build/src/rules/chain_mainly_declarations.js +4 -4
  24. package/build/src/rules/check_abstract.js +2 -2
  25. package/build/src/rules/check_comments.js +3 -3
  26. package/build/src/rules/check_include.js +3 -3
  27. package/build/src/rules/check_no_handler_pragma.js +8 -8
  28. package/build/src/rules/check_subrc.js +8 -8
  29. package/build/src/rules/commented_code.js +1 -1
  30. package/build/src/rules/constructor_visibility_public.js +4 -4
  31. package/build/src/rules/contains_tab.js +2 -2
  32. package/build/src/rules/dangerous_statement.js +1 -1
  33. package/build/src/rules/downport.js +35 -35
  34. package/build/src/rules/exit_or_check.js +3 -3
  35. package/build/src/rules/exporting.js +1 -1
  36. package/build/src/rules/forbidden_identifier.js +1 -1
  37. package/build/src/rules/forbidden_void_type.js +2 -2
  38. package/build/src/rules/functional_writing.js +17 -17
  39. package/build/src/rules/global_class.js +10 -10
  40. package/build/src/rules/identical_conditions.js +2 -2
  41. package/build/src/rules/identical_contents.js +15 -15
  42. package/build/src/rules/identical_descriptions.js +4 -4
  43. package/build/src/rules/if_in_if.js +7 -7
  44. package/build/src/rules/implement_methods.js +8 -3
  45. package/build/src/rules/in_statement_indentation.js +11 -11
  46. package/build/src/rules/intf_referencing_clas.js +3 -3
  47. package/build/src/rules/line_break_style.js +2 -2
  48. package/build/src/rules/line_length.js +1 -1
  49. package/build/src/rules/line_only_punc.js +1 -1
  50. package/build/src/rules/local_variable_names.js +2 -2
  51. package/build/src/rules/many_parentheses.js +10 -10
  52. package/build/src/rules/max_one_method_parameter_per_line.js +7 -7
  53. package/build/src/rules/max_one_statement.js +3 -3
  54. package/build/src/rules/nesting.js +1 -1
  55. package/build/src/rules/no_chained_assignment.js +1 -1
  56. package/build/src/rules/no_public_attributes.js +1 -1
  57. package/build/src/rules/no_yoda_conditions.js +4 -4
  58. package/build/src/rules/obsolete_statement.js +48 -37
  59. package/build/src/rules/omit_parameter_name.js +3 -3
  60. package/build/src/rules/omit_receiving.js +13 -13
  61. package/build/src/rules/parser_702_chaining.js +2 -2
  62. package/build/src/rules/parser_error.js +2 -2
  63. package/build/src/rules/parser_missing_space.js +1 -1
  64. package/build/src/rules/prefer_inline.js +16 -16
  65. package/build/src/rules/prefer_is_not.js +7 -7
  66. package/build/src/rules/prefer_raise_exception_new.js +3 -3
  67. package/build/src/rules/prefer_returning_to_exporting.js +1 -1
  68. package/build/src/rules/prefer_xsdbool.js +2 -2
  69. package/build/src/rules/remove_descriptions.js +4 -4
  70. package/build/src/rules/rfc_error_handling.js +9 -9
  71. package/build/src/rules/select_add_order_by.js +5 -5
  72. package/build/src/rules/select_performance.js +2 -2
  73. package/build/src/rules/sicf_consistency.js +4 -4
  74. package/build/src/rules/space_before_dot.js +2 -2
  75. package/build/src/rules/start_at_tab.js +1 -1
  76. package/build/src/rules/sy_modification.js +2 -2
  77. package/build/src/rules/tabl_enhancement_category.js +2 -2
  78. package/build/src/rules/unnecessary_chaining.js +15 -5
  79. package/build/src/rules/unused_methods.js +9 -9
  80. package/build/src/rules/unused_variables.js +6 -6
  81. package/build/src/rules/use_bool_expression.js +8 -8
  82. package/build/src/rules/use_line_exists.js +6 -6
  83. package/build/src/rules/use_new.js +2 -2
  84. package/build/src/rules/when_others_last.js +6 -6
  85. package/package.json +66 -66
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
- # @abaplint/core
2
-
3
- [abaplint](https://abaplint.org/) core library
4
-
5
- Exposes 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
@@ -879,10 +879,7 @@ declare class ConcatenatedConstant extends Expression {
879
879
 
880
880
  declare class ConceptsOfPackage extends AbstractObject {
881
881
  getType(): string;
882
- getAllowedNaming(): {
883
- maxLength: number;
884
- allowNamespace: boolean;
885
- };
882
+ getAllowedNaming(): IAllowedNaming;
886
883
  getDescription(): string | undefined;
887
884
  }
888
885
 
@@ -1142,6 +1139,7 @@ declare class DataElement extends AbstractObject {
1142
1139
  allowNamespace: boolean;
1143
1140
  };
1144
1141
  setDirty(): void;
1142
+ getDomainName(): string | undefined;
1145
1143
  parseType(reg: IRegistry): AbstractType;
1146
1144
  parse(): {
1147
1145
  updated: boolean;
@@ -1180,7 +1178,7 @@ declare class DDIC {
1180
1178
  lookupNoVoid(name: string): ILookupResult | undefined;
1181
1179
  /** lookup with voiding and unknown types */
1182
1180
  lookup(name: string): ILookupResult;
1183
- lookupDomain(name: string): ILookupResult;
1181
+ lookupDomain(name: string, parent?: string): ILookupResult;
1184
1182
  lookupDataElement(name: string | undefined): ILookupResult;
1185
1183
  lookupTableOrView(name: string | undefined): ILookupResult;
1186
1184
  lookupTableOrView2(name: string | undefined): Table | DataDefinition | View | undefined;
@@ -1361,7 +1359,7 @@ declare class Domain extends AbstractObject {
1361
1359
  allowNamespace: boolean;
1362
1360
  };
1363
1361
  setDirty(): void;
1364
- parseType(reg: IRegistry): AbstractType;
1362
+ parseType(reg: IRegistry, parent?: string): AbstractType;
1365
1363
  parse(): {
1366
1364
  updated: boolean;
1367
1365
  runtime: number;
@@ -2347,12 +2345,15 @@ declare interface IAliases {
2347
2345
  getAll(): readonly Alias[];
2348
2346
  }
2349
2347
 
2348
+ declare interface IAllowedNaming {
2349
+ maxLength: number;
2350
+ allowNamespace: boolean;
2351
+ customRegex?: RegExp;
2352
+ }
2353
+
2350
2354
  declare interface IArtifact {
2351
2355
  getType(): string;
2352
- getAllowedNaming(): {
2353
- maxLength: number;
2354
- allowNamespace: boolean;
2355
- };
2356
+ getAllowedNaming(): IAllowedNaming;
2356
2357
  }
2357
2358
 
2358
2359
  declare interface IAttributes {
@@ -3608,10 +3609,7 @@ declare class Multiply implements IStatement {
3608
3609
 
3609
3610
  declare class Namespace extends AbstractObject {
3610
3611
  getType(): string;
3611
- getAllowedNaming(): {
3612
- maxLength: number;
3613
- allowNamespace: boolean;
3614
- };
3612
+ getAllowedNaming(): IAllowedNaming;
3615
3613
  getDescription(): string | undefined;
3616
3614
  }
3617
3615
 
@@ -5911,10 +5909,7 @@ declare class WebDynproComponentConfiguration extends AbstractObject {
5911
5909
 
5912
5910
  declare class WebMIME extends AbstractObject {
5913
5911
  getType(): string;
5914
- getAllowedNaming(): {
5915
- maxLength: number;
5916
- allowNamespace: boolean;
5917
- };
5912
+ getAllowedNaming(): IAllowedNaming;
5918
5913
  getDescription(): string | undefined;
5919
5914
  }
5920
5915
 
@@ -7,7 +7,7 @@ const target_1 = require("../expressions/target");
7
7
  const dynamic_1 = require("../expressions/dynamic");
8
8
  class GetBadi {
9
9
  runSyntax(node, scope, filename) {
10
- for (const s of node.findDirectExpressions(Expressions.Source)) {
10
+ for (const s of node.findAllExpressions(Expressions.Source)) {
11
11
  new source_1.Source().runSyntax(s, scope, filename);
12
12
  }
13
13
  for (const t of node.findDirectExpressions(Expressions.Target)) {
@@ -11,7 +11,7 @@ const enum_type_1 = require("../../types/basic/enum_type");
11
11
  class TypeEnum {
12
12
  runSyntax(node, scope, filename) {
13
13
  var _a;
14
- const values = [];
14
+ let values = [];
15
15
  const types = [];
16
16
  if (!(node.get() instanceof Structures.TypeEnum)) {
17
17
  throw new Error("TypeEnum, unexpected type");
@@ -61,6 +61,7 @@ class TypeEnum {
61
61
  type: r.getType(),
62
62
  });
63
63
  }
64
+ values = [];
64
65
  const id = new _typed_identifier_1.TypedIdentifier(stru.getFirstToken(), filename, new basic_1.StructureType(components), ["enum" /* Enum */]);
65
66
  values.push(id);
66
67
  }
@@ -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/ddic.js CHANGED
@@ -185,10 +185,10 @@ class DDIC {
185
185
  return { type: new Types.VoidType(name) };
186
186
  }
187
187
  }
188
- lookupDomain(name) {
188
+ lookupDomain(name, parent) {
189
189
  const found = this.reg.getObject("DOMA", name);
190
190
  if (found) {
191
- return { type: found.parseType(this.reg), object: found };
191
+ return { type: found.parseType(this.reg, parent), object: found };
192
192
  }
193
193
  else if (this.reg.inErrorNamespace(name)) {
194
194
  return { type: new Types.UnknownType(name + ", lookupDomain"), object: undefined };
@@ -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) + ", " +
@@ -10,6 +10,7 @@ class ConceptsOfPackage extends _abstract_object_1.AbstractObject {
10
10
  return {
11
11
  maxLength: 30,
12
12
  allowNamespace: true,
13
+ customRegex: new RegExp(/^(\/[A-Z_\d]{3,8}\/)?[A-Z_-\d<> ]+$/i),
13
14
  };
14
15
  }
15
16
  getDescription() {
@@ -26,6 +26,11 @@ class DataElement extends _abstract_object_1.AbstractObject {
26
26
  this.parsedXML = undefined;
27
27
  super.setDirty();
28
28
  }
29
+ getDomainName() {
30
+ var _a;
31
+ this.parse();
32
+ return (_a = this.parsedXML) === null || _a === void 0 ? void 0 : _a.domname;
33
+ }
29
34
  parseType(reg) {
30
35
  const references = [];
31
36
  let lookup = undefined;
@@ -39,7 +44,7 @@ class DataElement extends _abstract_object_1.AbstractObject {
39
44
  lookup = { type: new Types.UnknownType("DOMNAME unexpectely empty in " + this.getName()) };
40
45
  }
41
46
  else {
42
- lookup = ddic.lookupDomain(this.parsedXML.domname);
47
+ lookup = ddic.lookupDomain(this.parsedXML.domname, this.getName());
43
48
  }
44
49
  }
45
50
  else if (this.parsedXML.refkind === "R") {
@@ -24,7 +24,7 @@ class Domain extends _abstract_object_1.AbstractObject {
24
24
  this.parsedType = undefined;
25
25
  super.setDirty();
26
26
  }
27
- parseType(reg) {
27
+ parseType(reg, parent) {
28
28
  if (this.parsedType) {
29
29
  return this.parsedType;
30
30
  }
@@ -32,7 +32,7 @@ class Domain extends _abstract_object_1.AbstractObject {
32
32
  return new Types.UnknownType("Domain " + this.getName() + " parser error", this.getName());
33
33
  }
34
34
  const ddic = new ddic_1.DDIC(reg);
35
- this.parsedType = ddic.textToType(this.parsedXML.datatype, this.parsedXML.length, this.parsedXML.decimals, this.getName());
35
+ this.parsedType = ddic.textToType(this.parsedXML.datatype, this.parsedXML.length, this.parsedXML.decimals, parent || this.getName(), parent !== undefined);
36
36
  return this.parsedType;
37
37
  }
38
38
  parse() {
@@ -10,6 +10,7 @@ class Namespace extends _abstract_object_1.AbstractObject {
10
10
  return {
11
11
  maxLength: 10,
12
12
  allowNamespace: true,
13
+ customRegex: new RegExp(/^\/[A-Z_\d]{3,8}\/$/i),
13
14
  };
14
15
  }
15
16
  getDescription() {
@@ -175,7 +175,7 @@ class Table extends _abstract_object_1.AbstractObject {
175
175
  const length = field.LENG ? field.LENG : field.INTLEN;
176
176
  components.push({
177
177
  name: field.FIELDNAME,
178
- type: ddic.textToType(datatype, length, field.DECIMALS, this.getName())
178
+ type: ddic.textToType(datatype, length, field.DECIMALS, this.getName() + "-" + field.FIELDNAME)
179
179
  });
180
180
  }
181
181
  else {
@@ -10,6 +10,7 @@ class WebMIME extends _abstract_object_1.AbstractObject {
10
10
  return {
11
11
  maxLength: 40,
12
12
  allowNamespace: true,
13
+ customRegex: new RegExp(/^[A-Z_-\d/<> ]+$/i),
13
14
  };
14
15
  }
15
16
  getDescription() {
@@ -68,7 +68,7 @@ class Registry {
68
68
  }
69
69
  static abaplintVersion() {
70
70
  // magic, see build script "version.sh"
71
- return "2.82.13";
71
+ return "2.82.17";
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
  };
@@ -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
  }
@@ -30,19 +30,20 @@ class AllowedObjectNaming {
30
30
  }
31
31
  run(obj) {
32
32
  const allowed = obj.getAllowedNaming();
33
+ const name = obj.getName();
33
34
  let message = "";
34
- if (obj.getName().length > allowed.maxLength) {
35
+ if (name.length > allowed.maxLength) {
35
36
  message = "Name exceeds max length";
36
37
  }
37
- else if (allowed.allowNamespace === false && obj.getName().indexOf("/") >= 0) {
38
+ else if (allowed.allowNamespace === false && name.indexOf("/") >= 0) {
38
39
  message = "Namespace not allowed for object type";
39
40
  }
40
- else if (obj.getType() === "NSPC") {
41
- if (obj.getName().match(/^\/[A-Z_\d]{3,8}\/$/i) === null) {
41
+ else if (allowed.customRegex !== undefined) {
42
+ if (name.match(allowed.customRegex) === null) {
42
43
  message = "Name not allowed";
43
44
  }
44
45
  }
45
- else if (obj.getName().match(/^(\/[A-Z_\d]{3,8}\/)?[A-Z_-\d<> ]+$/i) === null) {
46
+ else if (name.match(/^(\/[A-Z_\d]{3,8}\/)?[A-Z_\d<> ]+$/i) === null) {
46
47
  message = "Name not allowed";
47
48
  }
48
49
  if (message.length > 0) {
@@ -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
  };
@@ -25,8 +25,8 @@ class ContainsTab extends _abap_rule_1.ABAPRule {
25
25
  key: "contains_tab",
26
26
  title: "Code contains tab",
27
27
  shortDescription: `Checks for usage of tabs (enable to enforce spaces)`,
28
- extendedInformation: `
29
- https://docs.abapopenchecks.org/checks/09/
28
+ extendedInformation: `
29
+ https://docs.abapopenchecks.org/checks/09/
30
30
  https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#indent-and-snap-to-tab`,
31
31
  tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
32
32
  };
@@ -40,7 +40,7 @@ class DangerousStatement extends _abap_rule_1.ABAPRule {
40
40
  key: "dangerous_statement",
41
41
  title: "Dangerous statement",
42
42
  shortDescription: `Detects potentially dangerous statements`,
43
- extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
43
+ extendedInformation: `Dynamic SQL: Typically ABAP logic does not need dynamic SQL,
44
44
  dynamic SQL can potentially create SQL injection problems`,
45
45
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Security],
46
46
  };