committer 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19704907042388baa2b8ede51ebe80710b9cbe5f6095fd09b0fb7cb997496382
-  data.tar.gz: ecaab24d0b58301c41a9677cf09fd1ae5ef23c3930c911c6cdf9820abacc52f9
+  metadata.gz: f495af607b9c66c6b3526af94a5d9792441dc84f6bf09c872586d70940ac6cb8
+  data.tar.gz: 3b203eedb9030d65417c74c41c2535ca76230836a612033852703476bcfc2e86
 SHA512:
-  metadata.gz: 1a6eb3eaabe0723082df95e113c7cbeb47521a16839ae04cdf6bfa146a3747b68b77aeac2462954220eeefd2cf709d73a8e2df9ab63b6b265d3c9f4304706357
-  data.tar.gz: 1c98170b2c2b194bb739c96278e3150e005d1f00df9c69c1c21219b26e7f2511d710894eb1001dfe973103e23efa22e91aabaa0f27fd06e53387aeca1b10e626
+  metadata.gz: 28b144c3f80ba381a8c3b00208d8ed92e9d8a47e7e2e21c86eb4c904699ecbd1711907a5bccd01227f6c7bb3c4a336adc199813c5590321e7d8b420891c35fb0
+  data.tar.gz: 597f5f6db243a56f05c285377b6b8cbaa44f1ffebc300ce2febabf7945179346a3db9d4f1afaadcb92e1ca9141cd61012dfdda2a32dfed18c72d0c52747ce71c

data/README.md

@@ -6,11 +6,12 @@ An AI-powered git commit message generator using Claude.
 
 The goal of committer is to make it easier to write beautiful commits.
 
-Committer uses Claude AI to analyze your staged git changes and generate conventional commit messages for you. It detects the type of changes (feature, fix, refactor, etc.) and creates a well-formatted commit message that follows best practices.
+Committer uses Claude AI to analyze your staged git changes and generate [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) messages for you. It detects the type of changes (feature, fix, refactor, etc.) and creates a well-formatted commit message that follows best practices.
 
 ## What Makes a Good Commit
 
 A good commit should:
+
 - Have a summary that clearly describes the change
 - Explain WHY the change was made, not just what changed
 
@@ -19,9 +20,10 @@ When a future developer uses git blame to understand a line of code, they should
 ## How Committer Helps
 
 Committer analyzes your code changes and generates commit messages that:
+
 1. Provide a clean, descriptive summary of the change
 2. Include context about why the change was necessary
-3. Follow conventional commit format for consistency
+3. Follow [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) format for consistency
 
 ## Installation
 
@@ -31,26 +33,6 @@ Committer analyzes your code changes and generates commit messages that:
 gem install committer
 ```
 
-### Manual Installation
-
-1. Install Bundler if you haven't already:
-
-   ```sh
-   gem install bundler
-   ```
-
-2. Install the project dependencies:
-
-   ```sh
-   bundle install
-   ```
-
-3. Link the executable:
-   ```bash
-   gem build committer.gemspec
-   gem install committer-0.1.0.gem
-   ```
-
 ## Configuration
 
 Before using Committer, you need to set up your configuration file:
@@ -72,7 +54,7 @@ scopes:
   - ui
 ```
 
-The `scopes` configuration is optional. When provided, Committer will generate conventional commit messages with scopes (like `feat(api): add new endpoint`). If left as `null` or omitted, commit messages will be generated without scopes (like `feat: add new endpoint`).
+The `scopes` configuration is optional. When provided, Committer will generate [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) messages with scopes (like `feat(api): add new endpoint`). If left as `null` or omitted, commit messages will be generated without scopes (like `feat: add new endpoint`).
 
 You only need to do this setup once.
 
@@ -89,7 +71,7 @@ This will:
 1. Get the diff of your staged changes
 2. Ask you for optional context about why you're making the change
 3. Send the diff and context to Claude for analysis
-4. Generate a commit message in conventional format (with scope if configured)
+4. Generate a commit message in [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) format (with scope if configured)
 5. Open your default git editor with the suggested message
 6. Allow you to edit the message if needed or simply save to confirm
 
