abapgit-agent 1.12.0 → 1.13.0

package/src/commands/init.js

@@ -129,7 +129,7 @@ Usage:
 
 Description:
   Initialize local repository configuration.
-  Creates .abapGitAgent, .gitignore, CLAUDE.md, and guidelines folder.
+  Creates .abapGitAgent, .abapgit.xml, .gitignore, CLAUDE.md, and guidelines folder.
 
 Options:
   --package <PACKAGE>             ABAP package name (required)
@@ -202,34 +202,82 @@ Examples:
       console.log(`\n🔄 Updating abapGit Agent files`);
       console.log('');
 
-      // Copy CLAUDE.md
-      await copyFileIfExists(
-        pathModule.join(__dirname, '..', '..', 'abap', 'CLAUDE.md'),
-        pathModule.join(process.cwd(), 'CLAUDE.md'),
-        'CLAUDE.md'
-      );
-
-      // Copy copilot-instructions.md
-      await copyFileIfExists(
-        pathModule.join(__dirname, '..', '..', 'abap', '.github', 'copilot-instructions.md'),
-        pathModule.join(process.cwd(), '.github', 'copilot-instructions.md'),
-        '.github/copilot-instructions.md',
-        true  // create parent dir
-      );
-
-      // Copy guidelines folder to project root
-      await copyGuidelinesFolder(
-        pathModule.join(__dirname, '..', '..', 'abap', 'guidelines'),
-        pathModule.join(process.cwd(), 'guidelines'),
-        true  // overwrite
-      );
-
-      // Detect and offer to remove old numbered guideline files
-      await cleanupOldGuidelineFiles(pathModule.join(process.cwd(), 'guidelines'));
+      // copilot-instructions.md: never overwrite — user may have customised it
+      const localCopilotMdPath = pathModule.join(process.cwd(), '.github', 'copilot-instructions.md');
+      if (!fs.existsSync(localCopilotMdPath)) {
+        await copyFileIfExists(
+          pathModule.join(__dirname, '..', '..', 'abap', '.github', 'copilot-instructions.slim.md'),
+          localCopilotMdPath,
+          '.github/copilot-instructions.md',
+          true  // create parent dir
+        );
+      } else {
+        console.log(`⚠️  .github/copilot-instructions.md already exists, skipped`);
+      }
+
+      // CLAUDE.md: never overwrite — user may have customised it
+      const localClaudeMdPath = pathModule.join(process.cwd(), 'CLAUDE.md');
+      if (!fs.existsSync(localClaudeMdPath)) {
+        await copyFileIfExists(
+          pathModule.join(__dirname, '..', '..', 'abap', 'CLAUDE.slim.md'),
+          localClaudeMdPath,
+          'CLAUDE.md'
+        );
+      } else {
+        console.log(`⚠️  CLAUDE.md already exists, skipped (use 'abapgit-agent guide --migrate' to replace a full guide with the slim stub)`);
+      }
+
+      // guidelines/: never copy standard files — they're bundled in the package now.
+      // Only ensure objects.local.md stub exists if missing.
+      const guidelinesDestPath = pathModule.join(process.cwd(), 'guidelines');
+      if (!fs.existsSync(guidelinesDestPath)) {
+        fs.mkdirSync(guidelinesDestPath, { recursive: true });
+        console.log(`✅ Created guidelines/`);
+      }
+      const localNamingPath = pathModule.join(guidelinesDestPath, 'objects.local.md');
+      if (!fs.existsSync(localNamingPath)) {
+        // reuse the same stub content as init
+        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`);
+      } else {
+        console.log(`⚠️  guidelines/objects.local.md already exists, skipped`);
+      }
+
+      // Detect and offer to remove old numbered guideline files (legacy cleanup)
+      await cleanupOldGuidelineFiles(guidelinesDestPath);
 
       console.log(`
 📋 Update complete!
-   Run 'abapgit-agent ref --list-topics' to see available topics.
+   Standard guidelines are read from the package automatically — no local copies needed.
+   Run 'abapgit-agent guide --migrate' if you still have copied guideline files to remove.
 `);
       return;
     }
@@ -386,66 +434,55 @@ Examples:
       console.log(`✅ .gitignore already up to date`);
     }
 
-    // Copy CLAUDE.md
-    const claudeMdPath = pathModule.join(__dirname, '..', '..', 'abap', 'CLAUDE.md');
+    // Copy CLAUDE.md (slim stub — tells Claude to run 'abapgit-agent guide')
+    const claudeMdPath = pathModule.join(__dirname, '..', '..', 'abap', 'CLAUDE.slim.md');
     const localClaudeMdPath = pathModule.join(process.cwd(), 'CLAUDE.md');
     try {
-      if (fs.existsSync(claudeMdPath)) {
+      if (fs.existsSync(localClaudeMdPath)) {
+        console.log(`⚠️  CLAUDE.md already exists, skipped`);
+      } else if (fs.existsSync(claudeMdPath)) {
         fs.copyFileSync(claudeMdPath, localClaudeMdPath);
         console.log(`✅ Created CLAUDE.md`);
       } else {
-        console.log(`⚠️  CLAUDE.md not found in abap/ directory`);
+        console.log(`⚠️  CLAUDE.slim.md not found in abap/ directory`);
       }
     } catch (error) {
       console.error(`Error copying CLAUDE.md: ${error.message}`);
     }
 
-    // Copy copilot-instructions.md for GitHub Copilot
-    const copilotMdPath = pathModule.join(__dirname, '..', '..', 'abap', '.github', 'copilot-instructions.md');
+    // Copy copilot-instructions.md for GitHub Copilot (slim stub)
+    const copilotMdPath = pathModule.join(__dirname, '..', '..', 'abap', '.github', 'copilot-instructions.slim.md');
     const githubDir = pathModule.join(process.cwd(), '.github');
     const localCopilotMdPath = pathModule.join(githubDir, 'copilot-instructions.md');
     try {
-      if (fs.existsSync(copilotMdPath)) {
-        // Ensure .github directory exists
+      if (fs.existsSync(localCopilotMdPath)) {
+        console.log(`⚠️  .github/copilot-instructions.md already exists, skipped`);
+      } else if (fs.existsSync(copilotMdPath)) {
         if (!fs.existsSync(githubDir)) {
           fs.mkdirSync(githubDir, { recursive: true });
         }
         fs.copyFileSync(copilotMdPath, localCopilotMdPath);
         console.log(`✅ Created .github/copilot-instructions.md`);
       } else {
-        console.log(`⚠️  copilot-instructions.md not found in abap/ directory`);
+        console.log(`⚠️  copilot-instructions.slim.md not found in abap/.github/ directory`);
       }
     } catch (error) {
       console.error(`Error copying copilot-instructions.md: ${error.message}`);
     }
 
-    // Copy guidelines folder to project root
-    const guidelinesSrcPath = pathModule.join(__dirname, '..', '..', 'abap', 'guidelines');
+    // Create guidelines/ directory and objects.local.md stub
+    // (Standard guidelines are bundled in the package — no need to copy them)
     const guidelinesDestPath = pathModule.join(process.cwd(), 'guidelines');
     try {
-      if (fs.existsSync(guidelinesSrcPath)) {
-        if (!fs.existsSync(guidelinesDestPath)) {
-          // Create guidelines directory
-          fs.mkdirSync(guidelinesDestPath, { recursive: true });
-          // Copy all files from guidelines folder
-          const files = fs.readdirSync(guidelinesSrcPath);
-          for (const file of files) {
-            if (file.endsWith('.md')) {
-              fs.copyFileSync(
-                pathModule.join(guidelinesSrcPath, file),
-                pathModule.join(guidelinesDestPath, file)
-              );
-            }
-          }
-          console.log(`✅ Created guidelines/ (${files.filter(f => f.endsWith('.md')).length} files)`);
-        } else {
-          console.log(`⚠️  guidelines/ already exists, skipped`);
-        }
+      if (!fs.existsSync(guidelinesDestPath)) {
+        fs.mkdirSync(guidelinesDestPath, { recursive: true });
+        console.log(`✅ Created guidelines/`);
+      }
 
-        // Create objects.local.md stub if not already present
-        const localNamingPath = pathModule.join(guidelinesDestPath, 'objects.local.md');
-        if (!fs.existsSync(localNamingPath)) {
-          const localNamingStub = `---
+      // 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
 ---
 
@@ -473,14 +510,11 @@ Uncomment and edit the rows that differ from the defaults in \`guidelines/object
 | 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`);
