commitgpt 0.3.10 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc50a5ed7cfb5cc59703014b3b6f58370028dfe2c1bc5c7186e3c6d43a755dd7
-  data.tar.gz: e9dd5c01f7c07062fc803710c79a31ce40ab9a9625918c2753bf59d25b4f9d4b
+  metadata.gz: ab9b9d8c6894ba37e2e16881e28fc2772336f5056f53330f91451818c5a28e36
+  data.tar.gz: e4a4d6a33c7a0270725af5e79f1da44bac5111c9810bb799231631336a5aa4c5
 SHA512:
-  metadata.gz: 2005518993b77ff65ab764075016d6c1a8bb1259efff645017ab3f0a23a83f03e1b18fc7df257f497a8ecf5a705d4a0c91c29a5e044d00e9896437faed7cf675
-  data.tar.gz: d290dac27335967df2b7dfdc8309509f7f228ede0d50c7e0b86e99c28cb16b1551d2bb5004ce3d846a183f1fb85beda193d5fec2873ad9e397211fa6e93ceb26
+  metadata.gz: 7610f6291cffa1b70c7d9735096962a7e1a25f62d5b6e512c6688d0d80d1cd71961798d5867e77c0bc94dd58db027cd76168ecf833ab07fb886818b370d88616
+  data.tar.gz: fbf38cd92931dddfdb1acdf9d7a8ec290d33376fab4fd769a480f6e45a4da8a495624e8143dd58592a51294ecd5c959316143744e9ee3eb6fce395b09cfd09fc

data/README.md

@@ -17,9 +17,12 @@ The easiest way to install and keep CommitGPT updated.
 
 ```bash
 brew tap ZPVIP/commitgpt https://github.com/ZPVIP/commitgpt
+brew trust zpvip/commitgpt
 brew install commitgpt
 ```
 
+> **Note**: Recent Homebrew versions refuse to load formulae from third-party taps until you trust them, so `brew trust` is required before installing.
+
 **Upgrade:**
 
 ```bash
@@ -194,8 +197,41 @@ docs: update API documentation
 📝 update API documentation
 ```
 
+### Choose Commit Message Detail Level
+Select how much the commit message says:
+```bash
+$ aicm -d
+# or
+$ aicm --detail
+```
+
+- **Concise** - Subject line only (default)
+- **Detailed** - Subject line, an explanatory paragraph, and a bullet list of notable changes
+
+This is independent of the format above: the format decides how the subject line is written, the detail level decides how much follows it. Your selection is saved as `commit_detail` in `~/.config/commitgpt/config.yml`.
+
+#### Detail Examples
+
+**Concise:**
+```
+feat(dfb): store and expand DFB event and speed logs
+```
+
+**Detailed:**
+```
+feat(dfb): store and expand DFB event and speed logs
+
+Persist DFB device logs ingested from the proactive `evt` (event log) and
+`lge` (speed stats) topics, one record per message.
+
+- Add `dfb_event_logs` and `dfb_speed_stats` tables and models, each with an
+  idempotent unique index so re-delivery and overlapping backfills are safe.
+- Associate both log tables on `Product`.
+- Update `README_DFB.md` to document the cloud tables.
+```
+
 ### Check Configuration
-View your current configuration (Provider, Model, Format, Base URL, Diff Len):
+View your current configuration (Provider, Model, Format, Detail, Base URL, Diff Len):
 ```bash
 $ aicm help
 ```

data/lib/commitgpt/cli.rb

@@ -14,6 +14,7 @@ module CommitGpt
     method_option :verbose, aliases: '-v', type: :boolean, desc: 'Show git diff being sent to AI'
     method_option :provider, aliases: '-p', type: :boolean, desc: 'Switch active provider'
     method_option :format, aliases: '-f', type: :boolean, desc: 'Choose commit message format'