@@ -98,6 +80,52 @@ This will:
 - `committer` - Generate commit message for staged changes
 - `committer setup` - Create the config file template
 - `committer help` - Display help information
+- `committer setup-git-hook` - Install the git hook for automatic commit message generation
+- `committer output-message` - Generate a commit message (used by the git hook)
+
+## Git Hook Integration
+
+Committer can be integrated directly with Git using a prepare-commit-msg hook, which automatically generates commit messages whenever you commit.
+
+### Installing the Git Hook
+
+To install the git hook, navigate to the root of your git repository and run:
+
+```bash
+committer setup-git-hook
+```
+
+This command will:
+1. Verify you're in the root of a git repository
+2. Install the prepare-commit-msg hook in your `.git/hooks` directory
+3. Make the hook executable
+
+### How the Git Hook Works
+
+Once installed, the git hook will:
+1. Automatically run whenever you execute `git commit`
+2. Generate an AI-powered commit message based on your staged changes
+3. Pre-fill your commit message editor with the generated message
+4. Allow you to edit the message before finalizing the commit
+
+Since git hooks run in non-interactive mode, you can provide context for your commit by using the REASON environment variable:
+
+```bash
+REASON="Improve performance by optimizing database queries" git commit
+```
+
+If you don't provide a REASON, the commit message will still be generated, but without the additional context that would be used to generate a more detailed body.
+
+## Development
+
+### Running Tests
+
+Committer uses RSpec for testing. To run the tests:
+
+```bash
+bundle install
+bundle exec rake spec
+```
 
 ## License
 

data/bin/committer

@@ -2,122 +2,12 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'open3'
-require 'httparty'
-require 'yaml'
-require_relative '../lib/committer/config'
-require_relative '../lib/committer/prompt_templates'
-require_relative '../lib/clients/claude_client'
+require_relative '../lib/committer/config/accessor'
+require_relative '../lib/committer/commit_generator'
+require_relative '../lib/committer/commands'
 
 # Handle command line arguments
 command = ARGV[0]
+args = ARGV[1..]
 
-case command
-when 'setup'
-  Committer::Config.setup
-  exit 0
-
-when 'help', '--help', '-h'
-  puts 'Committer - AI-powered git commit message generator'
-  puts
-  puts 'Commands:'
-  puts '  committer setup  - Create the config file template at ~/.committer/config.yml'
-  puts '  committer        - Generate commit message for staged changes'
-  puts
-  exit 0
-end
-
-# Default behavior: generate commit message
-def build_commit_prompt(diff, commit_context = nil)
-  scopes = Committer::Config.load
-  scope_section = scopes.empty? ? '' : "\nScopes:\n#{scopes.map { |s| "- #{s}" }.join("\n")}"
-  scope_instruction = if scopes.empty?
-                        '- DO NOT include a scope in your commit message'
-                      else
-                        '- Choose an appropriate scope from the list above if relevant to the change'
-                      end
-  format(template(commit_context),
-         diff: diff,
-         scopes_section: scope_section,
-         scope_instruction: scope_instruction,
-         commit_context: commit_context)
-end
-
-def template(commit_context)
-  if commit_context.nil? || commit_context.empty?
-    Committer::PromptTemplates::SUMMARY_ONLY
-  else
-    Committer::PromptTemplates::SUMMARY_AND_BODY
-  end
-end
-
-def check_git_status
-  stdout, stderr, status = Open3.capture3('git diff --staged')
-
-  unless status.success?
-    puts 'Error executing git diff --staged:'
-    puts stderr
-    exit 1
-  end
-
-  if stdout.empty?
-    puts 'No changes are staged for commit.'
-    exit 0
-  end
-
-  stdout
-end
-
-def parse_response(response, commit_context)
-  text = response.dig('content', 0, 'text')
-
-  # If user didn't provide context, response should only be a summary line
-  if commit_context.nil? || commit_context.empty?
-    { summary: text.strip, body: nil }
-  else
-    # Split the response into summary and body
-    message_parts = text.split("\n\n", 2)
-    summary = message_parts[0].strip
-    body = message_parts[1]&.strip
-
-    # Wrap body text at 80 characters
-    body = body.gsub(/(.{1,80})(\s+|$)/, "\\1\n").strip if body
-
-    { summary: summary, body: body }
-  end
-end
-
-def prepare_commit_message(diff, commit_context = nil)
-  client = Clients::ClaudeClient.new
-  puts 'Sending diff to Claude...'
-
-  prompt = build_commit_prompt(diff, commit_context)
-  response = client.post(prompt)
-  parse_response(response, commit_context)
-end
-
-def execute_git_diff_staged
-  diff = check_git_status
-
-  # Prompt user for commit context
-  puts 'Why are you making this change? (Press Enter to skip)'
-  commit_context = gets.chomp
-
-  commit_message = prepare_commit_message(diff, commit_context)
-
-  summary = commit_message[:summary]
-  body = commit_message[:body]
-
-  # Create git commit with the suggested message and open in editor
-  if body
-    system('git', 'commit', '-m', summary, '-m', body, '-e')
-  else
-    system('git', 'commit', '-m', summary, '-e')
-  end
-rescue Clients::ClaudeClient::ConfigError, StandardError => e
-  puts "Error: #{e.message}"
-  exit 1
-end
-
-# Execute the function if no specific command was given
-execute_git_diff_staged
+Committer::Commands.run(command, args)

