committer 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7e89bde257ed6c9de9a4ad0e8bdff105f5200143ef1fe0938ee086fc2ac51fa
-  data.tar.gz: 251035e7d4b188dc7589ea2cbfc01733496d70bfc28ed348d01647c0f955fb12
+  metadata.gz: 19704907042388baa2b8ede51ebe80710b9cbe5f6095fd09b0fb7cb997496382
+  data.tar.gz: ecaab24d0b58301c41a9677cf09fd1ae5ef23c3930c911c6cdf9820abacc52f9
 SHA512:
-  metadata.gz: 77ab47d1217c616a19de223748c9399ff90a04a9561a1fd38a716beddf56829914263926feb78d0c80a699e7c328fca15ecc7022b11dd6bb0ce78f03201cef81
-  data.tar.gz: dd29f94532dafa9791cddf4868b4cb1bd0f214ad888b862b4924ea0f147bc7ee8327ee93721c054fb3e084a65d60109e6b4a3942bc6bad564c3ecff68bcf7c2f
+  metadata.gz: 1a6eb3eaabe0723082df95e113c7cbeb47521a16839ae04cdf6bfa146a3747b68b77aeac2462954220eeefd2cf709d73a8e2df9ab63b6b265d3c9f4304706357
+  data.tar.gz: 1c98170b2c2b194bb739c96278e3150e005d1f00df9c69c1c21219b26e7f2511d710894eb1001dfe973103e23efa22e91aabaa0f27fd06e53387aeca1b10e626

data/README.md

@@ -4,8 +4,25 @@ An AI-powered git commit message generator using Claude.
 
 ## Overview
 
+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.
 
+## 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
+
+When a future developer uses git blame to understand a line of code, they should immediately understand why the change was made. This context is invaluable for maintaining and evolving the codebase effectively.
+
+## 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
+
 ## Installation
 
 ### Install from RubyGems
@@ -23,6 +40,7 @@ gem install committer
    ```
 
 2. Install the project dependencies:
+
    ```sh
    bundle install
    ```
@@ -43,13 +61,19 @@ committer setup
 
 This will create a template config file at `~/.committer/config.yml`.
 
-Next, edit this file to add your Anthropic API key and optionally change the model:
+Next, edit this file to add your Anthropic API key and optionally change the model or configure commit scopes:
 
 ```yaml
 api_key: your_anthropic_api_key_here
-model: claude-3-sonnet-20240229
+model: claude-3-7-sonnet-20250219
+scopes:
+  - feature
+  - api
+  - 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`).
+
 You only need to do this setup once.
 
 ## Usage
@@ -61,11 +85,13 @@ committer
 ```
 
 This will:
+
 1. Get the diff of your staged changes
-2. Send it to Claude for analysis
-3. Generate a commit message in conventional format
-4. Open your default git editor with the suggested message
-5. Allow you to edit the message if needed or simply save to confirm
+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)
+5. Open your default git editor with the suggested message
+6. Allow you to edit the message if needed or simply save to confirm
 
 ## Commands
 
@@ -73,12 +99,6 @@ This will:
 - `committer setup` - Create the config file template
 - `committer help` - Display help information
 
-You can also run it directly through git:
-
-```bash
-git smart-commit
-```
-
 ## License
 
 MIT

data/bin/committer

@@ -6,6 +6,7 @@ require 'open3'
 require 'httparty'
 require 'yaml'
 require_relative '../lib/committer/config'
+require_relative '../lib/committer/prompt_templates'
 require_relative '../lib/clients/claude_client'
 
 # Handle command line arguments
@@ -27,71 +28,95 @@ when 'help', '--help', '-h'
 end
 
 # Default behavior: generate commit message
-def execute_git_diff_staged
-  stdout, stderr, status = Open3.capture3('git diff --staged')
+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
 