+        fs.writeFileSync(localNamingPath, localNamingStub);
+        console.log(`✅ Created guidelines/objects.local.md (project naming conventions)`);
       }
     } catch (error) {
-      console.error(`Error copying guidelines: ${error.message}`);
+      console.error(`Error creating guidelines: ${error.message}`);
     }
 
     // Create folder
@@ -500,11 +534,44 @@ Uncomment and edit the rows that differ from the defaults in \`guidelines/object
       console.error(`Error creating folder: ${error.message}`);
     }
 
+    // Create .abapgit.xml with correct STARTING_FOLDER so abapGit's remove_ignored_files()
+    // keeps files inside the source folder. Without this file the stored starting_folder in
+    // the ABAP persistence may not match the actual folder, causing all remote files to be
+    // silently ignored and pull to return ACTIVATED_COUNT=0 with an empty log.
+    const abapgitXmlPath = pathModule.join(process.cwd(), '.abapgit.xml');
+    if (!fs.existsSync(abapgitXmlPath)) {
+      const language = (config.language || 'E').toUpperCase().charAt(0);
+      const abapgitXml = `<?xml version="1.0" encoding="utf-8"?>
+<asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
+ <asx:values>
+  <DATA>
+   <MASTER_LANGUAGE>${language}</MASTER_LANGUAGE>
+   <STARTING_FOLDER>${folder}</STARTING_FOLDER>
+   <FOLDER_LOGIC>${folderLogic}</FOLDER_LOGIC>
+  </DATA>
+ </asx:values>
+</asx:abap>
+`;
+      try {
+        fs.writeFileSync(abapgitXmlPath, abapgitXml);
+        console.log(`✅ Created .abapgit.xml (STARTING_FOLDER=${folder}, FOLDER_LOGIC=${folderLogic})`);
+      } catch (error) {
+        console.error(`Error creating .abapgit.xml: ${error.message}`);
+      }
+    } else {
+      console.log(`✅ .abapgit.xml already exists, skipped`);
+    }
+
     console.log(`
 📋 Next steps:
    1. Edit .abapGitAgent with your ABAP credentials (host, user, password)
    2. Run 'abapgit-agent create --import' to create online repository
    3. Run 'abapgit-agent pull' to activate objects