data/lib/clients/claude_client.rb

@@ -2,7 +2,7 @@
 
 require 'json'
 require 'httparty'
-require_relative '../committer/config'
+require_relative '../committer/config/accessor'
 
 module Clients
   # Claude API client for communicating with Anthropic's Claude model
@@ -12,7 +12,7 @@ module Clients
     class ConfigError < StandardError; end
 
     def initialize
-      @config = Committer::Config.load
+      @config = Committer::Config::Accessor.instance
 
       return unless @config['api_key'].nil? || @config['api_key'].empty?
 

data/lib/committer/commands/default.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative '../git_helper'
+
+module Committer
+  module Commands
+    class Default
+      def self.execute_commit(diff, commit_context)
+        commit_generator = Committer::CommitGenerator.new(diff, commit_context)
+        commit_message = commit_generator.prepare_commit_message
+
+        summary = commit_message[:summary]
+        body = commit_message[:body]
+        # Create git commit with the suggested message and open in editor
+        Committer::GitHelper.commit(summary, body)
+      end
+
+      def self.execute(_args)
+        diff = Committer::CommitGenerator.check_git_status
+
+        if diff.empty?
+          puts 'No changes are staged for commit.'
+          exit 0
+        end
+
+        # Prompt user for commit context
+        puts 'Why are you making this change? (Press Enter to skip)'
+        commit_context = gets.chomp
+        execute_commit(diff, commit_context)
+      rescue Clients::ClaudeClient::ConfigError, StandardError => e
+        puts "Error: #{e.message}"
+        exit 1
+      end
+    end
+  end
+end

data/lib/committer/commands/help.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Committer
+  module Commands
+    class Help
+      def self.execute(_args)
+        puts 'Committer - AI-powered git commit message generator'
+        puts
+        puts 'Commands:'
+        puts '  committer setup          - Create the config file template at ~/.committer/config.yml'
+        puts '  committer                - Generate commit message for staged changes'
+        puts '  committer output-message - Generate commit message without creating a commit'
+        puts '  committer setup-git-hook - Install the prepare-commit-msg git hook'
+        puts
+        exit 0
+      end
+    end
+  end
+end

data/lib/committer/commands/output_message.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Committer
+  module Commands
+    class OutputMessage
+      def self.execute(args)
+        commit_context = args[0]
+        diff = Committer::CommitGenerator.check_git_status
+
+        commit_generator = Committer::CommitGenerator.new(diff, commit_context)
+        commit_message = commit_generator.prepare_commit_message
+
+        summary = commit_message[:summary]
+        body = commit_message[:body]
+
+        puts <<~OUTPUT
+          #{summary}
+
+          #{body}
+        OUTPUT
+        exit 0
+      rescue Clients::ClaudeClient::ConfigError => e
+        puts "Error: #{e.message}"
+        exit 1
+      rescue StandardError
+        exit 0
+      end
+    end
+  end
+end

