abapgit-agent 1.11.2 → 1.11.3

package/abap/CLAUDE.md

@@ -54,7 +54,7 @@ abapgit-agent ref --topic sql
 abapgit-agent ref --list-topics
 ```
 
-### 2. Read `.abapGitAgent` for Folder Location
+### 2. Read `.abapGitAgent` for Folder Location and Naming Conventions
 
 **Before creating ANY ABAP object file, you MUST read `.abapGitAgent` to determine the correct folder.**
 
@@ -67,6 +67,15 @@ The folder is configured in `.abapGitAgent` (property: `folder`):
 - If `folder` is `/src/` → files go in `src/` (e.g., `src/zcl_my_class.clas.abap`)
 - If `folder` is `/abap/` → files go in `abap/` (e.g., `abap/zcl_my_class.clas.abap`)
 
+**Also check naming conventions before creating any new object:**
+
+```
+1. Check guidelines/objects.local.md  ← project-specific overrides (if file exists)
+2. Fall back to guidelines/objects.md ← default Z/Y prefix conventions
+```
+
+`objects.local.md` is created by `abapgit-agent init` and is never overwritten by updates — it holds project-specific prefixes (e.g. `YCL_` instead of `ZCL_`).
+
 ---
 
 ### 3. Create XML Metadata / Local Classes
@@ -122,7 +131,7 @@ abapgit-agent pull --files src/zif_my_intf.intf.abap,src/zcl_my_class.clas.abap
 
 ---
 
-### 5. (covered in object-creation.md)
+### 5. Local Helper / Test-Double Classes
 
 → See `guidelines/object-creation.md` for local class setup (`locals_def.abap` / `locals_imp.abap`)
 
@@ -367,7 +376,8 @@ Detailed guidelines are available in the `guidelines/` folder:
 | `guidelines/testing.md` | Unit Testing (including CDS) |
 | `guidelines/cds.md` | CDS Views |
 | `guidelines/classes.md` | ABAP Classes and Objects |
-| `guidelines/objects.md` | Object Naming Conventions |
+| `guidelines/objects.md` | Object Naming Conventions (defaults) |
+| `guidelines/objects.local.md` | **Project** Naming Conventions — overrides `objects.md` (created by `init`, never overwritten) |
 | `guidelines/json.md` | JSON Handling |
 | `guidelines/abapgit.md` | abapGit XML Metadata Templates |
 | `guidelines/unit-testable-code.md` | Unit Testable Code Guidelines (Dependency Injection) |

package/abap/guidelines/objects.md

@@ -8,6 +8,9 @@ grand_parent: ABAP Development
 
 # ABAP Object Naming Conventions
 
+> **Project-specific overrides**: Add your naming conventions to `guidelines/objects.local.md`.
+> That file is never overwritten by `abapgit-agent init --update` and is searched by the `ref` command.
+
 **Searchable keywords**: naming convention, Z prefix, namespace, object type, CLAS, INTF, PROG, TABL, DDLS
 
 ## TOPICS IN THIS FILE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "abapgit-agent",
-  "version": "1.11.2",
+  "version": "1.11.3",
   "description": "ABAP Git Agent - Pull and activate ABAP code via abapGit from any git repository",
   "main": "src/index.js",
   "files": [

package/src/commands/init.js

@@ -43,6 +43,11 @@ async function copyGuidelinesFolder(srcPath, destPath, overwrite = false) {
 
       for (const file of files) {
         if (file.endsWith('.md')) {
+          // Never overwrite *.local.md files — these are project-specific customisations
+          if (file.endsWith('.local.md')) {
+            continue;
+          }
+
           const srcFile = pathModule.join(srcPath, file);
           const destFile = pathModule.join(destPath, file);
 
@@ -396,6 +401,41 @@ Examples:
         } else {
           console.log(`⚠️  guidelines/ already exists, skipped`);
         }
+
+        // Create objects.local.md stub if not already present
+        const localNamingPath = pathModule.join(guidelinesDestPath, 'objects.local.md');
+        if (!fs.existsSync(localNamingPath)) {
+          const localNamingStub = `---
+nav_order: 8
+---
+
+# Project Naming Conventions (Override)
+
+This file overrides \`guidelines/objects.md\` for this project.
+It is **never overwritten** by \`abapgit-agent init --update\` — safe to customise.
+
+Searched by the \`ref\` command alongside all other guidelines.
+
+## Naming Conventions
+
+Uncomment and edit the rows that differ from the defaults in \`guidelines/objects.md\`:
+
+| Object Type | Prefix | Example |
+|---|---|---|
+| Class | ZCL_ | ZCL_MY_CLASS |
+| Interface | ZIF_ | ZIF_MY_INTERFACE |
+| Program | Z | ZMY_PROGRAM |
+| Package | $ | $MY_PACKAGE |
+| Table | Z | ZMY_TABLE |
+| CDS View | ZC_ | ZC_MY_VIEW |
+| CDS Entity | ZE_ | ZE_MY_ENTITY |
+| Data Element | Z | ZMY_ELEMENT |
+| Structure | Z | ZMY_STRUCTURE |
+| Table Type | Z | ZMY_TABLE_TYPE |
+`;
+          fs.writeFileSync(localNamingPath, localNamingStub);
+          console.log(`✅ Created guidelines/objects.local.md (project naming conventions)`);
+        }
       } else {
         console.log(`⚠️  guidelines folder not found in abap/ directory`);
       }