commitgpt 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de7ab665c77f18d08715d16d56b7f4cd0a3b7e677bdbeabb80b25e96afcc8f47
-  data.tar.gz: f3cddebeaf3d1f479155e85a9039f47a14c7cc61d0390968c47fb0e810ca6ce7
+  metadata.gz: b47c936f4c64c0d4cb2fb5214d1bf28b188b1c14525d5984be2fb2a0f84fb287
+  data.tar.gz: 540d6f74110a1d86e1a34a366456224f56b78888ddbafc070fb5ef0594697e59
 SHA512:
-  metadata.gz: 9576ab5271ad85fb136eab275b987787cac5bae9af6c3458563089dd4e782c92ce57b48630379ad7c8ebbd11a816a0f2d6b69d302557dc8f5e3f69b482d2b889
-  data.tar.gz: e882ab4a80976721e87fcee2d5935021c2063ddf23c61e1cb26a45c7e8ead43da33610fb1f18cbd21fbc17d540cbdbdc7d9f52cc7641c666d589ce2fd41e15b2
+  metadata.gz: 60c0ea07f58567bee161b6037fe6db60d92344b1098c88e33c9e4d4908ca08b36b66f722d29cc743308c1bc1f4d4c16f70fb5a7e2a65db1d8c3c0a8adafd5ef2
+  data.tar.gz: 664fa8dc1665d983485c97d064e440e434b2645ff578954d2b762ceec4a741649bb20af3c32dbd180560cd67838e6a4eee1662ef75c56b53c790216d9738f2af

data/README.md