data/lib/committer/commands/setup.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../config/writer'
+require_relative '../config/constants'
+
+module Committer
+  module Commands
+    class Setup
+      def self.execute(_args)
+        config_dir = Committer::Config::Constants::CONFIG_DIR
+        writer = Committer::Config::Writer.new(config_dir)
+        writer.setup
+        exit 0
+      end
+    end
+  end
+end

data/lib/committer/commands/setup_git_hook.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative '../git_helper'
+
+module Committer
+  module Commands
+    class SetupGitHook
+      HOOK_PATH = '.git/hooks/prepare-commit-msg'
+
+      def self.execute(_args)
+        validate_git_repository
+        install_git_hook
+        display_success_message
+        exit 0
+      rescue StandardError => e
+        puts "Error: #{e.message}"
+        exit 1
+      end
+
+      def self.validate_git_repository
+        validate_git_root
+        validate_git_directory_exists
+        validate_hook_doesnt_exist
+      end
+
+      def self.validate_git_directory_exists
+        return if Dir.exist?('.git')
+
+        puts 'Error: Current directory is not a git repository.'
+        exit 1
+      end
+
+      def self.validate_git_root
+        git_toplevel = Committer::GitHelper.repo_root
+        current_dir = Dir.pwd
+        return if git_toplevel == current_dir
+
+        puts 'Error: Please run this command from the root of your git repository.'
+        exit 1
+      end
+
+      def self.validate_hook_doesnt_exist
+        return unless File.exist?(HOOK_PATH)
+
+        puts 'Error: prepare-commit-msg hook already exists.'
+        puts 'Please remove or rename the existing hook and try again.'
+        exit 1
+      end
+
+      def self.install_git_hook
+        template_path = File.expand_path('../prepare-commit-msg', __dir__)
+        hook_content = File.read(template_path)
+        File.write(HOOK_PATH, hook_content)
+        File.chmod(0o755, HOOK_PATH)
+      end
+
+      def self.display_success_message
+        puts 'Git hook successfully installed!'
+        puts 'Now your commit messages will be automatically generated.'
+      end
+    end
+  end
+end

data/lib/committer/commands.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'commands/setup'
+require_relative 'commands/help'
+require_relative 'commands/output_message'
+require_relative 'commands/setup_git_hook'
+require_relative 'commands/default'
+
+module Committer
+  module Commands
+    def self.run(command, args)
+      case command
+      when 'setup'
+        Setup.execute(args)
+      when 'help', '--help', '-h'
+        Help.execute(args)
+      when 'output-message'
+        OutputMessage.execute(args)
+      when 'setup-git-hook'
+        SetupGitHook.execute(args)
+      else
+        Default.execute(args)
+      end
+    end
+  end
+end

data/lib/committer/commit_generator.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'yaml'
+require_relative 'config/accessor'
+require_relative 'prompt_templates'
+require_relative '../clients/claude_client'
+require_relative 'git_helper'
+
+module Committer
+  class CommitGenerator
+    attr_reader :diff, :commit_context
+
+    def initialize(diff, commit_context = nil)
+      @diff = diff
+      @commit_context = commit_context
+    end
+
+    def build_commit_prompt
+      format(template,
+             diff: @diff,
+             commit_context: @commit_context)
+    end
+
+    def template
+      if @commit_context.nil? || @commit_context.empty?
+        Committer::PromptTemplates.build_prompt_summary_only
+      else
+        Committer::PromptTemplates.build_prompt_summary_and_body
+      end
+    end
+
+    def self.check_git_status
+      Committer::GitHelper.staged_diff
+    rescue Committer::Error => e
+      puts e.message
+      exit 1
+    end
+
+    def parse_response(response)
+      text = response.dig('content', 0, 'text')
+
+      # If user didn't provide context, response should only be a summary line
+      if @commit_context.nil? || @commit_context.empty?
+        { summary: text.strip, body: nil }
+      else
+        # Split the response into summary and body
+        message_parts = text.split("\n\n", 2)
+        summary = message_parts[0].strip
+        body = message_parts[1]&.strip
+
+        # Wrap body text at 80 characters
+        body = body.gsub(/(.{1,80})(\s+|$)/, "\\1\n").strip if body
+
+        { summary: summary, body: body }
+      end
+    end
+
+    def prepare_commit_message
+      client = Clients::ClaudeClient.new
+
+      prompt = build_commit_prompt
+      response = client.post(prompt)
+      parse_response(response)
+    end
+  end
+end

