@abaplint/core 2.94.6 → 2.94.8

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 (90) hide show
  1. package/README.md +6 -6
  2. package/adhoc/lexer_performance.ts +16 -16
  3. package/build/abaplint.d.ts +3 -3
  4. package/build/src/abap/flow/flow_graph.js +7 -7
  5. package/build/src/index.js +3 -1
  6. package/build/src/lsp/help.js +7 -7
  7. package/build/src/objects/table.js +1 -1
  8. package/build/src/registry.js +1 -1
  9. package/build/src/rules/7bit_ascii.js +2 -2
  10. package/build/src/rules/abapdoc.js +3 -3
  11. package/build/src/rules/align_parameters.js +39 -39
  12. package/build/src/rules/ambiguous_statement.js +5 -5
  13. package/build/src/rules/avoid_use.js +8 -8
  14. package/build/src/rules/begin_end_names.js +4 -4
  15. package/build/src/rules/begin_single_include.js +12 -12
  16. package/build/src/rules/call_transaction_authority_check.js +3 -3
  17. package/build/src/rules/cds_comment_style.js +4 -4
  18. package/build/src/rules/cds_legacy_view.js +4 -4
  19. package/build/src/rules/chain_mainly_declarations.js +4 -4
  20. package/build/src/rules/change_if_to_case.js +8 -8
  21. package/build/src/rules/check_abstract.js +2 -2
  22. package/build/src/rules/check_comments.js +4 -4
  23. package/build/src/rules/check_include.js +3 -3
  24. package/build/src/rules/check_subrc.js +8 -8
  25. package/build/src/rules/classic_exceptions_overlap.js +8 -8
  26. package/build/src/rules/commented_code.js +1 -1
  27. package/build/src/rules/constructor_visibility_public.js +4 -4
  28. package/build/src/rules/contains_tab.js +2 -2
  29. package/build/src/rules/cyclic_oo.js +2 -2
  30. package/build/src/rules/dangerous_statement.js +1 -1
  31. package/build/src/rules/definitions_top.js +2 -2
  32. package/build/src/rules/downport.js +83 -83
  33. package/build/src/rules/exit_or_check.js +3 -3
  34. package/build/src/rules/exporting.js +1 -1
  35. package/build/src/rules/forbidden_identifier.js +1 -1
  36. package/build/src/rules/forbidden_void_type.js +2 -2
  37. package/build/src/rules/functional_writing.js +17 -17
  38. package/build/src/rules/global_class.js +8 -8
  39. package/build/src/rules/identical_conditions.js +2 -2
  40. package/build/src/rules/identical_contents.js +14 -14
  41. package/build/src/rules/identical_descriptions.js +6 -6
  42. package/build/src/rules/if_in_if.js +26 -26
  43. package/build/src/rules/implement_methods.js +3 -3
  44. package/build/src/rules/in_statement_indentation.js +11 -11
  45. package/build/src/rules/intf_referencing_clas.js +3 -3
  46. package/build/src/rules/line_break_style.js +2 -2
  47. package/build/src/rules/line_length.js +1 -1
  48. package/build/src/rules/line_only_punc.js +1 -1
  49. package/build/src/rules/local_variable_names.js +2 -2
  50. package/build/src/rules/main_file_contents.js +4 -4
  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 +5 -5
  54. package/build/src/rules/method_overwrites_builtin.js +2 -2
  55. package/build/src/rules/nesting.js +1 -1
  56. package/build/src/rules/no_chained_assignment.js +1 -1
  57. package/build/src/rules/no_external_form_calls.js +2 -2
  58. package/build/src/rules/no_inline_in_optional_branches.js +11 -11
  59. package/build/src/rules/no_public_attributes.js +1 -1
  60. package/build/src/rules/no_yoda_conditions.js +4 -4
  61. package/build/src/rules/nrob_consistency.js +2 -2
  62. package/build/src/rules/obsolete_statement.js +42 -42
  63. package/build/src/rules/omit_parameter_name.js +3 -3
  64. package/build/src/rules/omit_receiving.js +13 -13
  65. package/build/src/rules/parser_702_chaining.js +2 -2
  66. package/build/src/rules/parser_error.js +2 -2
  67. package/build/src/rules/parser_missing_space.js +1 -1
  68. package/build/src/rules/prefer_inline.js +16 -16
  69. package/build/src/rules/prefer_is_not.js +7 -7
  70. package/build/src/rules/prefer_raise_exception_new.js +3 -3
  71. package/build/src/rules/prefer_returning_to_exporting.js +1 -1
  72. package/build/src/rules/prefer_xsdbool.js +2 -2
  73. package/build/src/rules/remove_descriptions.js +4 -4
  74. package/build/src/rules/rfc_error_handling.js +9 -9
  75. package/build/src/rules/select_add_order_by.js +5 -5
  76. package/build/src/rules/select_performance.js +5 -5
  77. package/build/src/rules/sicf_consistency.js +2 -2
  78. package/build/src/rules/space_before_dot.js +2 -2
  79. package/build/src/rules/start_at_tab.js +1 -1
  80. package/build/src/rules/sy_modification.js +4 -4
  81. package/build/src/rules/tabl_enhancement_category.js +2 -2
  82. package/build/src/rules/unnecessary_pragma.js +22 -22
  83. package/build/src/rules/unnecessary_return.js +5 -5
  84. package/build/src/rules/unused_methods.js +9 -9
  85. package/build/src/rules/unused_variables.js +4 -4
  86. package/build/src/rules/use_bool_expression.js +8 -8
  87. package/build/src/rules/use_line_exists.js +6 -6
  88. package/build/src/rules/use_new.js +4 -4
  89. package/build/src/rules/when_others_last.js +6 -6
  90. 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 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
