abapgit-agent 1.5.0 → 1.6.0

package/docs/init-command.md

@@ -1,189 +0,0 @@
-# init Command
-
-Initialize local configuration for an existing git repository.
-
-## Command
-
-```bash
-abapgit-agent init --folder /src/ --package ZMY_PACKAGE
-```
-
-## Prerequisite
-
-- Current folder is the root folder of a git repository
-- Git remote is configured (`git remote -v` returns a URL)
-
-## Parameters
-
-| Parameter | Required | Default | Description |
-|-----------|----------|---------|-------------|
-| `--folder` | No | `/src/` | Subfolder path for ABAP source files |
-| `--package` | Yes | - | Target ABAP package |
-
-## Tasks
-
-### 1. Detect Git Remote URL
-
-```bash
-git remote get-url origin
-```
-
-- Fail if no remote configured
-
-### 2. Copy Configuration Template
-
-```bash
-cp .abapGitAgent.example .abapGitAgent
-```
-
-### 3. Update Configuration
-
-Add to `.abapGitAgent`:
-
-```json
-{
-  "package": "ZMY_PACKAGE",
-  "folder": "/src/"
-}
-```
-
-### 4. Create Folder
-
-```bash
-mkdir -p /src/
-```
-
-Add `.gitkeep` (optional):
-
-```bash
-touch /src/.gitkeep
-```
-
-### 5. Update .gitignore
-
-Add sensitive files to `.gitignore`:
-
-```
-.abapGitAgent
-.abapgit_agent_cookies.txt
-```
-
-### 6. Copy Documentation
-
-```bash
-cp /path/to/abapgit-agent/abap/CLAUDE.md .
-```
-
-## Output Files
-
-| File | Description |
-|------|-------------|
-| `.abapGitAgent` | Configuration (user must edit host, user, password, gitUsername, gitPassword) |
-| `.gitignore` | Updated with sensitive files |
-| `CLAUDE.md` | ABAP coding guidelines |
-| `/src/` | Folder for ABAP source files |
-
-## .abapGitAgent Contents
-
-After `init` command, `.abapGitAgent` contains:
-
-```json
-{
-  "host": "your-sap-system.com",
-  "sapport": 443,
-  "client": "100",
-  "user": "TECH_USER",
-  "password": "your-password",
-  "language": "EN",
-  "gitUsername": "github-username",
-  "gitPassword": "github-token",
-  "referenceFolder": "~/abap-reference",
-  "package": "ZMY_PACKAGE",
-  "folder": "/src/"
-}
-```
-
-## GitHub Credentials
-
-For the `import` command to work, you need to configure GitHub credentials:
-
-1. Create a GitHub Personal Access Token (PAT):
-   - GitHub.com: https://github.com/settings/tokens
-
-2. Add to `.abapGitAgent`:
-
-```json
-{
-  "gitUsername": "<your-github-username>",
-  "gitPassword": "ghp_your_token_here"
-}
-```
-
-Or set environment variables:
-
-```bash
-export GIT_USERNAME="<your-github-username>"
-export GIT_PASSWORD="ghp_your_token_here"
-```
-
-## Post-Init Steps
-
-1. Edit `.abapGitAgent` with correct values:
-   - `host`: SAP system hostname
-   - `user`: SAP username
-   - `password`: SAP password
-   - `gitUsername`: GitHub username (for import command)
-   - `gitPassword`: GitHub PAT (for import command)
-
-2. Run `abapgit-agent create` to create abapGit repo in ABAP
-
-3. Run `abapgit-agent import` to import objects to git
-
-## Full Workflow
-
-```
-1. abapgit-agent init --folder /src/ --package ZMY_PACKAGE
-   └─> Creates .abapGitAgent, CLAUDE.md, /src/, updates .gitignore
-
-2. Edit .abapGitAgent (host, user, password, gitUsername, gitPassword)
-
-3. abapgit-agent create
-   └─> Creates online repository in ABAP
-
-4. abapgit-agent import
-   └─> Stages, commits, and pushes all objects from ZMY_PACKAGE
-
-5. git pull
-   └─> Optionally pull to local folder
-
-6. abapgit-agent pull
-   └─> Activate objects in ABAP
-```
-
-## Example
-
-```bash
-# Initialize
-abapgit-agent init --folder /abap/ --package ZMYPROJECT
-
-# Edit config
-vim .abapGitAgent
-
-# Create repo
-abapgit-agent create
-
-# Import objects to git
-abapgit-agent import
-
-# Pull to local folder
-git pull origin main
-
-# Activate in ABAP
-abapgit-agent pull
-```
-
-## Related Commands
-
-- [`create`](create-command.md) - Create online repository in ABAP
-- [`import`](import-command.md) - Import objects from package to git
-- [`pull`](pull-command.md) - Pull and activate objects in ABAP