data/lib/committer/committer_errors.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Committer
+  # Base error class for all Committer errors
+  class Error < StandardError; end
+
+  # Configuration management for the Committer gem
+  class ConfigErrors
+    class BaseError < StandardError; end
+
+    # Request Processing Errors
+    class FormatError < BaseError; end
+    class NotSetup < BaseError; end
+  end
+end

data/lib/committer/config/accessor.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'singleton'
+require_relative '../committer_errors'
+require_relative 'constants'
+require_relative '../git_helper'
+
+module Committer
+  # Configuration management for the Committer gem
+  module Config
+    class Accessor
+      include Singleton
+
+      def initialize
+        @config = load_config
+      end
+
+      # Accessor for the loaded config
+      def [](key)
+        @config[key.to_sym] || @config[key.to_s]
+      end
+
+      # Get the entire config hash
+      def to_h
+        @config.dup
+      end
+
+      def load_config
+        # Load configs from both locations and merge them
+        home_config = load_config_from_path(Committer::Config::Constants::CONFIG_FILE)
+        git_root_config = load_config_from_git_root
+        raise Committer::ConfigErrors::NotSetup if home_config.empty? && git_root_config.empty?
+
+        # Merge configs with git root taking precedence
+        home_config.merge(git_root_config)
+      end
+
+      def load_config_from_path(path)
+        return {} unless File.exist?(path)
+
+        result = YAML.load_file(path)
+        raise Committer::ConfigErrors::FormatError, 'Config file must be a YAML hash' unless result.is_a?(Hash)
+
+        result
+      end
+
+      def load_file_from_path(path)
+        return '' unless File.exist?(path)
+
+        File.read(path)
+      end
+
+      def load_formatting_rules
+        git_root = Committer::GitHelper.repo_root
+        unless git_root.empty?
+          formatting_rules_git_path = File.join(git_root, '.committer',
+                                                Committer::Config::Constants::FORMATTING_RULES_FILE_NAME)
+        end
+
+        git_path_contents = load_file_from_path(formatting_rules_git_path) if formatting_rules_git_path
+
+        return git_path_contents unless git_path_contents.empty?
+
+        home_path = File.join(Committer::Config::Constants::CONFIG_DIR,
+                              Committer::Config::Constants::FORMATTING_RULES_FILE_NAME)
+
+        home_path_contents = load_file_from_path(home_path)
+
+        return home_path_contents unless home_path_contents.empty?
+
+        default_path = File.join(Committer::Config::Constants::DEFAULT_PROMPT_PATH,
+                                 Committer::Config::Constants::FORMATTING_RULES_FILE_NAME)
+        load_file_from_path(default_path)
+      end
+
+      def load_config_from_git_root
+        git_root = Committer::GitHelper.repo_root
+        return {} if git_root.empty?
+
+        git_config_file = File.join(git_root, '.committer', 'config.yml')
+        load_config_from_path(git_config_file)
+      rescue StandardError
+        {}
+      end
+
+      # Force reload configuration (useful for testing)
+      def reload
+        @config = load_config
+      end
+
+      # Class method for reload
+      def self.reload
+        instance.reload
+      end
+    end
+  end
+end