+    method_option :detail, aliases: '-d', type: :boolean, desc: 'Choose commit message detail level'
     def generate
       if options[:provider]
         CommitGpt::SetupWizard.new.switch_provider
@@ -21,6 +22,8 @@ module CommitGpt
         CommitGpt::SetupWizard.new.change_model
       elsif options[:format]
         CommitGpt::SetupWizard.new.choose_format
+      elsif options[:detail]
+        CommitGpt::SetupWizard.new.choose_detail
       else
         CommitGpt::CommitAi.new.aicm(verbose: options[:verbose])
       end
@@ -42,6 +45,7 @@ module CommitGpt
       shell.say '  -m, --models             # Interactive model selection'
       shell.say '  -p, --provider           # Switch active provider'
       shell.say '  -f, --format             # Choose commit message format'
+      shell.say '  -d, --detail             # Choose commit message detail level'
       shell.say '  -v, --verbose            # Show git diff being sent to AI'
       shell.say ''
 
@@ -61,6 +65,7 @@ module CommitGpt
           shell.say "  Provider:  #{config['name'].green}"
           shell.say "  Model:     #{config['model'].cyan}"
           shell.say "  Format:    #{format.capitalize.yellow}"
+          shell.say "  Detail:    #{CommitGpt::ConfigManager.get_commit_detail.capitalize.yellow}"
           shell.say "  Base URL:  #{config['base_url']}"
           shell.say "  Diff Len:  #{config['diff_len']}"
           shell.say "  Timeout:   #{CommitGpt::ConfigManager.get_model_fetch_timeout}s"

data/lib/commitgpt/commit_ai.rb

@@ -25,6 +25,26 @@ module CommitGpt
       'gitmoji' => ':emoji: <commit message>'
     }.freeze
 
