Generate proper git commit message using ChatGPT in Vim

This commit adds functionality to generate a proper git commit message using ChatGPT in Vim.

The changes include:
- Adding an animated GIF to demonstrate the usage of the feature.
- Updating the README.md file with instructions on how to use the feature.
- Adding a script, `gptcommit.py`, in the `bin` directory for command line usage.
- Adding a new function, `gptcommit#gpt#generate()`, in the `gpt.vim` file to generate the commit message.
- Modifying the existing function, `gptcommit#gpt#generate()`, to ensure proper handling of fake messages if the `g:gpt_commit_fake` flag is set.
- Updating the `gptcommit.py` script to include an example commit message in the `EXAMPLE_MESSAGE` variable.
- Adding logic to display the example commit message if the `--concise` option is not provided.

These changes aim to improve the commit message generation process and make it more user-friendly.

Author: skywind3000

README.md

@@ -1,6 +1,9 @@
 # Preface
 
-Generate proper git commit message using ChatGPT in Vim
+Generate proper git commit message using ChatGPT in Vim:
+
+![](https://skywind3000.github.io/images/p/misc/2024/gptcommit1.gif)
+
 
 ## Quick start
 
@@ -55,5 +58,24 @@ If the bang (`!`) is included, `:GptCommand` will not append any text to the cur
 | g:gpt_commit_staged | - | `1` | set to 1 to use staged diff |
 | g:gpt_commit_max_line | - | `160` | max diff lines to reference |
 
+## Script
+
+For command line usage, you can execute `gptcommit.py` in the `bin` directory:
+
+```
+usage: python3 gptcommit.py <options> repo_path
+available options:
+  --key=xxx       required, your openai apikey
+  --staged        optional, use staged diff if present
+  --proxy=xxx     optional, proxy support
+  --maxline=num   optional, max diff lines to feed ChatGPT, default ot 160
+  --model=xxx     optional, can be gpt-3.5-turbo (default) or something
+  --lang=xxx      optional, output language
+  --concise       optional, generate concise message if present
+  --utf8          optional, output utf-8 encoded text if present
+```
+
+
+
 ## Credit
 

autoload/gptcommit/gpt.vim

@@ -66,7 +66,17 @@ function! gptcommit#gpt#generate(path) abort
 	endif
 	let args += [path]
 	" echo args
-	return gptcommit#utils#request(args)
+	let hr = gptcommit#utils#request(args)
+	if get(g:, 'gpt_commit_fake', 0)
+		if exists('g:gpt_commit_fake_msg')
+			if type(g:gpt_commit_fake_msg) == type([])
+				let hr = join(g:gpt_commit_fake_msg, "\n")
+			else
+				let hr = g:gpt_commit_fake_msg
+			endif
+		endif
+	endif
+	return hr
 endfunc
 
 

bin/gptcommit.py

@@ -271,6 +271,21 @@ def ExtractInfo(obj):
            'total_tokens': 1067}}
 
 
+EXAMPLE_MESSAGE = '''
+Add new function to handle command interface in gpt.vim and utils.vim files
+- Added a new function `gptcommit#gpt#cmd(bang, path)` to handle the command interface for generating the commit message.
+- Added logic to detect the current path if no path is provided.
+- Added logic to check if the provided path is a valid directory.
+- Added logic to check if the provided path is within a git repository.
+- Added logic to handle cases where the buffer is not writable.
+- Added logic to generate the commit message and display it.
+- Added logic to append the generated commit message to the current buffer or copy it to the unnamed register.
+- Modified the `gptcommit#utils#current_path()` function to handle cases specific to the `fugitive` plugin and the `gitcommit` filetype.
+- Added a new function `gptcommit#utils#buffer_writable()` to check if a buffer is writable.
+- Added a new function `gptcommit#utils#repo_root(path)` to find the root directory of a git repository.
+'''.strip('\r\n\t ')
+
+
 #----------------------------------------------------------------------
 # help
 #----------------------------------------------------------------------
@@ -365,6 +380,8 @@ def main(argv = None):
         obj = chatgpt_request(msgs, OPTIONS['key'], opts)
     else:
         obj = EXAMPLE_RETURN
+        if not OPTIONS['concise']:
+            obj['choices'][0]['message']['content'] = EXAMPLE_MESSAGE
     msg = ExtractInfo(obj)
     if not isinstance(msg, str):
         sys.exit(msg)