data/lib/committer/config/constants.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Committer
+  module Config
+    module Constants
+      CONFIG_DIR = File.join(Dir.home, '.committer')
+      CONFIG_FILE = File.join(CONFIG_DIR, 'config.yml')
+      FORMATTING_RULES_FILE_NAME = 'formatting_rules.txt'
+      DEFAULT_PROMPT_PATH = File.join(File.dirname(__FILE__), '..')
+      CONFIG_FILE_NAME = 'config.yml'
+      DEFAULT_CONFIG = {
+        'api_key' => nil,
+        'model' => 'claude-3-7-sonnet-20250219',
+        'scopes' => nil
+      }.freeze
+    end
+  end
+end

data/lib/committer/config/writer.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'fileutils'
+require_relative '../committer_errors'
+require_relative 'constants'
+
+module Committer
+  module Config
+    class Writer
+      attr_reader :config_dir
+
+      def initialize(config_dir)
+        @config_dir = config_dir
+      end
+
+      def config_file
+        File.join(@config_dir, Committer::Config::Constants::CONFIG_FILE_NAME)
+      end
+
+      def setup
+        create_default_config
+        create_sample_formatting_rules
+      end
+
+      def write_config_file(file_path, contents)
+        FileUtils.mkdir_p(@config_dir)
+        if File.exist?(file_path)
+          puts "Config file already exists at #{config_file}, skipping write"
+          false
+        else
+          File.write(file_path, contents)
+          true
+        end
+      end
+
+      def create_sample_formatting_rules
+        default_formatting_rules = File.read(File.join(Committer::Config::Constants::DEFAULT_PROMPT_PATH,
+                                                       Committer::Config::Constants::FORMATTING_RULES_FILE_NAME))
+        formatting_rules_file = File.join(@config_dir,
+                                          "#{Committer::Config::Constants::FORMATTING_RULES_FILE_NAME}.sample")
+        wrote_file = write_config_file(formatting_rules_file, default_formatting_rules)
+        nil unless wrote_file
+      end
+
+      def create_default_config
+        wrote_file = write_config_file(config_file, Committer::Config::Constants::DEFAULT_CONFIG.to_yaml)
+        return unless wrote_file
+
+        puts 'Created config file at:'
+        puts config_file
+        puts "\nPlease edit this file to add your Anthropic API key."
+        puts 'Example config format:'
+        puts '---'
+        puts 'api_key: your_api_key_here'
+        puts 'model: claude-3-7-sonnet-20250219'
+        puts 'scopes:'
+        puts '  - feature'
+        puts '  - api'
+        puts '  - ui'
+      end
+    end
+  end
+end

data/lib/committer/formatting_rules.txt

@@ -0,0 +1,19 @@
+# Formatting rules for message
+Message should be formatted according to conventional commits
+
+## When scopes are available:
+<type>(<scope>): <description>
+
+# Formatting Rules
+## When scopes are not available:
+<type>: <description>
+
+# Types:
+- feat: A new feature
+- fix: A bug fix
+- docs: Documentation only changes
+- style: Changes that do not affect the meaning of the code
+- refactor: A code change that neither fixes a bug nor adds a feature
+- perf: A code change that improves performance
+- test: Adding missing tests or correcting existing tests
+- chore: Changes to the build process or auxiliary tools

data/lib/committer/git_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Committer
+  # Helper class for git operations
+  class GitHelper
+    class << self
+      def commit(summary, body = nil)
+        if body
+          system('git', 'commit', '-m', summary, '-m', body, '-e')
+        else
+          system('git', 'commit', '-m', summary, '-e')
+        end
+      end
+
+      def repo_root
+        `git rev-parse --show-toplevel`.strip
+      end
+
+      def staged_diff
+        stdout, stderr, status = Open3.capture3('git diff --staged')
+        raise Committer::Error, "Failed to get git diff: #{stderr}" unless status.success?
+
+        stdout
+      end
+    end
+  end
+end

