jeeves-git-commit 1.7.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +37 -3
  3. data/lib/jeeves/version.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 407442b3b749a136eecb78cfc15cdd0a5b56a43e970a03c4532b5e1ae1c28aca
4
- data.tar.gz: 0feb07197e41aa3b00c49cf675a39cbd2f6286e8de57601eff5cda29f2d14d57
3
+ metadata.gz: 184fa0652a35d79f4dde5b5196c5fefbd63f1c75604fc46bed8d5c9c28bc4bdd
4
+ data.tar.gz: b76f88a55227d9ad1b29d30496cfeb517b525119cd60095aa9cdce0f07ab0fa3
5
5
  SHA512:
6
- metadata.gz: 2999adf5b84c635dd1d0e3d46b8940f992171809e4a95a3475f4b72f55d120984eca26940eab54f6c99708d23d0f7b36730806537d820ae50c4bb476ba31176e
7
- data.tar.gz: e7361afc36a6ded42be77b4b412d015fb73da4dca2c94d1637b21bd9527923de96d43313a847c632cafcf8e1e8bee90d82c98523f8e83eecd0f258ac2ec2f7d6
6
+ metadata.gz: 3749715826524d126c90e730582def14ac2381d5c0652c10006497b6f4e36356822b7ea148f28dea4de9206b4cf19933efe1141cc780ceda62fb5d7b83de02ef
7
+ data.tar.gz: 47c087226cf452463707fa91b824f52e5431ca2c4db89104e7ebe4c9981d38e3cb851b269bf83ae4b068d0738325f2c28f4aee9730b9958e24a1641bc649ae03
data/README.md CHANGED
@@ -8,10 +8,11 @@ Jeeves is a command-line tool that helps you create AI-powered Git commit messag
8
8
 
9
9
  ## Features
10
10
 
11
- - Generate intelligent commit messages based on your staged changes
11
+ - Generate intelligent [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) messages with [gitmoji](https://gitmoji.dev) based on your staged changes.
12
12
  - Option to automatically stage all changes before committing
13
13
  - Option to push changes after committing
14
14
  - Customizable AI prompts for tailored commit message generation
15
+ - Choose any AI model (chat-gpt 4.1-mini by default)
15
16
 
16
17
  ## Installation
17
18
 
@@ -108,9 +109,18 @@ The default model is `openai/gpt-4.1-mini` if not specified.
108
109
 
109
110
  ### Prompt Configuration
110
111
 
111
- Jeeves stores its configuration in `~/.config/jeeves/`. You can customize the AI prompt by editing the `prompt` file in this directory.
112
+ Jeeves supports two levels of prompt configuration:
112
113
 
113
- When you run Jeeves for the first time, if there's no prompt file in the config directory, it will copy `config/prompt` to the config directory automatically.
114
+ 1. **Global Prompt (Default)**: Stored in `~/.config/jeeves/prompt`. This is used for all repositories unless overridden.
115
+ 2. **Repository-Specific Prompt**: Create a `.jeeves_prompt` file in the root of your Git repository to customize the prompt for that specific project.
116
+
117
+ When you run Jeeves, it will:
118
+ 1. First look for a `.jeeves_prompt` file in the root of the current Git repository
119
+ 2. If not found, fall back to the global prompt at `~/.config/jeeves/prompt`
120
+
121
+ When you run Jeeves for the first time, if there's no global prompt file in the config directory, it will copy `config/prompt` to the config directory automatically.
122
+
123
+ The special string: `{{DIFF}}`, in your prompt will be replaced with the current git diff.
114
124
 
115
125
  ## Usage
116
126
 
@@ -146,6 +156,30 @@ MIT
146
156
 
147
157
  ## Development
148
158
 
159
+ ### Project Structure
160
+
161
+ Jeeves follows a specific project structure where all gemspec files and built gem files (.gem) are placed in the `gemspec/` folder rather than the root directory. This keeps the root directory clean and organized.
162
+
163
+ ### Rake Tasks
164
+
165
+ Jeeves provides several rake tasks to streamline development:
166
+
167
+ ```bash
168
+ # Run the test suite
169
+ rake test
170
+
171
+ # Build the gem and place it in the gemspec/ folder
172
+ rake build
173
+
174
+ # Build, install and test the gem
175
+ rake install
176
+
177
+ # Build and push the gem to RubyGems
178
+ rake push
179
+ ```
180
+
181
+ The default task is `rake test`.
182
+
149
183
  ### Testing
150
184
 
151
185
  Jeeves uses Minitest for testing. To run the tests:
@@ -1,3 +1,3 @@
1
1
  module Jeeves
2
- VERSION = '1.7.0'
2
+ VERSION = '1.9.0'
3
3
  end
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jeeves-git-commit
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.7.0
4
+ version: 1.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Justin Bishop
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-05-20 00:00:00.000000000 Z
10
+ date: 2025-05-23 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: json