vscode-gptcommit

Introduction to vscode-gptcommit

The vscode-gptcommit is a powerful extension for Visual Studio Code (VS Code) that automates the process of generating meaningful git commit messages using advanced GPT models. This tool leverages the capabilities of the gptcommit tool, applying it effectively within the VS Code environment to enhance productivity and ensure clarity in commit messages.

Installation Process

To start using vscode-gptcommit, the user must undertake two major installation steps:

1. Install the Extension: Head over to the VS Code Marketplace and install the vscode-gptcommit extension.
2. Install gptcommit: Before using this tool fully, one must also install gptcommit itself. However, it is crucial not to install the gptcommit hook in the root of the git repository via gptcommit install.

Supported Versions

Compatibility between vscode-gptcommit, VS Code, and gptcommit is essential for smooth operation. Depending on the version of the extension, users must ensure they use compatible versions of VS Code and gptcommit, as demonstrated in the following table:

Key Commands

vscode-gptcommit introduces several commands that simplify its use. Users can access these commands through Ctrl+Shift+P or Cmd+Shift+P, according to their operating system. Here are the main features:

• Generate Git Commit Message: Allows users to automatically generate a commit message.
• Setup OpenAI API Key: Users must configure their OpenAI API key, obtainable from OpenAI.
• Use a Different OpenAI Model: Flexibility to choose a different OpenAI model, with documentation available in the OpenAI docs.
• Set Output Language: Users can specify the language for output; English is the default.
• Show Per-file Summary: Enables summaries for each file included in the commit.
• Disable Conventional Commit: Options to disable conventional commit messages.
• Open gptcommit configuration file: Direct access to the configuration file for further settings.

Extension Settings and Options

The vscode-gptcommit extension comes with customizable settings to adapt to user preferences:

• ExpressMode: Automatically fills the generated commit message into VS Code's Source Control input box.
• ExpressModeContent: Defines the content format used during ExpressMode.
• GptcommitPath: Specifies the path for the gptcommit executable.
• OnFiles: Options include using staged files, unstaged files, or a strategy that tries staged files first, then defaults to trying unstaged files if needed.

Advanced Configuration

For advanced users, the .git/gptcommit.toml configuration file retains all extension settings. If users wish to adjust their setup further, it is necessary to edit this file directly, with caution advised. Additionally, for a global setup, configurations can be conducted by copying the .git/gptcommit.toml file to a global configuration directory at ~/.config/gptcommit/config.toml.

In conclusion, vscode-gptcommit offers a sophisticated approach to generating git commit messages by harnessing the power of GPT models. This extension makes it easier for developers to focus on their coding while maintaining a consistent and meaningful commit message history. For more detailed information about gptcommit, users can visit the gptcommit GitHub page.