abapgit-agent 1.3.0 → 1.5.0

package/abap/CLAUDE.md

@@ -4,6 +4,30 @@ This file provides guidelines for **generating ABAP code** in abapGit repositori
 
 **Use this file as a template**: Copy it to your ABAP repository root when setting up new projects with Claude Code.
 
+## Quick Reference
+
+```bash
+# After editing ABAP files:
+git add . && git commit -m "feat: description" && git push
+abapgit-agent pull --files abap/zcl_my_class.clas.abap
+
+# If pull fails with syntax error:
+abapgit-agent inspect --files abap/zcl_my_class.clas.abap
+
+# Explore tables/views:
+abapgit-agent preview --objects ZTABLE
+abapgit-agent view --objects ZTABLE --type TABL
+abapgit-agent tree --package $MY_PACKAGE
+```
+
+## Common Workflow
+
+1. Generate/edit ABAP code
+2. Push to git: `git add . && git commit && git push`
+3. Activate in ABAP: `abapgit-agent pull --files file.clas.abap`
+4. Check for errors - fix if needed
+5. Repeat
+
 ## ABAP Syntax Validation
 
 This is an ABAP project. **Do not attempt local syntax validation** - ABAP code can only be validated in an SAP system.
@@ -214,6 +238,112 @@ DATA ELEMENT ZMY_DTEL:
    Key Definition: WITH KEY
 ```
 
+## CLI Commands Reference
+
+This section documents the available CLI commands for ABAP development.
+
+### Pull Command
+
+Pull and activate ABAP objects from git repository.
+
+```bash
+# Pull all files
+abapgit-agent pull
+
+# Pull specific files (faster)
+abapgit-agent pull --files abap/zcl_my_class.clas.abap
+
+# Pull with transport request
+abapgit-agent pull --files abap/zcl_my_class.clas.abap --transport DEVK900001
+```
+
+### Inspect Command
+
+Run syntax check on ABAP objects.
+
+```bash
+# Syntax check single file
+abapgit-agent inspect --files abap/zcl_my_class.clas.abap
+
+# Syntax check multiple files
+abapgit-agent inspect --files abap/zcl_class1.clas.abap,abap/zcl_class2.clas.abap
+
+# Syntax check CDS view
+abapgit-agent inspect --files abap/zc_my_view.ddls.asddls
+```
+
+### Unit Command
+
+Run ABAP unit tests.
+
+```bash
+# Run unit tests for test class
+abapgit-agent unit --files abap/zcl_my_test.clas.testclasses.abap
+
+# Run unit tests for package
+abapgit-agent unit --package $MY_PACKAGE
+```
+
+### Tree Command
+
+Display package hierarchy.
+
+```bash
+# Display package tree
+abapgit-agent tree --package $MY_PACKAGE
+
+# With object counts
+abapgit-agent tree --package $MY_PACKAGE --include-objects
+
+# JSON output
+abapgit-agent tree --package $MY_PACKAGE --json
+```
+
+### View Command
+
+View ABAP object definitions directly from the system.
+
+```bash
+# View table structure
+abapgit-agent view --objects ZMY_TABLE --type TABL
+
+# View class definition
+abapgit-agent view --objects ZCL_MY_CLASS
+
+# View CDS view
+abapgit-agent view --objects ZC_MY_CDS_VIEW --type DDLS
+
+# JSON output
+abapgit-agent view --objects ZCL_MY_CLASS --json
+```
+
+### Preview Command
+
+Preview data from tables or CDS views.
+
+```bash
+# Preview table data
+abapgit-agent preview --objects SFLIGHT
+
+# Preview with row limit
+abapgit-agent preview --objects SFLIGHT --limit 5
+
+# Preview with WHERE filter
+abapgit-agent preview --objects SFLIGHT --where "CARRID = 'AA'"
+
+# Preview specific columns
+abapgit-agent preview --objects SFLIGHT --columns CARRID,PRICE,FLDATE
+
+# Vertical format (for wide tables)
+abapgit-agent preview --objects SFLIGHT --vertical
+
+# Compact mode (truncated values)
+abapgit-agent preview --objects SFLIGHT --compact
+
+# JSON output
+abapgit-agent preview --objects SFLIGHT --json
+```
+
 ## JSON Handling - ALWAYS Use /ui2/cl_json
 
 **CRITICAL**: Always use `/ui2/cl_json` for JSON serialization and deserialization.
@@ -658,6 +788,118 @@ ENDCLASS.
 - Syntax errors in one command don't affect others
 - Add new commands by updating the mapping table
 
+## Exception Handling in ABAP
+
+ABAP has two different ways to handle exceptions. Understanding the difference is critical.
+
+### Classical ABAP Exceptions (EXCEPTIONS)
+
+Used in older function modules and some OO classes. Defined in method signature using `EXCEPTIONS` keyword.
+
+**Method Definition:**
+```abap
+METHODS method_name
+  IMPORTING iv_param TYPE string
+  EXCEPTIONS
+    exc1 = 1
+    exc2 = 2
+    OTHERS = 3.
+```
+
+**Method Call:**
+```abap
+method_name(
+  EXPORTING iv_param = lv_value
+  EXCEPTIONS
+    exc1 = 1
+    exc2 = 2
+    OTHERS = 3 ).
+
+IF sy-subrc <> 0.
+  " Handle error - check sy-subrc for exception number
+ENDIF.
+```
+
+**Characteristics:**
+- Return code in `sy-subrc`
+- No exception objects
+- Legacy approach
+
+### Modern ABAP Exceptions (TRY-CATCH)
+
+Used in modern OO ABAP (7.40+). Uses exception classes and RAISING clause.
+
+**Exception Class:**
+```abap
+CLASS cx_my_exception DEFINITION INHERITING FROM cx_dynamic_check.
+  PUBLIC SECTION.
+    METHODS constructor IMPORTING textid LIKE textid OPTIONAL.
+ENDCLASS.
+```
+
+**Method Definition:**
+```abap
+METHODS method_name
+  IMPORTING iv_param TYPE string
+  RAISING cx_my_exception.
+```
+
+**Method Call:**
+```abap
+TRY.
+    method_name( iv_param = lv_value ).
+  CATCH cx_my_exception INTO lx_error.
+    lv_message = lx_error->get_text( ).
+ENDTRY.
+```
+
+### How to Identify Which to Use
+
+Look at the method signature:
+
+| Syntax | Type |
+|--------|------|
+| `EXCEPTIONS exc1 = 1` | Classical |
+| `RAISING cx_exception` | Modern (TRY-CATCH) |
+
+### Real Example: cl_ci_checkvariant=>get_ref
+
+This method uses **classical exceptions**:
+
+```abap
+" WRONG - using TRY-CATCH
+TRY.
+    lo_variant = cl_ci_checkvariant=>get_ref(
+      p_user = ''
+      p_name = lv_variant ).
+  CATCH cx_root.
+    " This won't work!
+ENDTRY.
+
+" CORRECT - using EXCEPTIONS with EXPORTING and RECEIVING
+cl_ci_checkvariant=>get_ref(
+  EXPORTING
+    p_user = ''
+    p_name = lv_variant
+  RECEIVING
+    p_ref = lo_variant
+  EXCEPTIONS
+    chkv_not_exists = 1
+    missing_parameter = 2
+    broken_variant = 3
+    OTHERS = 4 ).
+
+IF sy-subrc <> 0.
+  " Handle error
+ENDIF.
+```
+
+**Key Points:**
+1. Use `EXPORTING` before importing parameters when using `EXCEPTIONS`
+2. Use `RECEIVING` for RETURNING parameters (not direct assignment)
+3. Check `sy-subrc` for exception codes
+4. Not all OO methods use TRY-CATCH - some still use classical exceptions
+
 ## Best Practices
 
 ### Always Return Interface Types, Not Class Types

package/abap/zcl_abgagt_cmd_factory.clas.abap

@@ -29,6 +29,7 @@ CLASS zcl_abgagt_cmd_factory IMPLEMENTATION.
       ( command = zif_abgagt_command=>gc_import class_name = 'ZCL_ABGAGT_COMMAND_IMPORT' )
       ( command = zif_abgagt_command=>gc_tree   class_name = 'ZCL_ABGAGT_COMMAND_TREE' )
       ( command = zif_abgagt_command=>gc_view   class_name = 'ZCL_ABGAGT_COMMAND_VIEW' )
+      ( command = zif_abgagt_command=>gc_preview class_name = 'ZCL_ABGAGT_COMMAND_PREVIEW' )
     ).
   ENDMETHOD.
 

package/abap/zcl_abgagt_command_inspect.clas.abap

@@ -44,6 +44,7 @@ CLASS zcl_abgagt_command_inspect DEFINITION PUBLIC FINAL CREATE PUBLIC.
 
     TYPES: BEGIN OF ty_inspect_params,
              files TYPE string_table,
+             variant TYPE string,
            END OF ty_inspect_params.
 
     TYPES ty_object_keys TYPE TABLE OF scir_objs WITH NON-UNIQUE DEFAULT KEY.
@@ -53,6 +54,7 @@ CLASS zcl_abgagt_command_inspect DEFINITION PUBLIC FINAL CREATE PUBLIC.
 
     METHODS run_syntax_check
       IMPORTING it_objects TYPE ty_object_keys
+                iv_variant TYPE string DEFAULT 'SYNTAX_CHECK'
       RETURNING VALUE(rt_results) TYPE ty_inspect_results.
 
     " Validate DDLS (CDS views)
@@ -120,7 +122,9 @@ CLASS zcl_abgagt_command_inspect IMPLEMENTATION.
 
     " Run syntax check for non-DDLS objects
     IF lt_objects IS NOT INITIAL.
-      DATA(lt_sci_results) = run_syntax_check( lt_objects ).
+      DATA(lt_sci_results) = run_syntax_check(
+        it_objects = lt_objects
+        iv_variant = ls_params-variant ).
       INSERT LINES OF lt_sci_results INTO TABLE lt_results.
     ENDIF.
 
@@ -300,6 +304,7 @@ CLASS zcl_abgagt_command_inspect IMPLEMENTATION.
           lo_inspection TYPE REF TO cl_ci_inspection,
           lt_list TYPE scit_alvlist,
           ls_error TYPE ty_error,
+          ls_warning TYPE ty_warning,
           ls_list TYPE scir_alvlist,
           lx_error TYPE REF TO cx_root,
           ls_result TYPE ty_inspect_result.
@@ -315,10 +320,36 @@ CLASS zcl_abgagt_command_inspect IMPLEMENTATION.
           p_name    = lv_name
           p_objects = it_objects ).
 
-        " Get check variant for syntax check
-        lo_variant = cl_ci_checkvariant=>get_ref(
-          p_user = ''
-          p_name = 'SYNTAX_CHECK' ).
+        " Get check variant (default: SYNTAX_CHECK)
+        DATA lv_variant TYPE sci_chkv.
+        lv_variant = iv_variant.
+        IF lv_variant IS INITIAL.
+          lv_variant = 'SYNTAX_CHECK'.
+        ENDIF.
+
+        " Try to get the variant using EXCEPTIONS
+        cl_ci_checkvariant=>get_ref(
+          EXPORTING
+            p_user = ''
+            p_name = lv_variant
+          RECEIVING
+            p_ref = lo_variant
+          EXCEPTIONS
+            chkv_not_exists = 1
+            missing_parameter = 2
+            broken_variant = 3
+            OTHERS = 4 ).
+
+        IF sy-subrc <> 0.
+          " Variant not found, return error
+          ls_result-object_type = 'VARIANT'.
+          ls_result-object_name = lv_variant.
+          ls_result-success = abap_false.
+          ls_result-error_count = 1.
+          APPEND VALUE #( line = '0' column = '0' text = |Check variant "{ lv_variant }" not found (rc={ sy-subrc })| word = '' ) TO ls_result-errors.
+          APPEND ls_result TO rt_results.
+          RETURN.
+        ENDIF.
 
         " Create inspection
         cl_ci_inspection=>create(
@@ -355,14 +386,28 @@ CLASS zcl_abgagt_command_inspect IMPLEMENTATION.
           ls_result-object_name = ls_obj-objname.
           ls_result-success = abap_true.
 
-          " Get errors for this object
+          " Get errors and warnings for this object
           LOOP AT lt_list INTO ls_list WHERE objname = ls_obj-objname.
-            CLEAR ls_error.
-            ls_error-line = ls_list-line.
-            ls_error-column = ls_list-col.
-            ls_error-text = ls_list-text.
-            ls_error-word = ls_list-code.
-            APPEND ls_error TO ls_result-errors.
+            " Check severity - 'E' = Error, 'W' = Warning, 'I' = Info
+            IF ls_list-kind = 'E'.
+              " Error
+              CLEAR ls_error.
+              ls_error-line = ls_list-line.
+              ls_error-column = ls_list-col.
+              ls_error-text = ls_list-text.
+              ls_error-word = ls_list-code.
+              APPEND ls_error TO ls_result-errors.
+            ELSEIF ls_list-kind = 'W' OR ls_list-kind = 'I'.
+              " Warning or Info
+              CLEAR ls_warning.
+              ls_warning-line = ls_list-line.
+              ls_warning-column = ls_list-col.
+              ls_warning-severity = ls_list-kind.
+              ls_warning-message = ls_list-text.
+              ls_warning-object_type = ls_obj-objtype.
+              ls_warning-object_name = ls_obj-objname.
+              APPEND ls_warning TO ls_result-warnings.
+            ENDIF.
           ENDLOOP.
 
           ls_result-error_count = lines( ls_result-errors ).