```

feat: Enhance commit summary generation with optional description
- Updated the APIClient to include a parameter for generating detailed commit descriptions using a local LLM client.
- Modified the CommitDocGenHook to support the new parameter, allowing for more flexible commit summary generation.
- Adjusted the commit_code function to accept a flag for description generation, improving user control over commit message details.
- Refined LLMClient's generate_commit_summary method to conditionally include a description based on the new parameter.
```

Author: sumansaurabh

penify_hook/api_client.py

@@ -1,6 +1,7 @@
 import json
 import os
 import requests
+from .llm_client import LLMClient
 
 class APIClient:
     def __init__(self, api_url, api_token: str = None, bearer_token: str = None):
@@ -111,7 +112,7 @@ def get_supported_file_types(self) -> list[str]:
         else:
             return ["py", "js", "ts", "java", "kt", "cs", "c"]
 
-    def generate_commit_summary_with_llm(self, diff, message, repo_details, llm_client, jira_context=None):
+    def generate_commit_summary_with_llm(self, diff, message, generate_description: bool, repo_details, llm_client : LLMClient, jira_context=None):
         """
         Generate a commit summary using a local LLM client instead of the API.
         
@@ -126,7 +127,7 @@ def generate_commit_summary_with_llm(self, diff, message, repo_details, llm_clie
             Dict with title and description for the commit
         """
         try:
-            return llm_client.generate_commit_summary(diff, message, repo_details, jira_context)
+            return llm_client.generate_commit_summary(diff, message, generate_description, repo_details, jira_context)
         except Exception as e:
             print(f"Error using local LLM: {e}")
             # Fall back to API for commit summary

penify_hook/commands/commit_commands.py

@@ -17,7 +17,7 @@
 except ImportError:
     JiraClient = None
 
-def commit_code(api_url, token, message, open_terminal, 
+def commit_code(api_url, token, message, open_terminal, generate_description,
                llm_model=None, llm_api_base=None, llm_api_key=None,
                jira_url=None, jira_user=None, jira_api_token=None):
     """
@@ -65,7 +65,7 @@ def commit_code(api_url, token, message, open_terminal,
         # Pass the LLM client and JIRA client to CommitDocGenHook
         gf_path = recursive_search_git_folder(os.getcwd())
         analyzer = CommitDocGenHook(gf_path, api_client, llm_client, jira_client)
-        analyzer.run(message, open_terminal)
+        analyzer.run(message, open_terminal, generate_description)
     except Exception as e:
         print(f"Error: {e}")
         sys.exit(1)

penify_hook/commit_analyzer.py

@@ -16,7 +16,7 @@ def __init__(self, repo_path: str, api_client: APIClient, llm_client=None, jira_
         self.llm_client = llm_client  # Add LLM client as an optional parameter
         self.jira_client = jira_client  # Add JIRA client as an optional parameter
 
-    def get_summary(self, instruction: str):
+    def get_summary(self, instruction: str, generate_description: bool) -> dict:
         """Generate a summary for the commit based on the staged changes.
 
         This function retrieves the differences of the staged changes in the
@@ -57,13 +57,13 @@ def get_summary(self, instruction: str):
         # Use LLM client if provided, otherwise use API client
         if self.llm_client:
             return self.api_client.generate_commit_summary_with_llm(
-                diff, instruction, self.repo_details, self.llm_client, jira_context
+                diff, instruction, generate_description, self.repo_details, self.llm_client, jira_context
             )
         else:
             return self.api_client.generate_commit_summary(diff, instruction, self.repo_details, jira_context)
 
 
-    def run(self, msg: Optional[str], edit_commit_message: bool):
+    def run(self, msg: Optional[str], edit_commit_message: bool, generate_description: bool):
         """Run the post-commit hook.
 
         This method retrieves the list of modified files from the last commit
@@ -81,7 +81,7 @@ def run(self, msg: Optional[str], edit_commit_message: bool):
         Raises:
             Exception: If there is an error generating the commit summary.
         """
-        summary: dict = self.get_summary(msg)
+        summary: dict = self.get_summary(msg, generate_description)
         if not summary:
             raise Exception("Error generating commit summary")
 

penify_hook/llm_client.py

@@ -27,7 +27,7 @@ def __init__(self, model: str = None, api_base: str = None, api_key: str = None)
         if api_key:
             os.environ["OPENAI_API_KEY"] = api_key
 
-    def generate_commit_summary(self, diff: str, message: str, repo_details: Dict, jira_context: Dict = None) -> Dict:
+    def generate_commit_summary(self, diff: str, message: str, generate_description: bool, repo_details: Dict, jira_context: Dict = None) -> Dict:
         """
         Generate a commit summary using the LLM.
         
@@ -92,7 +92,7 @@ def generate_commit_summary(self, diff: str, message: str, repo_details: Dict, j
         
         Please provide:
         1. A short, focused commit title (50-72 characters) in a Semantic Commit Messages format. Format: <type>(<scope>): <subject>
-        2. A detailed description that explains what was changed, why it was changed in both business and technical aspects, and any important context
+        {'2. A detailed description that explains what was changed, why it was changed in both business and technical aspects, and any important context' if generate_description else ''}
 
         List of Semantic Commit Message types that you can use:
         feat: (new feature for the user, not a new feature for build script)
@@ -103,8 +103,9 @@ def generate_commit_summary(self, diff: str, message: str, repo_details: Dict, j
         test: (adding missing tests, refactoring tests; no production code change)
         chore: (updating grunt tasks etc; no production code change)
         
-        Format your response as valid JSON with 'title' and 'description' keys.
+        Format your response as valid JSON with 'title' {"and 'description'" if generate_description else ''} keys.
         """
+        print(prompt)
 
         try:
             # Call the LLM using litellm

penify_hook/main.py

@@ -155,32 +155,24 @@ def main():
     elif args.subcommand == "commit":
         # For commit, token is now optional - some functionality may be limited without it
         open_terminal = args.terminal
+        generate_description = args.description
 
-        # Get LLM configuration
-        llm_model = args.llm_model
-        llm_api_base = args.llm_api_base
-        llm_api_key = args.llm_api_key
+        # Try to get from config
+        llm_config = get_llm_config()
+        llm_model = llm_config.get('model')
+        llm_api_base = llm_config.get('api_base') 
+        llm_api_key = llm_config.get('api_key')
 
-        if not llm_model:
-            # Try to get from config
-            llm_config = get_llm_config()
-            llm_model = llm_config.get('model')
-            llm_api_base = llm_config.get('api_base') if not llm_api_base else llm_api_base
-            llm_api_key = llm_config.get('api_key') if not llm_api_key else llm_api_key
 
-        # Get JIRA configuration
-        jira_url = args.jira_url
-        jira_user = args.jira_user
-        jira_api_token = args.jira_api_token
-        
-        if not jira_url or not jira_user or not jira_api_token:
-            # Try to get from config
-            jira_config = get_jira_config()
-            jira_url = jira_url or jira_config.get('url')
-            jira_user = jira_user or jira_config.get('username')
-            jira_api_token = jira_api_token or jira_config.get('api_token')
-        
-        commit_code(API_URL, token, args.message, open_terminal,
+       
+        # Try to get from config
+        jira_config = get_jira_config()
+        jira_url = jira_config.get('url')
+        jira_user = jira_config.get('username')
+        jira_api_token = jira_config.get('api_token')
+
+    
+        commit_code(API_URL, token, args.message, open_terminal, generate_description,
                    llm_model, llm_api_base, llm_api_key,
                    jira_url, jira_user, jira_api_token)