SmoothDev Commit Message Generator

A VS Code extension for generating AI-powered commit messages using the SmoothDev.io commit message generator. This extension analyzes your staged changes and automatically generates descriptive, conventional commit messages.

Features

• Adds a "Generate Commit Message" button to the Source Control panel
• Automatically generates meaningful commit messages based on your staged changes
• Integrates seamlessly with the VS Code Git interface
• Secure device flow authentication with Auth0

Requirements

• VS Code version 1.75.0 or higher
• Git extension for VS Code
• Internet connection for authentication and API access

Installation

Local Installation (Development)

1. Clone the repository
2. Navigate to the vscode-extension directory
3. Run npm install to install dependencies
4. Run npm run windsurf:install to install in Windsurf
5. Or press F5 to start debugging the extension in a new VS Code window

Building the VSIX Package

To build a VSIX package for manual installation:

cd vscode-extension
npm install
npm run package

Then install the generated .vsix file in VS Code using the "Install from VSIX" command.

Usage

1. Make changes to your code and stage them using Git
2. Open the Source Control panel in VS Code
3. Click the "Generate Commit Message" button in the Source Control title bar
4. On first use, you'll need to authenticate through the device flow:
   • A notification will appear with instructions
   • Click "Open Browser" to open the authentication page
   • Enter the provided code in your browser
   • Authorize the application
   • The extension will automatically continue once authentication is complete
5. Wait for the commit message to be generated
6. Review and edit the generated message if needed
7. Commit your changes

Authentication

This extension uses a secure device flow authentication process with Auth0:

1. Authentication Flow: When you first use the extension (or when your token expires), you'll be prompted to authenticate via a browser.
2. Security: Your credentials are never stored in the extension; instead, a JWT token is securely stored in your user directory.
3. Configuration: The extension looks for configuration in:
   • ~/.smoothdevio/config.json (primary)
   • ~/.smoothdev/config.json (fallback)
4. Token Storage: JWT tokens are stored in:
   • ~/.smoothdevio/jwt (token)
   • ~/.smoothdevio/jwt_expiry (expiration timestamp)

For detailed information about authentication, see AUTHENTICATION.md.

Troubleshooting

If you encounter authentication issues:

1. Authentication Timeout: If authentication times out, try again and ensure you complete the process in your browser.
2. Debug Mode: Set the environment variable SMOOTHDEV_DEBUG=1 to enable detailed logging.
3. Expired Tokens: If your token expires, the extension will automatically initiate a new authentication flow.
4. Configuration Issues: Ensure your configuration files are properly set up. See AUTHENTICATION.md for details.

Extension Settings

This extension doesn't have any specific settings yet.

Known Issues

• The extension currently uses the first Git repository found in the workspace
• Authentication issues may occur if the browser is not opened promptly

Release Notes

1.0.2 (May 2025)

• Updated version with improved publisher ID configuration
• Fixed authentication and configuration issues
• Enhanced documentation and error handling

1.0.1 (May 2025)

• Initial public release of the SmoothDev Commit Message Generator
• Seamless integration with VS Code's Source Control panel
• Secure device flow authentication with Auth0
• Support for generating commit messages from staged changes
• Improved error handling and user feedback
• Comprehensive documentation

Distribution

This extension is available through:

• VS Code Marketplace
• Open VSX Registry

The extension is part of the SmoothDev Commit Message CLI project, which also includes:

• A Python CLI tool (available via PyPI)
• A Homebrew formula (available via brew install smoothdev-io/tap/smoothdev-commit-message-cli)

For more information about the distribution and release process, see the DISTRIBUTION.md file in the main repository.

About SmoothDev

SmoothDev provides AI-powered developer tools to improve your coding workflow. Visit smoothdev.io to learn more about our services.