DevExplain

DevExplain is a Visual Studio Code extension that provides instant AI-powered explanations and fixes for selected code snippets. It helps developers understand complex code and quickly resolve issues using advanced AI technology.

Features

• Explain Selected Code: Get detailed explanations of any code snippet you select in your editor.
• AI-Powered Fixes: Automatically generate fixes for bugs and issues in your code.
• Seamless Integration: Works directly within VS Code for a smooth development experience.

Requirements

• Visual Studio Code version 1.118.0 or higher
• Node.js (for development and building)

Installation

From VS Code Marketplace (Recommended)

1. Open Visual Studio Code
2. Go to the Extensions view (Ctrl+Shift+X)
3. Search for "DevExplain"
4. Click Install

From Source (Development)

1. Clone this repository:

   git clone https://github.com/your-username/devexplain.git
   cd devexplain
   

2. Install dependencies:

   npm install
   

3. Compile the extension:

   npm run compile
   

4. Install the extension in VS Code:

   • Open VS Code
   • Press F5 to open a new Extension Development Host window
   • Or use the "Extensions: Install from VSIX" command

Usage

1. Select a piece of code in your editor
2. Right-click and choose "Explain Selected Code" or "Fix Code with AI" from the context menu
3. Alternatively, use the Command Palette (Ctrl+Shift+P) and search for the respective commands

Configuration

DevExplain uses environment variables for AI service configuration. Create a .env file in your workspace root with the necessary API keys and settings.

Development

Building

npm run compile

Watching for Changes

npm run watch

Testing

npm test

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Umang Raj

Changelog

See CHANGELOG.md for a list of changes and updates.