@juspay/yama 1.5.1 → 1.6.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [1.6.0](https://github.com/juspay/yama/compare/v1.5.1...v1.6.0) (2025-10-24)
+
+### Features
+
+- added support for system prompt and fixed required section check in description enhancer ([c22d1ff](https://github.com/juspay/yama/commit/c22d1ff15a165379dece65145123433f7c1d6b98))
+
 ## [1.5.1](https://github.com/juspay/yama/compare/v1.5.0...v1.5.1) (2025-09-24)
 
 ### Bug Fixes

package/dist/core/Guardian.js

@@ -59,7 +59,13 @@ export class Guardian {
                 fallbackPaths: ["docs/memory-bank", ".memory-bank"],
             });
             this.codeReviewer = new CodeReviewer(this.bitbucketProvider, this.config.providers.ai, this.config.features.codeReview);
-            this.descriptionEnhancer = new DescriptionEnhancer(this.bitbucketProvider, this.config.providers.ai);
+            this.descriptionEnhancer = new DescriptionEnhancer(this.bitbucketProvider, this.config.providers.ai, this.config.features.descriptionEnhancement);
+            logger.debug("Description Enhancement Configuration:");
+            logger.debug(`  - Enabled: ${this.config.features.descriptionEnhancement.enabled}`);
+            logger.debug(`  - Required Sections: ${this.config.features.descriptionEnhancement.requiredSections.length} (${this.config.features.descriptionEnhancement.requiredSections.map((s) => s.key).join(", ")})`);
+            logger.debug(`  - Custom systemPrompt: ${this.config.features.descriptionEnhancement.systemPrompt ? "Yes" : "No (using default)"}`);
+            logger.debug(`  - Custom enhancementInstructions: ${this.config.features.descriptionEnhancement.enhancementInstructions ? "Yes" : "No (using default)"}`);
+            logger.debug(`  - outputTemplate: ${this.config.features.descriptionEnhancement.outputTemplate ? "Provided" : "Not provided"}`);
             this.initialized = true;
             logger.success("✅ Yama initialized successfully");
         }

package/dist/features/DescriptionEnhancer.d.ts

@@ -2,15 +2,21 @@
  * Enhanced Description Enhancer - Optimized to work with Unified Context
  * Preserves all original functionality from pr-describe.js but optimized
  */
-import { EnhancementOptions, EnhancementResult, AIProviderConfig } from "../types/index.js";
+import { EnhancementOptions, EnhancementResult, AIProviderConfig, DescriptionEnhancementConfig } from "../types/index.js";
 import { UnifiedContext } from "../core/ContextGatherer.js";
 import { BitbucketProvider } from "../core/providers/BitbucketProvider.js";
 export declare class DescriptionEnhancer {
     private neurolink;
     private bitbucketProvider;
     private aiConfig;
+    private enhancementConfig;
     private defaultRequiredSections;
-    constructor(bitbucketProvider: BitbucketProvider, aiConfig: AIProviderConfig);
+    constructor(bitbucketProvider: BitbucketProvider, aiConfig: AIProviderConfig, enhancementConfig: DescriptionEnhancementConfig);
+    /**
+     * Get system prompt for description enhancement
+     * Uses config.systemPrompt if provided, otherwise uses default
+     */
+    private getSystemPrompt;
     /**
      * Enhance description using pre-gathered unified context (OPTIMIZED)
      */
@@ -60,5 +66,5 @@ export declare class DescriptionEnhancer {
      */
     getStats(): any;
 }
-export declare function createDescriptionEnhancer(bitbucketProvider: BitbucketProvider, aiConfig: AIProviderConfig): DescriptionEnhancer;
+export declare function createDescriptionEnhancer(bitbucketProvider: BitbucketProvider, aiConfig: AIProviderConfig, enhancementConfig: DescriptionEnhancementConfig): DescriptionEnhancer;
 //# sourceMappingURL=DescriptionEnhancer.d.ts.map

package/dist/features/DescriptionEnhancer.js

@@ -8,6 +8,7 @@ export class DescriptionEnhancer {
     neurolink;
     bitbucketProvider;
     aiConfig;
+    enhancementConfig;
     defaultRequiredSections = [
         { key: "changelog", name: "Changelog (Modules Modified)", required: true },
         {
@@ -21,9 +22,33 @@ export class DescriptionEnhancer {
             required: true,
         },
     ];
-    constructor(bitbucketProvider, aiConfig) {
+    constructor(bitbucketProvider, aiConfig, enhancementConfig) {
         this.bitbucketProvider = bitbucketProvider;
         this.aiConfig = aiConfig;
+        this.enhancementConfig = enhancementConfig;
+    }
+    /**
+     * Get system prompt for description enhancement
+     * Uses config.systemPrompt if provided, otherwise uses default
+     */
+    getSystemPrompt() {
+        const isCustomPrompt = !!this.enhancementConfig.systemPrompt;
+        if (isCustomPrompt) {
+            logger.debug("✓ Using custom systemPrompt from configuration");
+            logger.debug(`Custom prompt preview: ${this.enhancementConfig.systemPrompt?.substring(0, 100)}...`);
+        }
+        else {
+            logger.debug("Using default systemPrompt (no custom prompt configured)");
+        }
+        return (this.enhancementConfig.systemPrompt ||
+            `You are an Expert Technical Writer specializing in pull request documentation.
+Focus on clarity, completeness, and helping reviewers understand the changes.
+
+CRITICAL INSTRUCTION: Return ONLY the enhanced PR description content.
+- DO NOT add meta-commentary like "No description provided" or "Here is the enhanced description"
+- DO NOT add explanatory text about what you're doing
+- START directly with the actual PR content (title, sections, etc.)
+- If there's no existing description, just write the new sections without mentioning it`);
     }
     /**
      * Enhance description using pre-gathered unified context (OPTIMIZED)
@@ -34,7 +59,21 @@ export class DescriptionEnhancer {
             logger.phase("📝 Enhancing PR description...");
             logger.info(`Processing PR #${context.pr.id}: "${context.pr.title}"`);
             // Step 1: Analyze existing content and identify what needs enhancement
-            const analysisResult = this.analyzeExistingContent(context.pr.description, options.customSections || this.defaultRequiredSections);
+            const sectionsToUse = options.customSections || this.defaultRequiredSections;
+            logger.debug(`Checking ${sectionsToUse.length} required sections: ${sectionsToUse.map((s) => s.key).join(", ")}`);
+            const analysisResult = this.analyzeExistingContent(context.pr.description, sectionsToUse);
+            const presentSections = analysisResult.requiredSections
+                .filter((s) => s.present)
+                .map((s) => s.key);
+            const missingSections = analysisResult.requiredSections
+                .filter((s) => !s.present)
+                .map((s) => s.key);
+            if (presentSections.length > 0) {
+                logger.debug(`✓ Present sections: ${presentSections.join(", ")}`);
+            }
+            if (missingSections.length > 0) {
+                logger.debug(`✗ Missing sections: ${missingSections.join(", ")}`);
+            }
             logger.info(`Content analysis: ${analysisResult.preservedContent.media.length} media items, ` +
                 `${analysisResult.missingCount} missing sections`);
             // Step 2: Generate enhanced description using AI
@@ -135,15 +174,21 @@ export class DescriptionEnhancer {
             ],
         };
         return requiredSections.map((section) => {
-            const patterns = sectionPatterns[section.key];
-            const isPresent = patterns
-                ? patterns.some((pattern) => pattern.test(description))
-                : false;
+            let patterns = sectionPatterns[section.key];
+            if (!patterns) {
+                logger.debug(`No predefined pattern for section "${section.key}", using dynamic pattern based on name`);
+                const nameWords = section.name.split(/\s+/).filter((w) => w.length > 2); // Filter out short words like "Or", "Of"
+                const namePattern = new RegExp(`##.*?${nameWords.join(".*?")}`, "i");
+                const keyWords = section.key.split("_").filter((w) => w.length > 2);
+                const keyPattern = new RegExp(`##.*?${keyWords.join(".*?")}`, "i");
+                patterns = [namePattern, keyPattern];
+            }
+            const isPresent = patterns.some((pattern) => pattern.test(description));
             return {
                 ...section,
                 present: isPresent,
                 content: isPresent
-                    ? this.extractSectionContent(description, patterns || [])
+                    ? this.extractSectionContent(description, patterns)
                     : "",
             };
         });
@@ -207,6 +252,7 @@ export class DescriptionEnhancer {
         try {
             const result = await this.neurolink.generate({
                 input: { text: enhancementPrompt },
+                systemPrompt: this.getSystemPrompt(), // Use config or default system prompt
                 provider: this.aiConfig.provider,
                 model: this.aiConfig.model,
                 temperature: this.aiConfig.temperature || 0.7,
@@ -224,6 +270,13 @@ export class DescriptionEnhancer {
                 .replace(/^```markdown\s*/, "")
                 .replace(/\s*```$/, "")
                 .trim();
+            // Remove any meta-commentary that AI might have added
+            enhancedDescription = enhancedDescription
+                .replace(/^No description provided\.?\s*/i, "")
+                .replace(/^Here is the enhanced description:?\s*/i, "")
+                .replace(/^I will enhance.*?:\s*/i, "")
+                .replace(/^Enhanced description:?\s*/i, "")
+                .trim();
             if (!enhancedDescription) {
                 throw new Error("AI generated empty description");
             }
@@ -231,7 +284,12 @@ export class DescriptionEnhancer {
             const finalValidation = this.validateRequiredSections(enhancedDescription, options.customSections || this.defaultRequiredSections);
             const stillMissing = finalValidation.filter((s) => !s.present);
             if (stillMissing.length > 0) {
-                logger.warn(`Warning: ${stillMissing.length} required sections still missing after AI enhancement`);
+                const missingSectionNames = stillMissing.map((s) => s.key).join(", ");
+                logger.warn(`Warning: ${stillMissing.length} required sections still missing after AI enhancement: ${missingSectionNames}`);
+                logger.debug(`AI may not have added these sections or they don't match detection patterns`);
+            }
+            else {
+                logger.debug(`✓ All ${finalValidation.length} required sections are now present`);
             }
             return enhancedDescription;
         }
@@ -260,7 +318,15 @@ export class DescriptionEnhancer {
             diffInfo = `**Diff Strategy**: File-by-file analysis (${context.diffStrategy.fileCount} files)
 **Modified Files**: ${JSON.stringify(fileList, null, 2)}`;
         }
-        return `You are an expert technical writer specializing in comprehensive PR descriptions.
+        const customInstructions = this.enhancementConfig.enhancementInstructions || "";
+        if (customInstructions) {
+            logger.debug("✓ Using custom enhancementInstructions from configuration");
+            logger.debug(`Instructions preview: ${customInstructions.substring(0, 80)}...`);
+        }
+        else {
+            logger.debug("Using default enhancementInstructions");
+        }
+        return `${customInstructions || "You are an expert technical writer specializing in comprehensive PR descriptions."}
 
 ## PR INFORMATION:
 **Title**: ${context.pr.title}
@@ -439,7 +505,7 @@ Generate the enhanced description now, ensuring ALL preservation requirements ar
         };
     }
 }