package/docs/inspect-command.md

@@ -1,169 +0,0 @@
-# inspect Command Requirements
-
-## Overview
-
-Inspect ABAP source file(s) for syntax errors and issues.
-
-## Command
-
-```bash
-# Inspect single file
-abapgit-agent inspect --files zcl_my_class.clas.abap
-
-# Inspect multiple files
-abapgit-agent inspect --files zcl_my_class.clas.abap,zcl_other.clas.abap
-
-# With path
-abapgit-agent inspect --files abap/zcl_my_class.clas.abap
-
-# With Code Inspector variant
-abapgit-agent inspect --files abap/zcl_my_class.clas.abap --variant ALL_CHECKS
-
-# With no variant (uses default SAP standard checks)
-abapgit-agent inspect --files abap/zcl_my_class.clas.abap --variant EMPTY
-```
-
-## Prerequisite
-
-- `.abapGitAgent` exists with valid credentials
-- Files must exist in the filesystem
-
-## Parameters
-
-| Parameter | Required | Description |
-|-----------|----------|-------------|
-| `--files` | Yes | Comma-separated list of files to inspect |
-| `--variant` | No | Code Inspector variant name (e.g., `ALL_CHECKS`, `EMPTY`) |
-
----
-
-## Tasks
-
-### 1. Validate Parameters
-
-- `--files` must be specified
-- Files must exist
-
-### 2. Load Configuration
-
-Read `.abapGitAgent` for credentials
-
-### 3. Fetch CSRF Token
-
-```bash
-GET /health (with X-CSRF-Token: fetch)
-```
-
-### 4. Make Inspect Request
-
-**Endpoint:** `POST /inspect`
-
-**Request Body:**
-```json
-{
-  "files": ["ZCL_MY_CLASS.CLASS.ABAP"],
-  "variant": "ALL_CHECKS"
-}
-```
-
-### 5. Display Results
-
----
-
-## Output
-
-### Success (No Errors)
-
-```
-  Inspect for 1 file(s)
-
-  ✅ zcl_my_class.clas.abap - Syntax check passed (0 errors)
-```
-
-### With Errors
-
-```
-  Inspect for 1 file(s)
-
-  ❌ Syntax check failed (2 error(s)):
-
-  Errors:
-────────────────────────────────────────────────────────────
-  Line 15, Column 10:
-    "ZMYCLASS" is not a type
-
-  Line 20, Column 5:
-    Field "LV_VAR" is unknown
-```
-
----
-
-## Response Structure
-
-```json
-{
-  "success": "X",
-  "object_type": "CLAS",
-  "object_name": "ZCL_MY_CLASS",
-  "error_count": 2,
-  "errors": [
-    {
-      "line": "15",
-      "column": "10",
-      "text": "\"ZMYCLASS\" is not a type",
-      "word": "ZMYCLASS"
-    }
-  ]
-}
-```
-
----
-
-## 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` |
-
----
-
-## File Format
-
-Same as pull command - 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 |
-
----
-
-## Example
-
-```bash
-# Syntax check
-abapgit-agent inspect --files zcl_my_class.clas.abap
-
-# Multiple files
-abapgit-agent inspect --files abap/zcl_my_class.clas.abap,abap/zcl_other.clas.abap
-
-# With Code Inspector variant
-abapgit-agent inspect --files abap/zcl_my_class.clas.abap --variant ALL_CHECKS
-```
-
-## Use Case
-
-Use `inspect` when:
-- Pull shows "Error updating where-used list" (syntax error)
-- You need detailed error messages with line numbers
-- Debugging activation failures
-
-```
-abapgit-agent pull
-   ❌ CLAS ZCL_MY_CLASS: Error updating where-used list
-
-abapgit-agent inspect --files abap/zcl_my_class.clas.abap
-   ❌ Line 15, Column 10: "ZMYCLASS" is not a type
-```

package/docs/list-command.md

