syntax Command Requirements

Overview

Check syntax of ABAP source files directly WITHOUT pull/activation. Reads source from local files and checks in ABAP system memory.

Key difference from inspect:

  • syntax - Checks LOCAL source code BEFORE commit (no pull needed)
  • inspect - Checks ACTIVATED code AFTER pull (uses Code Inspector)

Auto-detection: When checking any class file (main, locals_def, locals_imp, or testclasses), the command automatically detects and includes ALL companion files for a complete syntax check. When checking any FUGR file for a function group, the command automatically detects and includes ALL FM source files in that group. When checking an INCLUDE program (SUBC=I), the command automatically detects the parent program in the same directory and assembles the source before checking.

Command 

# Check single class file - auto-detects all companions
abapgit-agent syntax --files src/zcl_my_class.clas.abap

# Check test classes - auto-detects main class and local files
abapgit-agent syntax --files src/zcl_my_class.clas.testclasses.abap

# Check local implementations - auto-detects main, locals_def, testclasses
abapgit-agent syntax --files src/zcl_my_class.clas.locals_imp.abap

# Check CDS view
abapgit-agent syntax --files src/zc_my_view.ddls.asddls

# Check INCLUDE program - auto-detects parent program in same directory
abapgit-agent syntax --files src/zmy_include.prog.abap

# Check function group - provide ANY FUGR file, auto-detects all FM source files
abapgit-agent syntax --files src/zmy_fugr.fugr.zmy_my_function.abap

# Check function group via non-FM file - still auto-detects all FM files
abapgit-agent syntax --files src/zmy_fugr.fugr.lzmy_fugrtop.abap

# Check multiple files
abapgit-agent syntax --files src/zcl_my_class.clas.abap,src/zcl_other.clas.abap

# With ABAP Cloud (BTP) stricter rules
abapgit-agent syntax --files src/zcl_my_class.clas.abap --cloud

# Output as JSON
abapgit-agent syntax --files src/zcl_my_class.clas.abap --json

Prerequisite

  • .abapGitAgent exists with valid credentials
  • Files must exist in the filesystem
  • Supported object types: CLAS, INTF, PROG (including INCLUDEs), DDLS, DCLS, FUGR
  • For class files: Companion files are auto-detected if they exist
  • For FUGR files: All FM source files in the function group are auto-detected
  • For INCLUDE programs (SUBC=I): Parent program is auto-detected in the same directory

Parameters

Parameter Required Description
--files Yes Comma-separated list of files to check
--cloud No Use ABAP Cloud syntax check (stricter, for BTP)
--json No Output raw JSON

Tasks

1. Validate Parameters

  • --files must be specified
  • Files must exist

2. Load Configuration

Read .abapGitAgent for credentials

3. Fetch CSRF Token 

GET /health (with X-CSRF-Token: fetch)

4. Read Source Files

Read source code from local filesystem

5. Make Syntax Request

Endpoint: POST /syntax

Request Body:

{
  "objects": [
    {
      "type": "CLAS",
      "name": "ZCL_MY_CLASS",
      "source": "CLASS zcl_my_class DEFINITION...",
      "locals_def": "CLASS lcl_helper DEFINITION...",
      "locals_imp": "CLASS lcl_helper IMPLEMENTATION..."
    }
  ],
  "uccheck": "X"
}

6. Display Results

Output

Success (No Errors) 

  Syntax check for 1 file(s)

✅ CLAS ZCL_MY_CLASS - Syntax check passed

✅ All 1 object(s) passed syntax check

Success with Auto-Detection 

  Syntax check for 1 file(s)

  Auto-detected: zcl_my_class.clas.abap
  Auto-detected: zcl_my_class.clas.locals_def.abap
  Auto-detected: zcl_my_class.clas.locals_imp.abap

✅ CLAS ZCL_MY_CLASS - Syntax check passed

✅ All 1 object(s) passed syntax check

With ABAP Cloud Mode 

  Syntax check for 1 file(s)
  Mode: ABAP Cloud

✅ CLAS ZCL_MY_CLASS - Syntax check passed

✅ All 1 object(s) passed syntax check

With Errors (Single File) 

  Syntax check for 1 file(s)

❌ CLAS ZCL_MY_CLASS - Syntax check failed (1 error(s))

Errors:
────────────────────────────────────────────────────────────
  Line 9:
    The statement "UNKNOWN_STATEMENT" is invalid. Check the spelling.

❌ 1 of 1 object(s) have syntax errors

With Errors (Multiple Files - Shows Which File) 

  Syntax check for 1 file(s)

  Auto-detected: zcl_my_class.clas.abap
  Auto-detected: zcl_my_class.clas.locals_def.abap
  Auto-detected: zcl_my_class.clas.locals_imp.abap