@@ -1,17 +1,17 @@
1
- import {MemoryFile} from "../src";
2
- import {Lexer} from "../src/abap/1_lexer/lexer";
3
- import * as fs from "fs";
4
-
5
- console.log("========================");
6
- const file = new MemoryFile("abapgit.abap", fs.readFileSync("./lexer_performance.abap", "utf-8"));
7
-
8
- let total = 0;
9
- for (let i = 0; i < 10; i++) {
10
- const before = Date.now();
11
- const result = new Lexer().run(file);
12
- const runtime = Date.now() - before;
13
- console.log("Runtime: " + runtime + "ms");
14
- total += runtime;
15
- console.log("Tokens: " + result.tokens.length);
16
- }
1
+ import {MemoryFile} from "../src";
2
+ import {Lexer} from "../src/abap/1_lexer/lexer";
3
+ import * as fs from "fs";
4
+
5
+ console.log("========================");
6
+ const file = new MemoryFile("abapgit.abap", fs.readFileSync("./lexer_performance.abap", "utf-8"));
7
+
8
+ let total = 0;
9
+ for (let i = 0; i < 10; i++) {
10
+ const before = Date.now();
11
+ const result = new Lexer().run(file);
12
+ const runtime = Date.now() - before;
13
+ console.log("Runtime: " + runtime + "ms");
14
+ total += runtime;
15
+ console.log("Tokens: " + result.tokens.length);
16
+ }
17
17
  console.log("Total: " + total);