@@ -1,289 +0,0 @@
-# list Command Requirements
-
-## Overview
-
-List ABAP objects in a package with filtering and pagination capabilities. This command provides a flat list of objects with support for filtering by type, name pattern, and pagination.
-
-## Command
-
-```bash
-# List all objects in a package
-abapgit-agent list --package $ZMY_PACKAGE
-
-# Filter by object type
-abapgit-agent list --package $ZMY_PACKAGE --type CLAS,INTF
-
-# Filter by name pattern
-abapgit-agent list --package $ZMY_PACKAGE --name ZCL_*
-
-# Limit results
-abapgit-agent list --package $ZMY_PACKAGE --limit 50
-
-# Paginate results
-abapgit-agent list --package $ZMY_PACKAGE --offset 100 --limit 50
-
-# JSON output for scripting
-abapgit-agent list --package $ZMY_PACKAGE --json
-```
-
-## Prerequisite
-
-- `.abapGitAgent` exists with valid credentials
-- Package must exist in the ABAP system
-
-## Parameters
-
-| Parameter | Required | Default | Description |
-|-----------|----------|---------|-------------|
-| `--package` | Yes | - | Package name (e.g., `$ZMY_PACKAGE`, `ZMY_PACKAGE`) |
-| `--type` | No | All types | Comma-separated object types (e.g., `CLAS,INTF,PROG`) |
-| `--name` | No | - | Name pattern with wildcard support (e.g., `ZCL_*`) |
-| `--limit` | No | 100 | Maximum objects to return (max: 1000) |
-| `--offset` | No | 0 | Number of objects to skip |
-| `--json` | No | false | Output raw JSON only |
-
----
-
-## Tasks
-
-### 1. Validate Parameters
-
-- `--package` must be specified
-- Package name must be valid (1-30 characters)
-- `--limit` must be between 1 and 1000
-
-### 2. Load Configuration
-
-Read `.abapGitAgent` for credentials
-
-### 3. Fetch CSRF Token
-
-```bash
-GET /health (with X-CSRF-Token: fetch)
-```
-
-### 4. Make List Request
-
-**Endpoint:** `POST /list`
-
-**Request Body:**
-```json
-{
-  "package": "$ZMY_PACKAGE",
-  "type": "CLAS,INTF",
-  "name": "ZCL_*",
-  "limit": 100,
-  "offset": 0
-}
-```
-
-### 5. Display Results
-
----
-
-## Output
-
-### Human-Readable Output
-
-```
-📋 Objects in $ZMY_PACKAGE (Total: 15)
-
-  CLAS (5)
-    ZCL_CLASS1
-    ZCL_CLASS2
-    ZCL_CLASS3
-    ZCL_CLASS4
-    ZCL_CLASS5
-
-  INTF (2)
-    ZIF_INTERFACE1
-    ZIF_INTERFACE2
-
-  PROG (3)
-    ZPROG1
-    ZPROG2
-    ZPROG3
-
-  TABL (5)
-    ZTABLE1
-    ZTABLE2
-    ZTABLE3
-    ZTABLE4
-    ZTABLE5
-```
-
-### With Type Filter
-
-```
-📋 Objects in $ZMY_PACKAGE (CLAS only, Total: 5)
-
-  CLAS (5)
-    ZCL_CLASS1
-    ZCL_CLASS2
-    ZCL_CLASS3
-    ZCL_CLASS4
-    ZCL_CLASS5
-```
-
-### JSON Output
-
-```json
-{
-  "SUCCESS": true,
-  "COMMAND": "LIST",
-  "PACKAGE": "$ZMY_PACKAGE",
-  "TOTAL": 15,
-  "LIMIT": 100,
-  "OFFSET": 0,
-  "OBJECTS": [
-    { "TYPE": "CLAS", "NAME": "ZCL_CLASS1" },
-    { "TYPE": "CLAS", "NAME": "ZCL_CLASS2" },
-    { "TYPE": "CLAS", "NAME": "ZCL_CLASS3" },
-    { "TYPE": "CLAS", "NAME": "ZCL_CLASS4" },
-    { "TYPE": "CLAS", "NAME": "ZCL_CLASS5" },
-    { "TYPE": "INTF", "NAME": "ZIF_INTERFACE1" },
-    { "TYPE": "INTF", "NAME": "ZIF_INTERFACE2" },
-    { "TYPE": "PROG", "NAME": "ZPROG1" },
-    { "TYPE": "PROG", "NAME": "ZPROG2" },
-    { "TYPE": "PROG", "NAME": "ZPROG3" },
-    { "TYPE": "TABL", "NAME": "ZTABLE1" },
-    { "TYPE": "TABL", "NAME": "ZTABLE2" },
-    { "TYPE": "TABL", "NAME": "ZTABLE3" },
-    { "TYPE": "TABL", "NAME": "ZTABLE4" },
-    { "TYPE": "TABL", "NAME": "ZTABLE5" }
-  ],
-  "BY_TYPE": [
-    { "TYPE": "CLAS", "COUNT": 5 },
-    { "TYPE": "INTF", "COUNT": 2 },
-    { "TYPE": "PROG", "COUNT": 3 },
-    { "TYPE": "TABL", "COUNT": 5 }
-  ],
-  "ERROR": ""
-}
-```
-
-**Response Fields:**
-
-| Field | Type | Description |
-|-------|------|-------------|
-| `SUCCESS` | boolean | Whether the request succeeded |
-| `COMMAND` | string | Command name ("LIST") |
-| `PACKAGE` | string | Package name |
-| `TOTAL` | number | Total objects matching filter |
-| `LIMIT` | number | Requested limit |
-| `OFFSET` | number | Requested offset |
-| `OBJECTS` | array | List of objects [{TYPE, NAME}] |
-| `BY_TYPE` | array | Object counts by type [{TYPE, COUNT}] |
-| `ERROR` | string | Error message (empty if success) |
-
----
-
-## Error Handling
-
-| Error | Message |
-|-------|---------|
-| Package not specified | `Package parameter is required` |
-| Package not found | `Package <name> does not exist` |
-| Invalid type | `Invalid object type: <type>` |
-| Limit too high | `Limit value too high (max: 1000)` |
-
-### Error Output
-
-```
-❌ Package not found: $ZNONEXISTENT
-
-Error: Package $ZNONEXISTENT does not exist in the system.
-```
-
----
-
-## Example
-
-```bash
-# List all objects
-abapgit-agent list --package $ZMY_PACKAGE
-
-# Filter by type
-abapgit-agent list --package $ZMY_PACKAGE --type CLAS,INTF
-
-# Filter by name pattern
-abapgit-agent list --package $ZMY_PACKAGE --name ZCL_*
-
-# Paginate
-abapgit-agent list --package $ZMY_PACKAGE --limit 50 --offset 50
-
-# JSON for scripting
-abapgit-agent list --package $ZMY_PACKAGE --json > objects.json
-
-# CI/CD: Count classes
-CLASS_COUNT=$(abapgit-agent list --package $ZMY_PACKAGE --type CLAS --json | jq '.TOTAL')
-echo "Package has $CLASS_COUNT classes"
-```
-
----
-
-## Implementation
-
-### ABAP Tables Used
-
-| Table | Purpose |
-|-------|---------|
-| **TDEVC** | Package definitions (validate package exists) |
-| **TADIR** | Object directory (fetch objects in package) |
-
-### Supported Object Types
-
-| Type | Description |
-|------|-------------|
-| CLAS | Class |
-| INTF | Interface |
-| PROG | Program |
-| FUGR | Function Group |
-| TABL | Table |
-| STRU | Structure |
-| DTEL | Data Element |
-| TTYP | Table Type |
-| DDLS | CDS View |
-| DDLX | CDS View Entity |
-
-### Query Logic
-
-```abap
-" Validate package exists
-SELECT SINGLE devclass FROM tdevc
-  INTO lv_package
- WHERE devclass = iv_package.
-
-" Get objects with filters
-SELECT object obj_name FROM tadir
-  INTO TABLE lt_objects
- WHERE devclass = iv_package
-   AND object IN lt_types
-   AND obj_name LIKE lv_name_pattern
- ORDER BY object obj_name
- LIMIT iv_limit
- OFFSET iv_offset.
-
-" Get counts by type (for summary)
-SELECT object COUNT(*) AS count FROM tadir
-  INTO TABLE lt_counts
- WHERE devclass = iv_package
-   AND object IN lt_types
- GROUP BY object.
-```
-
-### Files to Create
-
-| File | Description |
-|------|-------------|
-| `zcl_abgagt_command_list.clas.abap` | Command implementation |
-| `zcl_abgagt_command_list.clas.xml` | Class metadata |
-| `zcl_abgagt_resource_list.clas.abap` | REST resource handler |
-| `zcl_abgagt_resource_list.clas.xml` | Resource metadata |
-
-### Files to Modify
-
-| File | Description |
-|------|-------------|
-| `zif_abgagt_command.intf.abap` | Add LIST constant |
-| `zcl_abgagt_cmd_factory.clas.abap` | Add LIST command mapping |