-  if status.success?
-    if stdout.empty?
-      puts 'No changes are staged for commit.'
-      exit 0
-    else
-      begin
-        client = Clients::ClaudeClient.new
-        puts 'Sending diff to Claude...'
-
-        prompt = <<~PROMPT
-          Below is a git diff of staged changes. Please analyze it and create a commit message following the Conventional Commits format:
-
-          Format: <type>(<optional scope>): <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
-
-          Guidelines:
-          - Keep the first line under 70 characters
-          - Use imperative, present tense (e.g., "add" not "added" or "adds")
-          - Do not end with a period
-          - Be concise but descriptive
-
-          Git Diff:
-          ```
-          #{stdout}
-          ```
-
-          Respond ONLY with the commit message text, nothing else.
-        PROMPT
-
-        response = client.post(prompt)
-        commit_message = begin
-          response.dig('content', 0, 'text')
-        rescue StandardError
-          response.inspect
-        end
-
-        puts "\nOpening git commit with the suggested message..."
-
-        # Create git commit with the suggested message and open in editor
-        system('git', 'commit', '-m', commit_message, '-e')
-      rescue Clients::ClaudeClient::ConfigError => e
-        puts "Error: #{e.message}"
-        exit 1
-      rescue StandardError => e
-        puts "Error: #{e.message}"
-        exit 1
-      end
-    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

data/lib/clients/claude_client.rb

@@ -5,6 +5,7 @@ require 'httparty'
 require_relative '../committer/config'
 
 module Clients
+  # Claude API client for communicating with Anthropic's Claude model
   class ClaudeClient
     class OverloadError < StandardError; end
     class UnknownError < StandardError; end
@@ -21,13 +22,28 @@ module Clients
 
     def post(message)
       body = {
-        'model': @config['model'],
-        'max_tokens': 4096,
-        'messages': [
-          { 'role': 'user', 'content': message }
+        model: @config['model'],
+        max_tokens: 4096,
+        messages: [
+          { role: 'user', content: message }
         ]
       }
-      options = {
+
+      response = send_request(body)
+      handle_error_response(response) if response['type'] == 'error'
+
+      response
+    end
+
+    private
+
+    def send_request(body)
+      options = build_request_options(body)
+      HTTParty.post('https://api.anthropic.com/v1/messages', options)
+    end
+
+    def build_request_options(body)
+      {
         headers: {
           'anthropic-version': '2023-06-01',
           'content-type': 'application/json',
@@ -35,17 +51,14 @@ module Clients
         },
         body: body.to_json
       }
-      response = HTTParty.post(
-        'https://api.anthropic.com/v1/messages', options
-      )
-      if response['type'] == 'error'
-        error = response['error']
-        raise OverloadError if error['type'] == 'overloaded_error'
-
-        puts response
-        raise UnknownError, "Claude API error: #{response.inspect}"
-      end
-      response
+    end
+
+    def handle_error_response(response)
+      error = response['error']
+      raise OverloadError if error['type'] == 'overloaded_error'
+
+      puts response
+      raise UnknownError, "Claude API error: #{response.inspect}"
     end
   end
 end

data/lib/committer/config.rb

@@ -4,12 +4,14 @@ 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-sonnet-20240229'
+      'model' => 'claude-3-7-sonnet-20250219',
+      'scopes' => nil
     }.freeze
 
     def self.load
@@ -23,7 +25,7 @@ module Committer
     end
 
     def self.create_default_config
-      FileUtils.mkdir_p(CONFIG_DIR) unless Dir.exist?(CONFIG_DIR)
+      FileUtils.mkdir_p(CONFIG_DIR)
       File.write(CONFIG_FILE, DEFAULT_CONFIG.to_yaml)
     end
 
@@ -35,7 +37,11 @@ module Committer
       puts 'Example config format:'
       puts '---'
       puts 'api_key: your_api_key_here'
-      puts 'model: claude-3-sonnet-20240229'
+      puts 'model: claude-3-7-sonnet-20250219'
+      puts 'scopes:'
+      puts '  - feature'
+      puts '  - api'
+      puts '  - ui'
     end
   end
 end

data/lib/committer/prompt_templates.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+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
+  end
+end

data/lib/committer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: committer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Sebastien Stettler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-05 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -29,21 +29,21 @@ description: A tool that uses Claude API to generate conventional commit message
 email:
 - sebastien@managerbot.dev
 executables:
-- git-smart-commit
 - committer
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - bin/committer
-- bin/git-smart-commit
 - lib/clients/claude_client.rb
 - lib/committer/config.rb
+- lib/committer/prompt_templates.rb
 - lib/committer/version.rb
 homepage: https://github.com/Hyper-Unearthing/committer
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/bin/git-smart-commit

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# This is a git integration script that allows users to run:
-# git smart-commit
-# which will forward to the committer command
-
-require_relative 'committer'