+    # Worked example of the detailed shape. Models follow a sample far more
+    # reliably than a description of one.
+    DETAILED_EXAMPLE = <<~EXAMPLE
+      Here is an example of the expected output, showing the exact shape only.
+      Your subject line must still follow the format above:
+
+      feat(dfb): store and expand DFB event and speed logs
+
+      Persist DFB device logs ingested from the proactive evt (event log) and
+      lge (speed stats) topics, one record per message.
+
+      - Add dfb_event_logs and dfb_speed_stats tables and models, each with an
+        idempotent unique index so re-delivery and overlapping backfills are safe.
+      - Add the canonical event-code table and the loader that expands a device
+        event byte into a human label and tags; unknown codes fall back to
+        "Unknown Event".
+      - Associate both log tables on Product.
+      - Update README_DFB.md to document the new cloud tables.
+    EXAMPLE
+
     # Conventional commit types based on aicommits implementation
     CONVENTIONAL_TYPES = {
       'docs' => 'Documentation only changes',
@@ -133,6 +153,72 @@ module CommitGpt
       end
 
       @commit_format = ConfigManager.get_commit_format
+      @commit_detail = ConfigManager.get_commit_detail
+    end
+
+    # True when the message should carry a body, not just a subject line
+    def detailed?
+      @commit_detail == 'detailed'
+    end
+
+    # Streaming cutoff. Generous because models that ignore disable_reasoning
+    # spend it on inline <think> text before the message itself arrives.
+    def max_content_chars
+      detailed? ? 6000 : 1500
+    end
+
+    def reasoning_disabled_max_tokens
+      detailed? ? 1200 : 300
+    end
+
+    # Some models stream their chain of thought inside content instead of the
+    # reasoning_content field, either wrapped in <think>...</think> or with only
+    # the closing tag when the chat template pre-fills the opener. Keep what
+    # comes after the thinking, never the thinking itself.
+    def strip_reasoning(content)
+      text = content.gsub(%r{<think(?:ing)?>.*?</think(?:ing)?>}m, '')
+      text = text.rpartition(%r{</think(?:ing)?>}).last if text.match?(%r{</think(?:ing)?>})
+      # Opener with no closer: the model never came back from thinking
+      text.sub(/<think(?:ing)?>.*\z/m, '')
+    end
+
+    # Header printed before the streamed message starts arriving
+    def content_prefix
+      detailed? ? "✦ Commit message:\n" : '✦ Commit message: git commit -am "'
+    end
+
+    # Closing quote that matches content_prefix; a body has no quote to close
+    def content_suffix
+      detailed? ? '' : '"'
+    end
+
+    # Editor git will actually use, resolved through its own precedence chain
+    def git_editor
+      editor = `git var GIT_EDITOR 2>/dev/null`.strip
+      editor.empty? ? 'your editor' : editor
+    end
+
+    # Models like to wrap the whole message in a fence despite being told not to
+    def strip_code_fence(text)
+      return text unless text.start_with?('```')
+
+      text.sub(/\A```[a-zA-Z]*\n?/, '').sub(/\n?```\s*\z/, '')
+    end
+
+    # Trim the model output down to what git should receive
+    def finalize_message(full_content)
+      content = strip_reasoning(full_content)
+
+      unless detailed?
+        # Take only the first non-empty line to avoid repetition or multi-line garbage
+        first_line = content.split("\n").map(&:strip).reject(&:empty?).first
+        return first_line&.gsub(/\A["']|["']\z/, '') || ''
+      end
+
+      body = strip_code_fence(content.strip).gsub(/\A["']|["']\z/, '').strip
+      # Keep the subject/body/bullets structure but drop trailing spaces and
+      # collapse the extra blank lines models like to emit between sections
+      body.split("\n").map(&:rstrip).join("\n").gsub(/\n{3,}/, "\n\n")
     end
 
     def aicm(verbose: false)
@@ -150,9 +236,10 @@ module CommitGpt
 
         case action
         when :commit
-          commit_command = "git commit -m \"#{ai_commit_message}\""
-          puts "\n→ Executing: #{commit_command}".yellow
-          system(commit_command)
+          # Pass argv directly: a body with quotes, backticks or newlines must
+          # not be re-interpreted by the shell
+          puts "\n→ Executing: git commit -m <message>".yellow
+          system('git', 'commit', '-m', ai_commit_message)
           puts "\n\n"
           puts `git log -1`
           break
@@ -160,15 +247,15 @@ module CommitGpt
           puts "\n"
           next
         when :edit
-          prompt = TTY::Prompt.new
-          new_message = prompt.ask('Enter your commit message:')
-          if new_message && !new_message.strip.empty?
-             commit_command = "git commit -m \"#{new_message}\""
-             system(commit_command)
-             puts "\n"
-             puts `git log -1`
+          # Let git open the message in the user's editor: it honours the
+          # GIT_EDITOR/core.editor/VISUAL/EDITOR chain, handles multi-line
+          # bodies, and aborts by itself if the message is left empty
+          puts "\n→ Opening #{git_editor} with the generated message...".yellow
+          if system('git', 'commit', '-e', '-m', ai_commit_message)
+            puts "\n"
+            puts `git log -1`
           else
-             puts '✖ Commit aborted (empty message).'.red
+            puts '✖ Commit aborted.'.red
           end
           break
         when :exit
@@ -219,7 +306,7 @@ module CommitGpt
         prompt.select('Action:') do |menu|
           menu.choice 'Commit', :commit
           menu.choice 'Regenerate', :regenerate
-          menu.choice 'Edit', :edit
+          menu.choice 'Edit in editor', :edit
           menu.choice 'Exit without commit', :exit
         end
       rescue TTY::Reader::InputInterrupt, Interrupt
@@ -279,7 +366,11 @@ module CommitGpt
     # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/BlockLength
     def generate_commit(diff = '', chunk_label: nil)
       # Build format-specific prompt
-      base_prompt = 'Generate a concise git commit message title in present tense that precisely describes the key changes in the following code diff. Focus on what was changed, not just file names. Provide only the title, no description or body.'
+      base_prompt = if detailed?
+                      'Generate a git commit message in present tense that precisely describes the key changes in the following code diff. Focus on what was changed and why, not just file names.'
+                    else
+                      'Generate a concise git commit message title in present tense that precisely describes the key changes in the following code diff. Focus on what was changed, not just file names. Provide only the title, no description or body.'
+                    end
 
       format_instruction = case @commit_format
                            when 'conventional'
@@ -290,17 +381,42 @@ module CommitGpt
                              ''
                            end
 
-      format_spec = "The output response must be in format:\n#{COMMIT_FORMATS[@commit_format]}"
+      format_spec = if detailed?
+                      "The subject line must be in format:\n#{COMMIT_FORMATS[@commit_format]}\n\n#{DETAILED_EXAMPLE}"
+                    else
+                      "The output response must be in format:\n#{COMMIT_FORMATS[@commit_format]}"
+                    end
+
+      rules = if detailed?
+                [
+                  '- The first line is the subject: a maximum of 100 characters, no trailing period.',
+                  '- Then one blank line, then a body paragraph of 1-3 sentences explaining what changed and why.',
+                  '- Then one blank line, then a bullet list where each bullet starts with "- " and describes one notable change.',
+                  '- Wrap body and bullet text at 72 characters.',
+                  '- Cover the whole diff in 3-6 bullets. Group related files into one bullet instead of listing every file.',
+                  '- Be specific: include concrete details (file, table, method, package names) rather than generic statements.',
+                  '- Do not use markdown headings, bold, or code fences. Plain text only.',
+                  '- Write the message directly. Do not think out loud, do not draft and revise, do not explain your reasoning, do not mention the diff or these instructions.',
+                  '- Do not emit <think> tags or any text before the subject line.',
+                  '- Stop immediately after the last bullet. Do not add a summary, a closing remark, or a second version of the message.',
+                  '- Exclude anything unnecessary such as translation. Your entire response will be passed directly into git commit.',
+                  '- Return ONLY the commit message, nothing else. No explanations, no introductions, no surrounding quotes.'
+                ]
+              else
+                [
+                  '- Commit message must be a maximum of 100 characters.',
+                  '- Exclude anything unnecessary such as translation. Your entire response will be passed directly into git commit.',
+                  '- IMPORTANT: Do not include any explanations, introductions, or additional text. Do not wrap the commit message in quotes or any other formatting. The commit message must not exceed 100 characters. Respond with ONLY the commit message text.',
+                  '- Be specific: include concrete details (package names, versions, functionality) rather than generic statements.',
+                  '- Return ONLY the commit message, nothing else.'
+                ]
+              end
 
       system_content = [
         base_prompt,
         'Message language: English.',
         'Rules:',
-        '- Commit message must be a maximum of 100 characters.',
-        '- Exclude anything unnecessary such as translation. Your entire response will be passed directly into git commit.',
-        '- IMPORTANT: Do not include any explanations, introductions, or additional text. Do not wrap the commit message in quotes or any other formatting. The commit message must not exceed 100 characters. Respond with ONLY the commit message text.',
-        '- Be specific: include concrete details (package names, versions, functionality) rather than generic statements.',
-        '- Return ONLY the commit message, nothing else.',
+        *rules,
         format_instruction,
         format_spec
       ].reject(&:empty?).join("\n")
@@ -331,7 +447,9 @@ module CommitGpt
 
       if can_disable_reasoning
         payload[:disable_reasoning] = true
-        payload[:max_tokens] = 300
+        # SGLang/vLLM back ends honour this where disable_reasoning is ignored
+        payload[:chat_template_kwargs] = { enable_thinking: false }
+        payload[:max_tokens] = reasoning_disabled_max_tokens
       else
         payload[:max_tokens] = configured_max_tokens
       end
@@ -379,7 +497,7 @@ module CommitGpt
               error_msg += " Raw: #{error_body}" unless error_body.to_s.strip.empty?
             end
 
-            if can_disable_reasoning && (error_msg =~ /parameter|reasoning|unsupported/i || response.code == '400')
+            if can_disable_reasoning && (error_msg =~ /parameter|reasoning|template|unsupported/i || response.code == '400')
                puts "⚠ Provider does not support 'disable_reasoning'. Updating config and retrying...".yellow
                ConfigManager.update_provider(provider_config['name'], { 'can_disable_reasoning' => false })
                @is_retrying = true
@@ -430,13 +548,13 @@ module CommitGpt
                     if chunk_label
                       print "◆ #{chunk_label}: ".magenta
                     else
-                      print '✦ Commit message: git commit -am "'.green
+                      print content_prefix.green
                     end
                     printed_content_prefix = true
                   end
 
                   # Prevent infinite loops/repetitive garbage
-                  if full_content.length + content_chunk.length > 300
+                  if full_content.length + content_chunk.length > max_content_chars
                     stop_stream = true
                     break
                   end
@@ -460,7 +578,7 @@ module CommitGpt
       end
 
       # Close the quote
-      puts(chunk_label ? '' : '"'.green) if printed_content_prefix
+      puts(chunk_label ? '' : content_suffix.green) if printed_content_prefix
 
       # Post-processing Logic (Retry if empty content)
       if (full_content.nil? || full_content.strip.empty?) && (full_reasoning && !full_reasoning.strip.empty?)
@@ -511,9 +629,7 @@ module CommitGpt
       # Reset retrying flag
       @is_retrying = false
 
-      # Take only the first non-empty line to avoid repetition or multi-line garbage
-      first_line = full_content.split("\n").map(&:strip).reject(&:empty?).first
-      first_line&.gsub(/\A["']|["']\z/, '') || ''
+      finalize_message(full_content)
     end
     # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/BlockLength
 
@@ -530,14 +646,31 @@ module CommitGpt
                              ''
                            end
 
+      rules = if detailed?
+                [
+                  '- The first line is the subject: a maximum of 100 characters, no trailing period.',
+                  '- Then one blank line, then a body paragraph of 1-3 sentences explaining what changed and why.',
+                  '- Then one blank line, then a bullet list where each bullet starts with "- " and describes one notable change.',
+                  '- Wrap body and bullet text at 72 characters.',
+                  '- Present tense.',
+                  '- Be specific: include concrete details rather than generic statements.',
+                  '- Do not use markdown headings, bold, or code fences. Plain text only.',
+                  '- Return ONLY the commit message, nothing else. No quotes, no explanations.'
+                ]
+              else
+                [
+                  '- Maximum 100 characters.',
+                  '- Present tense.',
+                  '- Be specific: include concrete details rather than generic statements.',
+                  '- Return ONLY the commit message, nothing else. No quotes, no explanations.'
+                ]
+              end
+
       system_content = [
         'You are given multiple commit messages generated from different segments of a single large git diff.',
-        'Synthesize them into ONE concise, unified git commit message that captures the overall change.',
+        "Synthesize them into ONE unified git commit message that captures the overall change.#{' Keep it concise.' unless detailed?}",
         'Rules:',
-        '- Maximum 100 characters.',
-        '- Present tense.',
-        '- Be specific: include concrete details rather than generic statements.',
-        '- Return ONLY the commit message, nothing else. No quotes, no explanations.',
+        *rules,
         format_instruction
       ].reject(&:empty?).join("\n")
 
@@ -558,7 +691,9 @@ module CommitGpt
 
       if can_disable_reasoning
         payload[:disable_reasoning] = true
-        payload[:max_tokens] = 300
+        # SGLang/vLLM back ends honour this where disable_reasoning is ignored
+        payload[:chat_template_kwargs] = { enable_thinking: false }
+        payload[:max_tokens] = reasoning_disabled_max_tokens
       else
         payload[:max_tokens] = provider_config['max_tokens'] || 2000
       end
@@ -606,11 +741,11 @@ module CommitGpt
                 content_chunk = delta['content']
                 if content_chunk && !content_chunk.empty?
                   unless printed_content_prefix
-                    print "\n✦ Commit message: git commit -am \"".green
+                    print "\n#{content_prefix}".green
                     printed_content_prefix = true
                   end
 
-                  if full_content.length + content_chunk.length > 300
+                  if full_content.length + content_chunk.length > max_content_chars
                     stop_stream = true
                     break
                   end
@@ -630,15 +765,14 @@ module CommitGpt
         return nil
       end
 
-      puts '"'.green if printed_content_prefix
+      puts content_suffix.green if printed_content_prefix
 
       if full_content.strip.empty?
         puts '✖ No response from AI during synthesis.'.red
         return nil
       end
 
-      first_line = full_content.split("\n").map(&:strip).reject(&:empty?).first
-      first_line&.gsub(/\A["']|["']\z/, '') || ''
+      finalize_message(full_content)
     end
   end
 end

data/lib/commitgpt/config_manager.rb

@@ -11,6 +11,11 @@ module CommitGpt
     # Seconds to wait when fetching a provider's model list
     DEFAULT_MODEL_FETCH_TIMEOUT = 30
 
+    # How much the commit message says: a subject line only, or a subject
+    # followed by an explanatory body
+    COMMIT_DETAILS = %w[concise detailed].freeze
+    DEFAULT_COMMIT_DETAIL = 'concise'
+
     class << self
       # Get the config directory path
       def config_dir
@@ -168,6 +173,23 @@ module CommitGpt
         save_main_config(main_config)
       end
 
+      # Get commit detail level ('concise' or 'detailed')
+      def get_commit_detail
+        return DEFAULT_COMMIT_DETAIL unless config_exists?
+
+        main_config = YAML.load_file(main_config_path)
+        detail = main_config['commit_detail']
+        COMMIT_DETAILS.include?(detail) ? detail : DEFAULT_COMMIT_DETAIL
+      end
+
+      # Set commit detail level
+      def set_commit_detail(detail)
+        ensure_config_dir
+        main_config = config_exists? ? YAML.load_file(main_config_path) : { 'providers' => [], 'active_provider' => '' }
+        main_config['commit_detail'] = detail
+        save_main_config(main_config)
+      end
+
       # Get the model list fetch timeout (seconds)
       def get_model_fetch_timeout
         return DEFAULT_MODEL_FETCH_TIMEOUT unless config_exists?

data/lib/commitgpt/setup_wizard.rb

@@ -116,8 +116,26 @@ module CommitGpt
       puts "\n✔ Commit format set to: #{format}".green
     end
 
+    # Choose how much the commit message says
+    def choose_detail
+      puts "\n→ Choose git commit message detail level:\n".green
+
+      detail = @prompt.select('Select detail level:', default: default_detail_index) do |menu|
+        menu.choice 'Concise - Subject line only', 'concise'
+        menu.choice 'Detailed - Subject line, explanatory paragraph, and bullet list of changes', 'detailed'
+      end
+
+      ConfigManager.set_commit_detail(detail)
+      puts "\n✔ Commit detail set to: #{detail}".green
+    end
+
     private
 
+    # Menu position of the currently configured detail level (1-based)
+    def default_detail_index
+      ConfigManager::COMMIT_DETAILS.index(ConfigManager.get_commit_detail).to_i + 1
+    end
+
     # Select provider from list
     def select_provider
       config = ConfigManager.load_config

data/lib/commitgpt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CommitGpt
-  VERSION = '0.3.10'
+  VERSION = '0.3.12'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commitgpt
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.12
 platform: ruby
 authors:
 - Peng Zhang