getting_started.md

Getting Started

Install Node, version 16 or above required

vscode with extension abaplint is also recommended

Run npm install @abaplint/cli -g to install the abaplint command line client locally

Run abaplint in a folder to check the contents

A abaplint.json file can be added/adjusted to enable and disable rules, note that vscode knows the json schema for the configuration, so it provides intellisense when editing. Default (all rules) config can be generated with abaplint -d > abaplint.json (run this in the root directory of the code repository).

Starting On-Premise Configuration

Adjust version to your target version, plus if the development is inside a namespace, adjust the errorNamespace accordingly.

Suggest starting by running only the syntax check relevant rules, having this working will help expanding to more rules,

{
  "global": {
    "files": "/src/**/*.*"
  },
  "dependencies": [
    {
      "url": "https://github.com/abaplint/deps",
      "folder": "/deps",
      "files": "/src/**/*.*"
    }
  ],
  "syntax": {
    "version": "v755",
    "errorNamespace": "^(Z|Y|LCL_|TY_|LIF_)"
  },
  "rules": {
    "begin_end_names": true,
    "check_ddic": true,
    "check_include": true,
    "check_syntax": true,
    "global_class": true,
    "implement_methods": true,
    "method_implemented_twice": true,
    "parser_error": true,
    "superclass_final": true,
    "unknown_types": true,
    "xml_consistency": true
  }
}

Steampunk 2302 Syntax Check Configuration

{
  "global": {
    "files": "/src/**/*.*"
  },
  "dependencies": [
    {
      "url": "https://github.com/abapedia/steampunk-2302-api",
      "folder": "/deps",
      "files": "/src/**/*.*"
    }
  ],
  "syntax": {
    "version": "Cloud",
    "errorNamespace": "."
  },
  "rules": {
    "begin_end_names": true,
    "cds_parser_error": true,
    "check_ddic": true,
    "strict_sql": true,
    "sql_escape_host_variables": true,
    "check_include": true,
    "check_syntax": true,
    "global_class": true,
    "implement_methods": true,
    "method_implemented_twice": true,
    "parser_error": true,
    "superclass_final": true,
    "unknown_types": true,
    "xml_consistency": true
  }
}