-export function createDescriptionEnhancer(bitbucketProvider, aiConfig) {
-    return new DescriptionEnhancer(bitbucketProvider, aiConfig);
+export function createDescriptionEnhancer(bitbucketProvider, aiConfig, enhancementConfig) {
+    return new DescriptionEnhancer(bitbucketProvider, aiConfig, enhancementConfig);
 }
 //# sourceMappingURL=DescriptionEnhancer.js.map

package/dist/utils/ConfigManager.js

@@ -80,7 +80,7 @@ export class ConfigManager {
                     },
                 ],
                 autoFormat: true,
-                systemPrompt: "You are an Expert Technical Writer specializing in pull request documentation. Your role is to:\n\n📝 CLARITY FIRST: Create clear, comprehensive PR descriptions that help reviewers understand the changes\n🎥 STORY TELLING: Explain the 'why' behind changes, not just the 'what'\n📈 STRUCTURED: Follow consistent formatting with required sections\n🔗 CONTEXTUAL: Link changes to business value and technical rationale\n\nCRITICAL INSTRUCTION: Return ONLY the enhanced PR description content as clean markdown. Do NOT include any meta-commentary, explanations about what you're doing, or introductory text like \"I will enhance...\" or \"Here is the enhanced description:\". \n\nOutput the enhanced description directly without any wrapper text or explanations.",
+                systemPrompt: "You are an Expert Technical Writer specializing in pull request documentation. Your role is to:\n\n📝 CLARITY FIRST: Create clear, comprehensive PR descriptions that help reviewers understand the changes\n🎥 STORY TELLING: Explain the 'why' behind changes, not just the 'what'\n📈 STRUCTURED: Follow consistent formatting with required sections\n🔗 CONTEXTUAL: Link changes to business value and technical rationale\n\nCRITICAL INSTRUCTION: Return ONLY the enhanced PR description content as clean markdown.\n- DO NOT add meta-commentary like \"No description provided\" or \"Here is the enhanced description\"\n- DO NOT add explanatory text about what you're doing\n- START directly with the actual PR content (sections, lists, explanations)\n- If there's no existing description, just write the new sections without mentioning it\n\nOutput the enhanced description directly without any wrapper text or explanations.",
                 outputTemplate: "# PR Title Enhancement (if needed)\n\n## Summary\n[Clear overview of what this PR accomplishes]\n\n## Changes Made\n[Specific technical changes - be precise]\n\n## Testing\n[How the changes were tested]\n\n## Impact\n[Business/technical impact and considerations]\n\n## Additional Notes\n[Any deployment notes, follow-ups, or special considerations]",
                 enhancementInstructions: 'Return ONLY the enhanced PR description as clean markdown. Do NOT include any explanatory text, meta-commentary, or phrases like "Here is the enhanced description:" or "I will enhance...".\n\nStart directly with the enhanced description content using this structure:',
             },