data/lib/committer/prepare-commit-msg

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# Check if parameters 2 and 3 are null
+if [ -z "$2" ] && [ -z "$3" ]; then
+    # Check if parameter 1 is provided and is a valid file
+    if [ -z "$1" ]; then
+        echo "Error: No target file specified in parameter 1"
+        exit 1
+    fi
+    
+    if [ ! -f "$1" ]; then
+        echo "Error: File '$1' does not exist"
+        exit 1
+    fi
+    
+    # Check if committer command exists
+    if command -v committer &> /dev/null; then
+        # Execute committer command and capture its output
+        COMMITTER_OUTPUT=$(committer output-message "$REASON")
+        
+        # Create a temporary file with the committer output at the top
+        # followed by the original content of the file
+        {
+            echo "$COMMITTER_OUTPUT"
+            cat "$1"
+        } > "$1.tmp"
+        
+        # Replace the original file with the temporary file
+        mv "$1.tmp" "$1"
+        
+        echo "Successfully added committer output to the top of $1"
+    else
+        echo "Committer command not found - no action taken"
+    fi
+fi

data/lib/committer/prompt_templates.rb

@@ -2,82 +2,71 @@
 
 module Committer
   module PromptTemplates
-    SUMMARY_ONLY = <<~PROMPT
-      Below is a git diff of staged changes. Please analyze it and create a commit message following the Conventional Commits format with ONLY a summary line (NO body):
-
-      Format when scopes are available: <type>(<scope>): <description>
-      Format when no scopes are available: <type>: <description>
-
-      Types:
-      - feat: A new feature
-      - fix: A bug fix
-      - docs: Documentation only changes
-      - style: Changes that do not affect the meaning of the code
-      - refactor: A code change that neither fixes a bug nor adds a feature
-      - perf: A code change that improves performance
-      - test: Adding missing tests or correcting existing tests
-      - chore: Changes to the build process or auxiliary tools
-      %<scopes_section>s
-      Guidelines:
-      - Keep the summary under 70 characters
-      - Use imperative, present tense (e.g., "add" not "added" or "adds")
-      - Do not end the summary with a period
-      - Be concise but descriptive in the summary
-      %<scope_instruction>s
-
-      Git Diff:
-      ```
-      %<diff>s
-      ```
-
-      Respond ONLY with the commit message summary line, nothing else.
-    PROMPT
-
-    SUMMARY_AND_BODY = <<~PROMPT
-      Below is a git diff of staged changes. Please analyze it and create a commit message following the Conventional Commits format with a summary line and a detailed body:
-
-      Format when scopes are available:
-      <type>(<scope>): <description>
-
-      <blank line>
-      <body with more detailed explanation>
-
-      Format when no scopes are available:
-      <type>: <description>
-
-      <blank line>
-      <body with more detailed explanation>
-
-
-      Types:
-      - feat: A new feature
-      - fix: A bug fix
-      - docs: Documentation only changes
-      - style: Changes that do not affect the meaning of the code
-      - refactor: A code change that neither fixes a bug nor adds a feature
-      - perf: A code change that improves performance
-      - test: Adding missing tests or correcting existing tests
-      - chore: Changes to the build process or auxiliary tools
-      %<scopes_section>s
-      Guidelines:
-      - Keep the first line (summary) under 70 characters
-      - Use imperative, present tense (e.g., "add" not "added" or "adds")
-      - Do not end the summary with a period
-      - Be concise but descriptive in the summary
-      - Add a blank line between summary and body
-      - Use the body to explain why the change was made, incorporating the user's context
-      - Wrap each line in the body at 80 characters maximum
-      - Break the body into multiple paragraphs if needed
-      %<scope_instruction>s
-
-      User's context for this change: %<commit_context>s
-
-      Git Diff:
-      ```
-      %<diff>s
-      ```
-
-      Respond ONLY with the commit message text (summary and body), nothing else.
-    PROMPT
+    FORMATTING_RULES_PATH = File.join(File.dirname(__FILE__), 'formatting_rules.txt')
+
+    def self.load_formatting_rules
+      File.read(FORMATTING_RULES_PATH)
+    end
+
+    def self.load_scopes
+      scopes = Committer::Config::Accessor.instance[:scopes] || []
+      return 'DO NOT include a scope in your commit message' if scopes.empty?
+
+      scope_list = "\nScopes:\n#{scopes.map { |s| "- #{s}" }.join("\n")}"
+
+      "- Choose an appropriate scope from the list above if relevant to the change \n#{scope_list}"
+    end
+
+    def self.commit_message_guidelines
+      <<~PROMPT
+        #{load_formatting_rules}
+
+        # Formatting rules with body:
+        <message>
+
+        <blank line>
+        <body with more detailed explanation>
+
+        #{load_scopes}
+
+        # Message Guidelines:
+        - Keep the summary under 70 characters
+        - Use imperative, present tense (e.g., "add" not "added" or "adds")
+        - Do not end the summary with a period
+        - Be concise but descriptive in the summary
+
+        # Body Guidelines:
+        - Add a blank line between summary and body
+        - Use the body to explain why the change was made, incorporating the user's context
+        - Wrap each line in the body at 80 characters maximum
+        - Break the body into multiple paragraphs if needed
+
+        Git Diff:
+        ```
+        %<diff>s
+        ```
+      PROMPT
+    end
+
+    def self.build_prompt_summary_only
+      <<~PROMPT
+        Below is a git diff of staged changes. Please analyze it and create a commit message following the formatting rules format with ONLY a message line (NO body):
+
+        #{commit_message_guidelines}
+
+        Respond ONLY with the commit message line, nothing else.
+      PROMPT
+    end
+
+    def self.build_prompt_summary_and_body
+      <<~PROMPT
+        Below is a git diff of staged changes. Please analyze it and create a commit message following the formatting rules format with a summary line and a detailed body:
+
+        #{commit_message_guidelines}
+        User's context for this change: %<commit_context>s
+
+        Respond ONLY with the commit message text (message and body), nothing else.
+      PROMPT
+    end
   end
 end