@@ -3564,11 +3564,11 @@ declare interface ISyntaxSettings {
3564
3564
  version?: Version;
3565
3565
  /** Report error for objects in this regex namespace. Types not in namespace will be void. Case insensitive */
3566
3566
  errorNamespace: string;
3567
- /** List of full named global constants
3567
+ /** List of full named global constants (regex not possible)
3568
3568
  * @uniqueItems true
3569
3569
  */
3570
3570
  globalConstants?: string[];
3571
- /** List of full named global macros
3571
+ /** List of full named global macros (regex not possible)
3572
3572
  * @uniqueItems true
3573
3573
  */
3574
3574
  globalMacros?: string[];
@@ -4746,7 +4746,7 @@ export declare class RulesRunner {
4746
4746
  excludeIssues(issues: Issue[]): Issue[];
4747
4747
  }
4748
4748
 
4749
- declare enum RuleTag {
4749
+ export declare enum RuleTag {
4750
4750
  Experimental = "Experimental",
4751
4751
  DeprecationCandidate = "DeprecationCandidate",
4752
4752
  Upport = "Upport",
@@ -84,13 +84,13 @@ class FlowGraph {
84
84
  this.label = label;
85
85
  }
86
86
  toDigraph() {
87
- return `digraph G {
88
- labelloc="t";
89
- label="${this.label}";
90
- graph [fontname = "helvetica"];
91
- node [fontname = "helvetica", shape="box"];
92
- edge [fontname = "helvetica"];
93
- ${this.toTextEdges()}
87
+ return `digraph G {
88
+ labelloc="t";
89
+ label="${this.label}";
90
+ graph [fontname = "helvetica"];
91
+ node [fontname = "helvetica", shape="box"];
92
+ edge [fontname = "helvetica"];
93
+ ${this.toTextEdges()}
94
94
  }`;
95
95
  }
96
96
  listSources(node) {
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Severity = exports.Visibility = exports.Info = exports.Rename = exports.PrettyPrinter = exports.Position = exports.CurrentScope = exports.ABAPFile = exports.RulesRunner = exports.SpaghettiScope = exports.SyntaxLogic = exports.ABAPObject = exports.Tokens = exports.ExpressionsCDS = exports.CDSParser = exports.LanguageServerTypes = exports.DDLParser = exports.applyEditList = exports.applyEditSingle = exports.SpaghettiScopeNode = exports.AbstractFile = exports.Token = exports.ScopeType = exports.BasicTypes = exports.TypedIdentifier = exports.AbstractType = exports.VirtualPosition = exports.Comment = exports.Unknown = exports.Empty = exports.Identifier = exports.Nodes = exports.Types = exports.Expressions = exports.Statements = exports.Structures = exports.Objects = exports.ArtifactsRules = exports.ArtifactsObjects = exports.ArtifactsABAP = exports.BuiltIn = exports.MethodLengthStats = exports.LanguageServer = exports.Registry = exports.ReferenceType = exports.Version = exports.Config = exports.Issue = exports.MemoryFile = void 0;
3
+ exports.RuleTag = exports.Severity = exports.Visibility = exports.Info = exports.Rename = exports.PrettyPrinter = exports.Position = exports.CurrentScope = exports.ABAPFile = exports.RulesRunner = exports.SpaghettiScope = exports.SyntaxLogic = exports.ABAPObject = exports.Tokens = exports.ExpressionsCDS = exports.CDSParser = exports.LanguageServerTypes = exports.DDLParser = exports.applyEditList = exports.applyEditSingle = exports.SpaghettiScopeNode = exports.AbstractFile = exports.Token = exports.ScopeType = exports.BasicTypes = exports.TypedIdentifier = exports.AbstractType = exports.VirtualPosition = exports.Comment = exports.Unknown = exports.Empty = exports.Identifier = exports.Nodes = exports.Types = exports.Expressions = exports.Statements = exports.Structures = exports.Objects = exports.ArtifactsRules = exports.ArtifactsObjects = exports.ArtifactsABAP = exports.BuiltIn = exports.MethodLengthStats = exports.LanguageServer = exports.Registry = exports.ReferenceType = exports.Version = exports.Config = exports.Issue = exports.MemoryFile = void 0;
4
4
  const issue_1 = require("./issue");
5
5
  Object.defineProperty(exports, "Issue", { enumerable: true, get: function () { return issue_1.Issue; } });
6
6
  const config_1 = require("./config");
@@ -94,4 +94,6 @@ const cds_parser_1 = require("./cds/cds_parser");
94
94
  Object.defineProperty(exports, "CDSParser", { enumerable: true, get: function () { return cds_parser_1.CDSParser; } });
95
95
  const rules_runner_1 = require("./rules_runner");
96
96
  Object.defineProperty(exports, "RulesRunner", { enumerable: true, get: function () { return rules_runner_1.RulesRunner; } });
97
+ const _irule_1 = require("./rules/_irule");
98
+ Object.defineProperty(exports, "RuleTag", { enumerable: true, get: function () { return _irule_1.RuleTag; } });
97
99
  //# sourceMappingURL=index.js.map
@@ -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) + ", " +
@@ -121,7 +121,7 @@ class Table extends _abstract_object_1.AbstractObject {
121
121
  }
122
122
  }
123
123
  else if (comptype === "S" && field.FIELDNAME.startsWith(".INCLU-")) {
124
- const lookup = ddic.lookupTableOrView(field.ROLLNAME);
124
+ const lookup = ddic.lookupTableOrView(field.PRECFIELD);
125
125
  if (lookup.object) {
126
126
  references.push({ object: lookup.object });
127
127
  }
@@ -63,7 +63,7 @@ class Registry {
63
63
  }
64
64
  static abaplintVersion() {
65
65
  // magic, see build script "version.sh"
66
- return "2.94.6";
66
+ return "2.94.8";
67
67
  }
68
68
  getDDICReferences() {
69
69
  return this.references;
@@ -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
  };
@@ -25,9 +25,9 @@ class Abapdoc extends _abap_rule_1.ABAPRule {
25
25
  return {
26
26
  key: "abapdoc",
27
27
  title: "Check abapdoc",
28
- shortDescription: `Various checks regarding abapdoc.
29
- Base rule checks for existence of abapdoc for public class methods and all interface methods.
30
-
28
+ shortDescription: `Various checks regarding abapdoc.
29
+ Base rule checks for existence of abapdoc for public class methods and all interface methods.
30
+
31
31
  Plus class and interface definitions.`,
32
32
  tags: [_irule_1.RuleTag.SingleFile],
33
33
  };
@@ -20,48 +20,48 @@ 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
59
- moo = 2 ).
60
-
61
- DATA(sdf) = VALUE type(
62
- common_val = 2
63
- another_common = 5
64
- ( row_value = 4
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 ).
60
+
61
+ DATA(sdf) = VALUE type(
62
+ common_val = 2
63
+ another_common = 5
64
+ ( row_value = 4
65
65
  value_foo = 5 ) ).`,
66
66
  };
67
67
  }
@@ -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
  }
@@ -39,14 +39,14 @@ class AvoidUse extends _abap_rule_1.ABAPRule {
39
39
  key: "avoid_use",
40
40
  title: "Avoid use of certain statements",
41
41
  shortDescription: `Detects usage of certain statements.`,
42
- extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
43
-
44
- Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
45
-
46
- STATICS: use CLASS-DATA instead
47
-
48
- DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
49
-
42
+ extendedInformation: `DEFAULT KEY: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key
43
+
44
+ Macros: https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenmacros_guidl.htm
45
+
46
+ STATICS: use CLASS-DATA instead
47
+
48
+ DESCRIBE TABLE LINES: use lines() instead (quickfix exists)
49
+
50
50
  TEST-SEAMS: https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-test-seams-as-temporary-workaround`,
51
51
  tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
52
52
  };
@@ -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
  }
@@ -19,10 +19,10 @@ class CDSCommentStyle {
19
19
  key: "cds_comment_style",
20
20
  title: "CDS Comment Style",
21
21
  shortDescription: `Check for obsolete comment style`,
22
- extendedInformation: `Check for obsolete comment style
23
-
24
- Comments starting with "--" are considered obsolete
25
-
22
+ extendedInformation: `Check for obsolete comment style
23
+
24
+ Comments starting with "--" are considered obsolete
25
+
26
26
  https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-us/abencds_general_syntax_rules.htm`,
27
27
  tags: [_irule_1.RuleTag.SingleFile],
28
28
  badExample: "-- this is a comment",
@@ -19,10 +19,10 @@ class CDSLegacyView {
19
19
  title: "CDS Legacy View",
20
20
  shortDescription: `Identify CDS Legacy Views`,
21
21
  // eslint-disable-next-line max-len
22
- extendedInformation: `Use DEFINE VIEW ENTITY instead of DEFINE VIEW
23
-
24
- https://blogs.sap.com/2021/10/16/a-new-generation-of-cds-views-how-to-migrate-your-cds-views-to-cds-view-entities/
25
-
22
+ extendedInformation: `Use DEFINE VIEW ENTITY instead of DEFINE VIEW
23
+
24
+ https://blogs.sap.com/2021/10/16/a-new-generation-of-cds-views-how-to-migrate-your-cds-views-to-cds-view-entities/
25
+
26
26
  v755 and up`,
27
27
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Upport],
28
28
  };
@@ -45,10 +45,10 @@ class ChainMainlyDeclarations extends _abap_rule_1.ABAPRule {
45
45
  key: "chain_mainly_declarations",
46
46
  title: "Chain mainly declarations",
47
47
  shortDescription: `Chain mainly declarations, allows chaining for the configured statements, reports errors for other statements.`,
48
- extendedInformation: `
49
- https://docs.abapopenchecks.org/checks/23/
50
-
51
- https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
48
+ extendedInformation: `
49
+ https://docs.abapopenchecks.org/checks/23/
50
+
51
+ https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statements_guidl.htm
52
52
  `,
53
53
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
54
54
  badExample: `CALL METHOD: bar.`,
@@ -29,17 +29,17 @@ class ChangeIfToCase extends _abap_rule_1.ABAPRule {
29
29
  title: "Change IF to CASE",
30
30
  shortDescription: `Finds IF constructs that can be changed to CASE`,
31
31
  // eslint-disable-next-line max-len
32
- extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-case-to-else-if-for-multiple-alternative-conditions
33
-
32
+ extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-case-to-else-if-for-multiple-alternative-conditions
33
+
34
34
  If the first comparison is a boolean compare, no issue is reported.`,
35
35
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
36
- badExample: `IF l_fcat-fieldname EQ 'FOO'.
37
- ELSEIF l_fcat-fieldname = 'BAR'
38
- OR l_fcat-fieldname = 'MOO'.
36
+ badExample: `IF l_fcat-fieldname EQ 'FOO'.
37
+ ELSEIF l_fcat-fieldname = 'BAR'
38
+ OR l_fcat-fieldname = 'MOO'.
39
39
  ENDIF.`,
40
- goodExample: `CASE l_fcat-fieldname.
41
- WHEN 'FOO'.
42
- WHEN 'BAR' OR 'MOO'.
40
+ goodExample: `CASE l_fcat-fieldname.
41
+ WHEN 'FOO'.
42
+ WHEN 'BAR' OR 'MOO'.
43
43
  ENDCASE.`,
44
44
  };
45
45
  }
@@ -23,8 +23,8 @@ class CheckAbstract extends _abap_rule_1.ABAPRule {
23
23
  return {
24
24
  key: "check_abstract",
25
25
  title: "Check abstract methods and classes",
26
- shortDescription: `Checks abstract methods and classes:
27
- - class defined as abstract and final,
26
+ shortDescription: `Checks abstract methods and classes:
27
+ - class defined as abstract and final,
28
28
  - non-abstract class contains abstract methods`,
29
29
  extendedInformation: `If a class defines only constants, use an interface instead`,
30
30
  tags: [_irule_1.RuleTag.SingleFile],
@@ -27,11 +27,11 @@ class CheckComments extends _abap_rule_1.ABAPRule {
27
27
  return {
28
28
  key: "check_comments",
29
29
  title: "Check Comments",
30
- shortDescription: `
30
+ shortDescription: `
31
31
  Various checks for comment usage.`,
32
- extendedInformation: `
33
- * 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
  };
@@ -30,8 +30,8 @@ class CyclicOO {
30
30
  key: "cyclic_oo",
31
31
  title: "Cyclic OO",
32
32
  shortDescription: `Finds cyclic OO references`,
33
- extendedInformation: `Runs for global INTF + CLAS objects
34
-
33
+ extendedInformation: `Runs for global INTF + CLAS objects
34
+
35
35
  Objects must be without syntax errors for this rule to take effect`,
36
36
  };
37
37
  }
@@ -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
  };
@@ -30,8 +30,8 @@ class DefinitionsTop extends _abap_rule_1.ABAPRule {
30
30
  key: "definitions_top",
31
31
  title: "Place definitions in top of routine",
32
32
  shortDescription: `Checks that definitions are placed at the beginning of METHODs and FORMs.`,
33
- extendedInformation: `If the routine has inline definitions then no issues are reported
34
-
33
+ extendedInformation: `If the routine has inline definitions then no issues are reported
34
+
35
35
  https://docs.abapopenchecks.org/checks/17/`,
36
36
  tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
37
37
  };