@@ -244,11 +244,10 @@ export class ConfigManager {
      * Apply provider-aware token limits using shared utility
      */
     applyProviderTokenLimits(config) {
-        const provider = config.providers.ai.provider || 'auto';
+        const provider = config.providers.ai.provider || "auto";
         const configuredTokens = config.providers.ai.maxTokens;
         // Use the shared utility to validate and adjust token limits
-        const validatedTokens = validateProviderTokenLimit(provider, configuredTokens, false // Use standard limits for configuration
-        );
+        const validatedTokens = validateProviderTokenLimit(provider, configuredTokens, false);
         config.providers.ai.maxTokens = validatedTokens;
         return config;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juspay/yama",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "Enterprise-grade Pull Request automation toolkit with AI-powered code review and description enhancement",
   "keywords": [
     "pr",

package/yama.config.example.yaml

@@ -109,6 +109,7 @@ features:
     enabled: true
     preserveContent: true # Always preserve existing content
     autoFormat: true
+
     requiredSections:
       - key: "changelog"
         name: "Changelog (Modules Modified)"
@@ -120,6 +121,16 @@ features:
         name: "CAC Config Or Service Config Changes"
         required: true
 
+    # Customize AI behavior:
+    systemPrompt: |
+      You are a Senior Staff Engineer writing comprehensive technical documentation.
+      Focus on architectural decisions, trade-offs, and long-term maintainability.
+
+    # Customize formatting:
+    enhancementInstructions: |
+      Keep descriptions under 300 words. Use bullet points, not paragraphs.
+      No emojis. Professional tone only. Include numbers and metrics.
+
   # NEW: Diff Strategy Configuration
   diffStrategy:
     enabled: true