data/lib/committer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Committer
-  VERSION = '0.2.2'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: committer
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Sebastien Stettler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -36,7 +36,20 @@ files:
 - README.md
 - bin/committer
 - lib/clients/claude_client.rb
-- lib/committer/config.rb
+- lib/committer/commands.rb
+- lib/committer/commands/default.rb
+- lib/committer/commands/help.rb
+- lib/committer/commands/output_message.rb
+- lib/committer/commands/setup.rb
+- lib/committer/commands/setup_git_hook.rb
+- lib/committer/commit_generator.rb
+- lib/committer/committer_errors.rb
+- lib/committer/config/accessor.rb
+- lib/committer/config/constants.rb
+- lib/committer/config/writer.rb
+- lib/committer/formatting_rules.txt
+- lib/committer/git_helper.rb
+- lib/committer/prepare-commit-msg
 - lib/committer/prompt_templates.rb
 - lib/committer/version.rb
 homepage: https://github.com/Hyper-Unearthing/committer

data/lib/committer/config.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-require 'fileutils'
-
-module Committer
-  # Configuration management for the Committer gem
-  class Config
-    CONFIG_DIR = File.join(Dir.home, '.committer')
-    CONFIG_FILE = File.join(CONFIG_DIR, 'config.yml')
-    DEFAULT_CONFIG = {
-      'api_key' => nil,
-      'model' => 'claude-3-7-sonnet-20250219',
-      'scopes' => nil
-    }.freeze
-
-    def self.load
-      create_default_config unless File.exist?(CONFIG_FILE)
-      begin
-        YAML.load_file(CONFIG_FILE) || DEFAULT_CONFIG
-      rescue StandardError => e
-        puts "Error loading config: #{e.message}"
-        DEFAULT_CONFIG
-      end
-    end
-
-    def self.create_default_config
-      FileUtils.mkdir_p(CONFIG_DIR)
-      File.write(CONFIG_FILE, DEFAULT_CONFIG.to_yaml)
-    end
-
-    def self.setup
-      create_default_config
-      puts 'Created config file at:'
-      puts CONFIG_FILE
-      puts "\nPlease edit this file to add your Anthropic API key."
-      puts 'Example config format:'
-      puts '---'
-      puts 'api_key: your_api_key_here'
-      puts 'model: claude-3-7-sonnet-20250219'
-      puts 'scopes:'
-      puts '  - feature'
-      puts '  - api'
-      puts '  - ui'
-    end
-  end
-end