❌ CLAS ZCL_MY_CLASS - Syntax check failed (1 error(s))

Errors:
────────────────────────────────────────────────────────────
  In: Local implementations (zcl_my_class.clas.locals_imp.abap)
  Line 24:
    "." expected after "LV_RESULT".

❌ 1 of 1 object(s) have syntax errors

Multiple Objects with Errors 

  Syntax check for 3 file(s)

❌ CLAS ZCL_CLASS1 - Syntax check failed (1 error(s))

Errors:
────────────────────────────────────────────────────────────
  Line 15:
    Field "LV_UNDEFINED" is unknown.

❌ INTF ZIF_INTERFACE1 - Syntax check failed (1 error(s))

Errors:
────────────────────────────────────────────────────────────
  Line 10:
    Unable to interpret "UNKNOWN_KEYWORD".

✅ PROG ZPROGRAM1 - Syntax check passed

❌ 2 of 3 object(s) have syntax errors

Response Structure 

{
  "SUCCESS": true,
  "COMMAND": "SYNTAX",
  "MESSAGE": "All 1 object(s) passed syntax check",
  "RESULTS": [
    {
      "OBJECT_TYPE": "CLAS",
      "OBJECT_NAME": "ZCL_MY_CLASS",
      "SUCCESS": true,
      "ERROR_COUNT": 0,
      "ERRORS": [],
      "WARNINGS": [],
      "MESSAGE": "Syntax check passed"
    }
  ]
}

With errors (includes file location):

{
  "SUCCESS": false,
  "COMMAND": "SYNTAX",
  "MESSAGE": "1 of 1 object(s) have syntax errors",
  "RESULTS": [
    {
      "OBJECT_TYPE": "CLAS",
      "OBJECT_NAME": "ZCL_MY_CLASS",
      "SUCCESS": false,
      "ERROR_COUNT": 1,
      "ERRORS": [
        {
          "LINE": 24,
          "TEXT": "\".\" expected after \"LV_RESULT\".",
          "WORD": "LV_RESULT",
          "INCLUDE": "locals_imp"
        }
      ],
      "WARNINGS": [],
      "MESSAGE": "\".\" expected after \"LV_RESULT\"."
    }
  ]
}

Key Behaviors

  1. Line numbers match source file - Error line numbers correspond to the actual line in the source file (including remapping for INCLUDE programs)
  2. All companion files auto-detected - When any class file is checked, ALL companion files are automatically included:
    • Main class (.clas.abap)
    • Local definitions (.clas.locals_def.abap)
    • Local implementations (.clas.locals_imp.abap)
    • Test classes (.clas.testclasses.abap)
  3. INCLUDE programs auto-detect parent - When a .prog.abap with SUBC=I is checked, the parent program containing INCLUDE <name>. is found in the same directory and the source is assembled before checking. Errors are remapped to include-relative line numbers.
  4. Error location displayed - Shows exactly which file contains the error (e.g., “In: Local implementations (zcl_my_class.clas.locals_imp.abap)”)
  5. Test classes fully supported - .testclasses.abap files can be checked by providing just the testclasses file
  6. First error only - ABAP’s SYNTAX-CHECK stops at the first error per file
  7. No warnings - Only syntax errors are reported (use inspect for warnings)
  8. No database writes - Source is checked in memory only

Supported Object Types

Type Description File Extension
CLAS Class .clas.abap
CLAS Local definitions .clas.locals_def.abap
CLAS Local implementations .clas.locals_imp.abap
CLAS Test classes .clas.testclasses.abap
INTF Interface .intf.abap
PROG Program (executable) .prog.abap
PROG INCLUDE program .prog.abap (SUBC=I in .prog.xml)
DDLS CDS View .ddls.asddls
DCLS CDS Access Control (role) .dcls.asdcls
FUGR Function module source <group>.fugr.<fm_name>.abap

Note:

  • For class files, ALL companion files are automatically detected and included
  • For FUGR files, ALL FM source files in the function group are automatically detected and checked
  • For INCLUDE programs (SUBC=I), the parent program is auto-detected in the same directory; if no parent is found, a warning is printed and the check is skipped
  • For DDLS: Requires @AbapCatalog.sqlViewName annotation for CDS views
  • For DCLS: Requires the granted-on DDL view to be active (CL_ACM_DCL_HANDLER->CHECK validates entity references). Pull the DDL view first if it isn’t active yet.
  • For other types (TABL, STRU, etc.), use pull then inspect

Auto-Detection

When checking any class file, the command automatically detects and includes ALL companion files:

You Provide Auto-Detects (if exist)
.clas.abap locals_def, locals_imp, testclasses
.clas.locals_def.abap main, locals_imp, testclasses
.clas.locals_imp.abap main, locals_def, testclasses
.clas.testclasses.abap main, locals_def, locals_imp
Any .fugr.*.abap file All FM source files for that function group
.prog.abap (SUBC=I) Parent .prog.abap in same directory containing INCLUDE <name>.

Example:

# You provide only testclasses file
abapgit-agent syntax --files src/zcl_my_class.clas.testclasses.abap

# Command auto-detects and includes:
  Auto-detected: zcl_my_class.clas.abap
  Auto-detected: zcl_my_class.clas.locals_def.abap
  Auto-detected: zcl_my_class.clas.locals_imp.abap

Error Location Display

When errors occur in classes with multiple files, the output shows exactly which file contains the error:

Include Type Display Format
Main class In: Main class (zcl_my_class.clas.abap)
Local definitions In: Local definitions (zcl_my_class.clas.locals_def.abap)
Local implementations In: Local implementations (zcl_my_class.clas.locals_imp.abap)
Test classes In: Test classes (zcl_my_class.clas.testclasses.abap)

This makes it immediately clear which file to edit.

Error Handling

Error Message
File not found File not found: <path>
Invalid file format Invalid file format: <file>
No –files specified Error: --files parameter required
Unsupported object type Unsupported object type: <type>. Use 'pull' command instead.

File Format

Files are parsed to extract object type and name:

File Object Type Object Name
zcl_my_class.clas.abap CLAS ZCL_MY_CLASS
zif_my_intf.intf.abap INTF ZIF_MY_INTF
zmy_program.prog.abap PROG ZMY_PROGRAM
zcl_my_class.clas.locals_def.abap CLAS ZCL_MY_CLASS (local defs)
zcl_my_class.clas.locals_imp.abap CLAS ZCL_MY_CLASS (local imps)
zcl_my_class.clas.testclasses.abap CLAS ZCL_MY_CLASS (test classes)
zc_my_view.ddls.asddls DDLS ZC_MY_VIEW
zc_my_role.dcls.asdcls DCLS ZC_MY_ROLE
zmy_fugr.fugr.zmy_my_function.abap FUGR ZMY_FUGR (FM: ZMY_MY_FUNCTION)
zmy_fugr.fugr.lzmy_fugrtop.abap FUGR ZMY_FUGR (triggers auto-detection)
zmy_include.prog.abap (SUBC=I) PROG ZMY_INCLUDE (checked via parent)

Examples

Check Any Class File 

# Check main class - auto-detects all companions
abapgit-agent syntax --files src/zcl_my_class.clas.abap

# Check test classes - auto-detects main and local files
abapgit-agent syntax --files src/zcl_my_class.clas.testclasses.abap

# Check local implementations - auto-detects all others
abapgit-agent syntax --files src/zcl_my_class.clas.locals_imp.abap

# All produce the same complete syntax check

INCLUDE Program 

# Check INCLUDE program — parent is auto-detected in same directory
abapgit-agent syntax --files src/zmy_include.prog.abap

The command scans the directory for a non-INCLUDE .prog.abap containing INCLUDE ZMY_INCLUDE., assembles the source, and reports errors with line numbers relative to the include file:

  Auto-detected parent: zparent_prog.prog.abap (contains INCLUDE ZMY_INCLUDE.)

✅ PROG ZMY_INCLUDE - Syntax check passed (checking via parent ZPARENT_PROG)

If no parent is found in the same directory, a warning is printed:

  Warning: No parent program found for INCLUDE ZMY_INCLUDE — cannot syntax-check standalone

In that case, use the normal pull + inspect workflow after pushing.

Multiple Independent Objects 

# Check multiple unrelated files
abapgit-agent syntax --files src/zcl_class1.clas.abap,src/zcl_class2.clas.abap,src/zif_intf.intf.abap

ABAP Cloud Mode 

# Use stricter ABAP Cloud syntax rules
abapgit-agent syntax --files src/zcl_my_class.clas.abap --cloud

JSON Output 

# Get raw JSON response
abapgit-agent syntax --files src/zcl_my_class.clas.abap --json

Use Case

Use syntax when:

  • You want to check code BEFORE committing to git
  • You want faster feedback than pull + inspect
  • You’re developing CLAS, INTF, or PROG objects
  • You want to identify exactly which file has the error

Typical Workflow 

# Edit any class file (main, locals, or testclasses)
vim src/zcl_my_class.clas.locals_imp.abap

