abapgit-agent 1.2.0 → 1.4.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.
@@ -23,6 +47,58 @@ This is an ABAP project. **Do not attempt local syntax validation** - ABAP code
 4. **"Error updating where-used list" = SYNTAX ERROR** - This is NOT a warning!
 5. If Failed Objects > 0, there are syntax errors - fix them before proceeding
 
+## Inspect Command (Syntax Check)
+
+Use the `inspect` command to perform syntax validation on ABAP objects and CDS views.
+
+### Usage
+```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
+```
+
+### Supported Object Types
+
+| Type | Description | Validation Method |
+|------|-------------|------------------|
+| CLAS | Class | Code Inspector (SCI) |
+| INTF | Interface | Code Inspector (SCI) |
+| PROG | Program | Code Inspector (SCI) |
+| DDLS | CDS View/Entity | DDL Handler |
+
+### CDS Views (DDLS) Validation
+
+For CDS views, the inspect command uses `CL_DD_DDL_HANDLER_FACTORY`:
+- Checks **inactive version first** (`get_state = 'M'`)
+- Falls back to active version if no inactive version exists
+- Uses `get_errors()` and `get_warnings()` methods for detailed error information
+
+### Examples
+
+**Passed:**
+```
+✅ CLAS ZCL_MY_CLASS - Syntax check passed
+```
+
+**With Warnings:**
+```
+⚠️  DDLS ZC_MY_VIEW - Syntax check passed with warnings (4):
+  Line 9 : ParentPackage
+  Line 11 : SoftwareComponent
+```
+
+**Failed:**
+```
+❌ DDLS ZC_MY_VIEW - Syntax check failed (1 error(s)):
+  Line 21, Column 12: Error message text
+```
+
 ## Fast Iteration Workflow
 
 For quick ABAP code changes:
@@ -80,6 +156,12 @@ abapgit-agent view --objects ZMY_DTEL --type DTEL
 # View a class definition
 abapgit-agent view --objects ZCL_MY_CLASS
 
+# View an interface definition
+abapgit-agent view --objects ZIF_MY_INTERFACE
+
+# View a table type definition
+abapgit-agent view --objects ZMY_TTYP --type TTYP
+
 # View multiple objects
 abapgit-agent view --objects ZCL_CLASS1,ZCL_CLASS2,ZIF_INTERFACE1
 
@@ -87,6 +169,41 @@ abapgit-agent view --objects ZCL_CLASS1,ZCL_CLASS2,ZIF_INTERFACE1
 abapgit-agent view --objects ZMY_TABLE --type TABL --json
 ```
 
+### When to Use View Command
+
+AI assistant SHOULD call `view` command when:
+
+- User asks to "check", "look up", or "explore" an unfamiliar object
+- Working with a table/structure and you don't know the field names/types
+- Calling a class/interface method and you don't know the parameters
+- User provides an object name that may not exist in the git repository
+
+**Example workflow:**
+```
+User: "Check if SFLIGHT table has a PRICE field"
+
+Assistant: <calls `abapgit-agent view --objects SFLIGHT --type TABL`>
+→ Shows table structure with all fields including PRICE
+```
+
+## Explore Package Structure
+
+Use the `tree` command to display package hierarchy from ABAP system:
+
+```bash
+# Display package hierarchy
+abapgit-agent tree --package $MY_PACKAGE
+
+# With object counts
+abapgit-agent tree --package $MY_PACKAGE --include-objects
+
+# Limit depth
+abapgit-agent tree --package $MY_PACKAGE --depth 2
+
+# JSON output for scripting
+abapgit-agent tree --package $MY_PACKAGE --json
+```
+
 **Table Output Example:**
 ```
 TABLE ZCAIS_D1:
@@ -111,6 +228,122 @@ DATA ELEMENT ZMY_DTEL:
 |----------------+----------------+----------+----------------+----------------------|
 ```
 
+**Table Type Output Example:**
+```
+📖 ZMY_TTYP (Table Type)
+   Table Type ZMY_TTYP in $PACKAGE
+
+   Line Type: ZMY_STRUCTURE
+   Access Mode: STANDARD
+   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.
@@ -369,6 +602,113 @@ Common object types in this project:
 - `TABL` - Tables
 - `DDLS` - Data Definitions
 