@@ -155,8 +155,44 @@ $ aicm -m
 $ aicm --models
 ```
 
+### Choose Commit Message Format
+Select your preferred commit message format:
+```bash
+$ aicm -f
+# or
+$ aicm --format
+```
+
+CommitGPT supports three commit message formats:
+- **Simple** - Concise commit message (default)
+- **Conventional** - Follow [Conventional Commits](https://www.conventionalcommits.org/) specification
+- **Gitmoji** - Use [Gitmoji](https://gitmoji.dev/) emoji standard
+
+Your selection will be saved in `~/.config/commitgpt/config.yml` and used for all future commits until changed.
+
+#### Format Examples
+
+**Simple:**
+```
+Add user authentication feature
+```
+
+**Conventional:**
+```
+feat: add user authentication feature
+fix: resolve login timeout issue
+docs: update API documentation
+```
+
+**Gitmoji:**
+```
+✨ add user authentication feature
+🐛 resolve login timeout issue
+📝 update API documentation
+```
+
 ### Check Configuration
-View your current configuration (Provider, Model, Base URL, Diff Len):
+View your current configuration (Provider, Model, Format, Base URL, Diff Len):
 ```bash
 $ aicm help
 ```

data/lib/commitgpt/cli.rb

@@ -13,11 +13,14 @@ module CommitGpt
     method_option :models, aliases: '-m', type: :boolean, desc: 'List/Select available models'
     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'
     def generate
       if options[:provider]
         CommitGpt::SetupWizard.new.switch_provider
       elsif options[:models]
         CommitGpt::SetupWizard.new.change_model
+      elsif options[:format]
+        CommitGpt::SetupWizard.new.choose_format
       else
         CommitGpt::CommitAi.new.aicm(verbose: options[:verbose])
       end
@@ -38,6 +41,7 @@ module CommitGpt
       shell.say 'Options:'
       shell.say '  -m, --models             # Interactive model selection'
       shell.say '  -p, --provider           # Switch active provider'
+      shell.say '  -f, --format             # Choose commit message format'
       shell.say '  -v, --verbose            # Show git diff being sent to AI'
       shell.say ''
 
@@ -52,9 +56,11 @@ module CommitGpt
           shell.say "Bin Path: #{File.realpath($PROGRAM_NAME)}".gray
           shell.say ''
 
+          format = CommitGpt::ConfigManager.get_commit_format
           shell.say 'Current Configuration:'
           shell.say "  Provider:  #{config['name'].green}"
           shell.say "  Model:     #{config['model'].cyan}"
+          shell.say "  Format:    #{format.capitalize.yellow}"
           shell.say "  Base URL:  #{config['base_url']}"
           shell.say "  Diff Len:  #{config['diff_len']}"
           shell.say ''

data/lib/commitgpt/commit_ai.rb

@@ -13,10 +13,109 @@ require_relative 'diff_helpers'
 # CommitGpt based on GPT-3
 module CommitGpt
   # Commit AI roboter based on GPT-3
-  class CommitAi
+  class CommitAi # rubocop:disable Metrics/ClassLength
     include DiffHelpers
 
-    attr_reader :api_key, :base_url, :model, :diff_len
+    attr_reader :api_key, :base_url, :model, :diff_len, :commit_format
+
+    # Commit format templates
+    COMMIT_FORMATS = {
+      'simple' => '<commit message>',
+      'conventional' => '<type>[optional (<scope>)]: <commit message>',
+      'gitmoji' => ':emoji: <commit message>'
+    }.freeze
+
+    # Conventional commit types based on aicommits implementation
+    CONVENTIONAL_TYPES = {
+      'docs' => 'Documentation only changes',
+      'style' => 'Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)',
+      'refactor' => 'A code change that improves code structure without changing functionality (renaming, restructuring classes/methods, extracting functions, etc)',
+      'perf' => 'A code change that improves performance',
+      'test' => 'Adding missing tests or correcting existing tests',
+      'build' => 'Changes that affect the build system or external dependencies',
+      'ci' => 'Changes to our CI configuration files and scripts',
+      'chore' => "Other changes that don't modify src or test files",
+      'revert' => 'Reverts a previous commit',
+      'feat' => 'A new feature',
+      'fix' => 'A bug fix'
+    }.freeze
+
+    # Gitmoji mappings based on gitmoji.dev
+    GITMOJI_TYPES = {
+      '🎨' => 'Improve structure / format of the code',
+      '⚡' => 'Improve performance',
+      '🔥' => 'Remove code or files',
+      '🐛' => 'Fix a bug',
+      '🚑' => 'Critical hotfix',
+      '✨' => 'Introduce new features',
+      '📝' => 'Add or update documentation',
+      '🚀' => 'Deploy stuff',
+      '💄' => 'Add or update the UI and style files',
+      '🎉' => 'Begin a project',
+      '✅' => 'Add, update, or pass tests',
+      '🔒' => 'Fix security or privacy issues',
+      '🔐' => 'Add or update secrets',
+      '🔖' => 'Release / Version tags',
+      '🚨' => 'Fix compiler / linter warnings',
+      '🚧' => 'Work in progress',
+      '💚' => 'Fix CI Build',
+      '⬇️' => 'Downgrade dependencies',
+      '⬆️' => 'Upgrade dependencies',
+      '📌' => 'Pin dependencies to specific versions',
+      '👷' => 'Add or update CI build system',
+      '📈' => 'Add or update analytics or track code',
+      '♻️' => 'Refactor code',
+      '➕' => 'Add a dependency',
+      '➖' => 'Remove a dependency',
+      '🔧' => 'Add or update configuration files',
+      '🔨' => 'Add or update development scripts',
+      '🌐' => 'Internationalization and localization',
+      '✏️' => 'Fix typos',
+      '💩' => 'Write bad code that needs to be improved',
+      '⏪' => 'Revert changes',
+      '🔀' => 'Merge branches',
+      '📦' => 'Add or update compiled files or packages',
+      '👽' => 'Update code due to external API changes',
+      '🚚' => 'Move or rename resources (e.g.: files, paths, routes)',
+      '📄' => 'Add or update license',
+      '💥' => 'Introduce breaking changes',
+      '🍱' => 'Add or update assets',
+      '♿' => 'Improve accessibility',
+      '💡' => 'Add or update comments in source code',
+      '🍻' => 'Write code drunkenly',
+      '💬' => 'Add or update text and literals',
+      '🗃' => 'Perform database related changes',
+      '🔊' => 'Add or update logs',
+      '🔇' => 'Remove logs',
+      '👥' => 'Add or update contributor(s)',
+      '🚸' => 'Improve user experience / usability',
+      '🏗' => 'Make architectural changes',
+      '📱' => 'Work on responsive design',
+      '🤡' => 'Mock things',
+      '🥚' => 'Add or update an easter egg',
+      '🙈' => 'Add or update a .gitignore file',
+      '📸' => 'Add or update snapshots',
+      '⚗' => 'Perform experiments',
+      '🔍' => 'Improve SEO',
+      '🏷' => 'Add or update types',
+      '🌱' => 'Add or update seed files',
+      '🚩' => 'Add, update, or remove feature flags',
+      '🥅' => 'Catch errors',
+      '💫' => 'Add or update animations and transitions',
+      '🗑' => 'Deprecate code that needs to be cleaned up',
+      '🛂' => 'Work on code related to authorization, roles and permissions',
+      '🩹' => 'Simple fix for a non-critical issue',
+      '🧐' => 'Data exploration/inspection',
+      '⚰' => 'Remove dead code',
+      '🧪' => 'Add a failing test',
+      '👔' => 'Add or update business logic',
+      '🩺' => 'Add or update healthcheck',
+      '🧱' => 'Infrastructure related changes',
+      '🧑‍💻' => 'Improve developer experience',
+      '💸' => 'Add sponsorships or money related infrastructure',
+      '🧵' => 'Add or update code related to multithreading or concurrency',
+      '🦺' => 'Add or update code related to validation'
+    }.freeze
 
     def initialize
       provider_config = ConfigManager.get_active_provider_config
@@ -32,6 +131,8 @@ module CommitGpt
         @model = nil
         @diff_len = 32_768
       end
+
+      @commit_format = ConfigManager.get_commit_format
     end
 
     def aicm(verbose: false)
@@ -158,21 +259,42 @@ module CommitGpt
         puts '▲ This is not a git repository'.red
         return false
       end
-
       true
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
     def generate_commit(diff = '')
+      # 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.'
+
+      format_instruction = case @commit_format
+                           when 'conventional'
+                             "Choose a type from the type-to-description JSON below that best describes the git diff:\n#{JSON.pretty_generate(CONVENTIONAL_TYPES)}"
+                           when 'gitmoji'
+                             "Choose an emoji from the emoji-to-description JSON below that best describes the git diff:\n#{JSON.pretty_generate(GITMOJI_TYPES)}"
+                           else
+                             ''
+                           end
+
+      format_spec = "The output response must be in format:\n#{COMMIT_FORMATS[@commit_format]}"
+
+      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.',
+        format_instruction,
+        format_spec
+      ].reject(&:empty?).join("\n")
+
       messages = [
         {
           role: 'system',
-          content: '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. ' \
-                   "Message language: English. Rules:\n" \
-                   "- Commit message must be a maximum of 100 characters.\n" \
-                   "- Exclude anything unnecessary such as translation. Your entire response will be passed directly into git commit.\n" \
-                   "- 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. \n" \
-                   "- Be specific: include concrete details (package names, versions, functionality) rather than generic statements. \n" \
-                   '- Return ONLY the commit message, nothing else.'
+          content: system_content
         },
         {
           role: 'user',
@@ -373,5 +495,6 @@ module CommitGpt
       first_line = full_content.split("\n").map(&:strip).reject(&:empty?).first
       first_line&.gsub(/\A["']|["']\z/, '') || ''
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
   end
 end

data/lib/commitgpt/config_manager.rb

@@ -141,6 +141,22 @@ module CommitGpt
         save_main_config(main_config)
       end
 
+      # Get commit format configuration
+      def get_commit_format
+        return 'simple' unless config_exists?
+
+        main_config = YAML.load_file(main_config_path)
+        main_config['commit_format'] || 'simple'
+      end
+
+      # Set commit format configuration
+      def set_commit_format(format)
+        ensure_config_dir
+        main_config = config_exists? ? YAML.load_file(main_config_path) : { 'providers' => [], 'active_provider' => '' }
+        main_config['commit_format'] = format
+        save_main_config(main_config)
+      end
+
       private
 
       # Merge main config with local config (local overrides main)

data/lib/commitgpt/provider_presets.rb

@@ -3,7 +3,7 @@
 module CommitGpt
   # Provider presets for common AI providers
   PROVIDER_PRESETS = [
-    { label: 'Anthropic (Claude)', value: 'anthropic', base_url: 'https://api.anthropic.com/v1' },
+    { label: 'Anthropic Claude', value: 'anthropic', base_url: 'https://api.anthropic.com/v1' },
     { label: 'Cerebras', value: 'cerebras', base_url: 'https://api.cerebras.ai/v1' },
     { label: 'DeepSeek', value: 'deepseek', base_url: 'https://api.deepseek.com' },
     { label: 'Google AI', value: 'gemini', base_url: 'https://generativelanguage.googleapis.com/v1beta/openai' },

data/lib/commitgpt/setup_wizard.rb

@@ -86,6 +86,22 @@ module CommitGpt
       puts "\nModel selected: #{model}".green
     end
 
+    # Choose commit message format
+    def choose_format
+      prompt = TTY::Prompt.new
+
+      puts "\n▲ Choose git commit message format:\n".green
+
+      format = prompt.select('Select format:') do |menu|
+        menu.choice 'Simple - Concise commit message', 'simple'
+        menu.choice 'Conventional - Follow Conventional Commits specification', 'conventional'
+        menu.choice 'Gitmoji - Use Gitmoji emoji standard', 'gitmoji'
+      end
+
+      ConfigManager.set_commit_format(format)
+      puts "\n▲ Commit format set to: #{format}".green
+    end
+
     private
 
     # Select provider from list

data/lib/commitgpt/version.rb

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

metadata

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