# Check syntax (auto-detects all companion files)
abapgit-agent syntax --files src/zcl_my_class.clas.locals_imp.abap

   Syntax check for 1 file(s)

   Auto-detected: zcl_my_class.clas.abap
   Auto-detected: zcl_my_class.clas.locals_def.abap
   Auto-detected: zcl_my_class.clas.testclasses.abap

❌ CLAS ZCL_MY_CLASS - Syntax check failed (1 error(s))

Errors:
────────────────────────────────────────────────────────────
  In: Local implementations (zcl_my_class.clas.locals_imp.abap)
  Line 24:
    "." expected after "LV_RESULT".

# Fix the error in zcl_my_class.clas.locals_imp.abap at line 24
vim src/zcl_my_class.clas.locals_imp.abap +24

# Check again
abapgit-agent syntax --files src/zcl_my_class.clas.locals_imp.abap
   ✅ CLAS ZCL_MY_CLASS - Syntax check passed

# Now safe to commit and push
git add . && git commit -m "Fix local implementation" && git push
abapgit-agent pull --files src/zcl_my_class.clas.abap

Comparison with inspect

Aspect syntax inspect
When to use BEFORE commit AFTER pull
Requires pull? No Yes
Checks Local source Activated code
Uses SYNTAX-CHECK / DDL handler Code Inspector (SCI)
Warnings No (DDLS: Yes) Yes
Object types CLAS, INTF, PROG, DDLS, DCLS, FUGR All (including FUGR, TABL)
Speed Fast Slower

DDLS (Data Definition Language Source) Specific Notes

CDS View vs CDS View Entity

The syntax command supports both CDS Views and CDS View Entities:

Feature CDS View CDS View Entity
Syntax define view define view entity
@AbapCatalog.sqlViewName ✅ REQUIRED ❌ Not allowed (error if present)
Creates SQL View Yes (DDLS + SQL view) No (DDLS only)
Recommended for Legacy systems (< 7.50) New development (S/4HANA, ABAP Cloud)
Parameter syntax :param or $parameters.param $parameters.param only

Example CDS View (Legacy):

@AbapCatalog.sqlViewName: 'ZV_MY_VIEW'  ← Required for CDS View
@EndUserText.label: 'My CDS View'
define view ZC_My_View as select from sflight
{
  key carrid,
      connid
}

Example CDS View Entity (Modern):

@AccessControl.authorizationCheck: #NOT_REQUIRED
@EndUserText.label: 'My CDS View Entity'
define view entity ZC_My_Entity as select from sflight
{
  key carrid,
      connid
}

Syntax command validates both:

# CDS View (checks for required sqlViewName)
abapgit-agent syntax --files src/zc_my_view.ddls.asddls

# CDS View Entity (accepts without sqlViewName)
abapgit-agent syntax --files src/zc_my_entity.ddls.asddls

Supported Features

✅ Syntax validation - DDL keywords, structure, brackets ✅ Annotation validation - Checks annotation syntax and requirements ✅ Field references - Validates field selection syntax ✅ Associations - Validates association syntax ✅ Parameters - Validates parameter definitions and usage ✅ Cast operations - Validates CAST expressions ✅ Line/column errors - Precise error location

Limitations

⚠️ CDS Views require @AbapCatalog.sqlViewName - Will fail without it ⚠️ CDS View Entities must NOT have @AbapCatalog.sqlViewName - Will fail if present ⚠️ Schema context - May not catch all errors for non-existent tables ⚠️ Type validation - Cannot fully validate types without data dictionary ⚠️ Parameter syntax - View entities require $parameters. prefix (not :)

Common Errors Caught

Error Detection
Missing @AbapCatalog.sqlViewName (CDS View) ✅ Caught
Has @AbapCatalog.sqlViewName (CDS View Entity) ✅ Caught
Invalid keyword ✅ Caught
Incomplete SELECT ✅ Caught
Invalid annotation syntax ✅ Caught
Missing braces ✅ Caught
Wrong parameter syntax (:param in view entity) ✅ Caught
Non-existent table ⚠️ May pass (limitation)

When to Use inspect Instead

Use inspect command after activation for:

  • Full semantic validation
  • Type compatibility checks
  • Code Inspector warnings
  • Deep dependency validation

Workflow:

# 1. Check syntax locally
abapgit-agent syntax --files src/zc_my_view.ddls.asddls

# 2. If passes, commit and activate
git add . && git commit && git push
abapgit-agent pull --files src/zc_my_view.ddls.asddls

# 3. Final validation with Code Inspector
abapgit-agent inspect --files src/zc_my_view.ddls.asddls

Back to top

Copyright © 2024-2026 abapGit Agent. Distributed under MIT License.

This site uses Just the Docs, a documentation theme for Jekyll.