+## Creating CDS Views (DDLS)
+
+CDS views (Data Definition Language Source) require specific file naming and structure for abapGit.
+
+### File Naming
+
+CDS views require **two files**:
+
+| File | Description |
+|------|-------------|
+| `zc_my_view.ddls.asddls` | DDL source code |
+| `zc_my_view.ddls.xml` | XML metadata |
+
+**Important:** Do NOT use `.ddls.abap` extension - use `.ddls.asddls` for the source.
+
+### DDL Source File (`.ddls.asddls`)
+
+```abap
+@AbapCatalog.sqlViewName: 'ZCMYVIEW'
+@AbapCatalog.compiler.compareFilter: true
+@AccessControl.authorizationCheck: #NOT_REQUIRED
+@EndUserText.label: 'My CDS View'
+define view ZC_My_View as select from tdevc
+{
+  key devclass as Devclass,
+      parentcl as ParentPackage,
+      ctext    as Description
+}
+where devclass not like '$%'
+```
+
+### XML Metadata File (`.ddls.xml`)
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<abapGit version="v1.0.0" serializer="LCL_OBJECT_DDLS" serializer_version="v1.0.0">
+ <asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
+  <asx:values>
+   <DDLS>
+    <DDLNAME>ZC_MY_VIEW</DDLNAME>
+    <DDLANGUAGE>E</DDLANGUAGE>
+    <DDTEXT>My CDS View</DDTEXT>
+   </DDLS>
+  </asx:values>
+ </asx:abap>
+</abapGit>
+```
+
+### Key Points
+
+1. **Avoid reserved words** - Field names like `PACKAGE`, `CLASS`, `INTERFACE` are reserved in CDS. Use alternatives like `PackageName`, `ClassName`.
+
+2. **Pull all files to activate** - When activating CDS views, use `abapgit-agent pull` (not single file) to ensure proper activation:
+   ```bash
+   abapgit-agent pull  # Pull all files
+   ```
+
+3. **System support** - CDS views require SAP systems with CDS capability (S/4HANA, SAP BW/4HANA, or ABAP 7.51+). Older systems will show error: "Object type DDLS is not supported by this system"
+
+### Debugging Activation Errors
+
+When pull shows generic errors like "Activation cancelled. Check the inactive objects":
+
+1. **Check in ADT/Eclipse** - Open the DDL source in ADT and run syntax check for detailed errors
+2. **Pull all files** - Sometimes `abapgit-agent pull` (all files) works better than single file for CDS views
+
+## Creating CDS View Entities
+
+CDS View Entities (`define view entity`) are the modern replacement for CDS Views with additional features like **associations for OData navigation**.
+
+### Differences from CDS Views
+
+| Aspect | CDS View | View Entity |
+|--------|----------|-------------|
+| Syntax | `define view` | `define view entity` |
+| Associations | No | Yes (exposed for navigation) |
+| OData/Navigation | Requires separate service | Auto-exposes associations |
+| ABAP Version | 7.40+ | 7.55+ / S/4HANA Cloud |
+
+### DDL Source File with Association
+
+```abap
+@EndUserText.label: 'Package Hierarchy'
+@AccessControl.authorizationCheck: #NOT_REQUIRED
+define view entity ZC_Pkg_Hierarchy_VE
+  as select from tdevc
+  association [0..1] to tdevc as _Parent
+    on _Parent.devclass = $projection.ParentPackage
+{
+  key devclass                           as PackageName,
+      parentcl                           as ParentPackage,
+      ctext                              as Description,
+      dlvunit                           as SoftwareComponent,
+
+      // Exposed associations
+      _Parent
+}
+where devclass not like '$%'
+```
+
+### Key Points for View Entities
+
+1. **Association syntax**: Use `$projection` to reference fields in the current entity
+2. **Association cardinality**: `[0..1]`, `[1..1]`, `[0..n]`, `[1..n]`
+3. **Expose associations**: Add the association name at the end of the SELECT to expose it for OData navigation
+4. **Activation warnings**: Search help warnings are informational and don't block activation
+
 ## Naming Conventions
 
 - Use `Z_` or `Y_` prefix for custom objects

package/abap/copilot-instructions.md

@@ -10,6 +10,34 @@ You are working on an ABAP project using abapGit for version control.
 | `abapgit-agent pull --files <file>` | Pull and activate specific file only |
 | `abapgit-agent inspect --files <file>` | Syntax check ABAP source |
 | `abapgit-agent unit --files <file>` | Run AUnit tests |
+| `abapgit-agent tree --package <package>` | Display package hierarchy |
+| `abapgit-agent view --objects <name>` | View object definitions |
+
+## Explore Unknown Objects
+
+**Before working with unfamiliar objects, use `view` command:**
+
+```bash
+# Check table structure
+abapgit-agent view --objects ZMY_TABLE --type TABL
+
+# Check class definition
+abapgit-agent view --objects ZCL_UNKNOWN_CLASS
+
+# Check interface
+abapgit-agent view --objects ZIF_UNKNOWN_INTERFACE
+
+# Check data element
+abapgit-agent view --objects ZMY_DTEL --type DTEL
+```
+
+## When to Use View Command
+
+AI assistant SHOULD call `view` command when:
+- User asks to "check", "look up", or "explore" an unfamiliar object
+- Working with a table/structure and you don't know the fields
+- Calling a class/interface method and you don't know the parameters
+- You need to verify an object exists before using it
 
 ## Key ABAP Rules
 

package/abap/zcl_abgagt_agent.clas.abap

@@ -389,8 +389,8 @@ CLASS zcl_abgagt_agent IMPLEMENTATION.
           ENDIF.
         ENDIF.
 
-        " Error/Abort/Warning messages - add to failed objects
-        IF ls_msg-type = 'E' OR ls_msg-type = 'A' OR ls_msg-type = 'W'.
+        " Error/Abort messages - add to failed objects (warnings are not failures)
+        IF ls_msg-type = 'E' OR ls_msg-type = 'A'.
           APPEND ls_object TO rs_result-failed_objects.
         ENDIF.
       ENDLOOP.

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.