+
+💡 Tips:
+   • Only guidelines/objects.local.md needs to live in your repo.
+     Standard guidelines are read from the package automatically via 'ref'.
+   • Run 'abapgit-agent guide' to read the full ABAP development guide.
 `);
   }
 };

package/src/commands/pull.js

@@ -3,6 +3,8 @@
  */
 
 const { printHttpError } = require('../utils/format-error');
+const fs = require('fs');
+const pathModule = require('path');
 
 module.exports = {
   name: 'pull',
@@ -84,6 +86,20 @@ module.exports = {
         console.error('   Example: --files src/zcl_my_class.clas.abap');
         process.exit(1);
       }
+
+      // Validate that every specified file exists on disk.
+      // Skip when --url is explicit: the files belong to a different repository
+      // and won't be present in the current working directory.
+      if (urlArgIndex === -1) {
+        const fs = require('fs');
+        const missingFiles = files.filter(f => !fs.existsSync(f));
+        if (missingFiles.length > 0) {
+          console.error('❌ Error: the following file(s) do not exist:');
+          missingFiles.forEach(f => console.error(`     ${f}`));
+          console.error('   Check the path and try again.');
+          process.exit(1);
+        }
+      }
     }
 
     // SAFEGUARD 2: Check if files are required but not provided
@@ -102,22 +118,30 @@ module.exports = {
     if (!transportRequest && !jsonOutput) {
       const { selectTransport, isNonInteractive, _getTransportHookConfig } = require('../utils/transport-selector');
 
-      // Check if this package requires a transport before showing the interactive
-      // picker. Skip the status round-trip in non-interactive mode — selectTransport
-      // already returns null there without prompting, so the extra HTTP call is wasted.
-      let transportRequired = true; // Safe default: assume transport needed
-      if (!isNonInteractive()) {
-        try {
-          const config = loadConfig();
-          const http = new AbapHttp(config);
-          const csrfToken = await http.fetchCsrfToken();
-          const statusResult = await http.post('/sap/bc/z_abapgit_agent/status', { url: gitUrl }, { csrfToken });
-          if (statusResult.transport_required === false || statusResult.transport_required === 'false') {
-            transportRequired = false;
-          }
-        } catch (e) {
-          // Status check failed — proceed with selector as safe default
-        }
+      // Check repository status — confirms the repo is registered and tells us
+      // whether a transport is required. If the check fails, abort: pulling into
+      // an uninitialised repository does not make sense.
+      let transportRequired = false;
+      let statusResult;
+      try {
+        const config = loadConfig();
+        const http = new AbapHttp(config);
+        const csrfToken = await http.fetchCsrfToken();
+        statusResult = await http.post('/sap/bc/z_abapgit_agent/status', { url: gitUrl }, { csrfToken });
+      } catch (e) {
+        console.error(`❌ Repository status check failed: ${e.message}`);
+        console.error('   Make sure the repository is registered with abapgit-agent (run "abapgit-agent create").');
+        process.exit(1);
+      }
+
+      if (!statusResult || statusResult.status === 'Not found') {
+        console.error(`❌ Repository not found in ABAP system: ${gitUrl}`);
+        console.error('   Run "abapgit-agent create" to register it first.');
+        process.exit(1);
+      }
+
+      if (statusResult.transport_required === true || statusResult.transport_required === 'true') {
+        transportRequired = true;
       }
 
       if (transportRequired) {
@@ -147,10 +171,10 @@ module.exports = {
       }
     }
 
-    await this.pull(gitUrl, branch, files, transportRequest, loadConfig, AbapHttp, jsonOutput, undefined, conflictMode);
+    await this.pull(gitUrl, branch, files, transportRequest, loadConfig, AbapHttp, jsonOutput, undefined, conflictMode, verbose);
   },
 
-  async pull(gitUrl, branch = 'main', files = null, transportRequest = null, loadConfig, AbapHttp, jsonOutput = false, gitCredentials = undefined, conflictMode = 'abort') {
+  async pull(gitUrl, branch = 'main', files = null, transportRequest = null, loadConfig, AbapHttp, jsonOutput = false, gitCredentials = undefined, conflictMode = 'abort', verbose = false) {
     const TERM_WIDTH = process.stdout.columns || 80;
 
     if (!jsonOutput) {
@@ -196,12 +220,26 @@ module.exports = {
 
       const result = await http.post('/sap/bc/z_abapgit_agent/pull', data, { csrfToken });
 
+      // Detect missing .abapgit.xml — without it abapGit's stored starting_folder
+      // may not match the actual source folder, causing pull to silently return ACTIVATED_COUNT=0
+      const missingAbapgitXml = fs.existsSync(pathModule.join(process.cwd(), '.git')) &&
+          !fs.existsSync(pathModule.join(process.cwd(), '.abapgit.xml'));
+
       // JSON output mode
       if (jsonOutput) {
+        if (missingAbapgitXml) {
+          result.missing_abapgit_xml = true;
+        }
         console.log(JSON.stringify(result, null, 2));
         return result;
       }
 
+      if (missingAbapgitXml) {
+        console.warn('⚠️  .abapgit.xml not found in repository root.');
+        console.warn('   Pull may return ACTIVATED_COUNT=0 if the ABAP-side starting_folder is wrong.');
+        console.warn('   Run: abapgit-agent init --package <PACKAGE> to create it.\n');
+      }
+
       console.log('\n');
 
       // Display raw result for debugging
@@ -285,6 +323,13 @@ module.exports = {
       if (success === 'X' || success === true) {
         console.log(`✅ Pull completed successfully!`);
         console.log(`   Message: ${message || 'N/A'}`);
+      } else if (failedCount === 0 && failedObjects.length === 0 &&
+                 activatedCount === 0 && logMessages.length === 0 &&
+                 (!message || /activation cancelled|nothing to activate|already active/i.test(message))) {
+        // abapGit returns SUCCESS='' with "Activation cancelled" when there are
+        // no inactive objects to activate — the object is already active and consistent.
+        console.log(`✅ Pull completed — object already active, nothing to activate.`);
+        console.log(`   Message: ${message || 'N/A'}`);
       } else {
         console.error(`❌ Pull completed with errors!`);
         console.error(`   Message: ${message || 'N/A'}`);
@@ -393,8 +438,12 @@ module.exports = {
         console.log(`\n❌ Failed Objects Log (${failedCount})`);
       }
 
-      // Throw if pull was not successful so callers (e.g. upgrade) can detect failure
-      if (success !== 'X' && success !== true) {
+      // Throw if pull was not successful so callers (e.g. upgrade) can detect failure.
+      // Exception: SUCCESS='' with no failures and no log = object already active, not a real error.
+      const alreadyActive = failedCount === 0 && failedObjects.length === 0 &&
+                            activatedCount === 0 && logMessages.length === 0 &&
+                            (!message || /activation cancelled|nothing to activate|already active/i.test(message));
+      if (success !== 'X' && success !== true && !alreadyActive) {
         const err = new Error(message || 'Pull completed with errors');
         err._isPullError = true;
         throw err;