Vibe Code Assistant

🤖 The Smart VS Code Extension That Supercharges GitHub Copilot with Context-Aware Instructions

🚀 What Does This Extension Do?

Transform your coding experience with context-aware instructions that automatically enhance GitHub Copilot's suggestions based on your project's technology stack, coding standards, and best practices.

Key Benefits:

• 🎯 Intelligent Context Detection - Automatically applies relevant coding standards
• 📚 Comprehensive Instruction Sets - 9+ professional-grade instruction files
• 🔍 Smart Prompts - 5+ contextual development prompts for common tasks
• ⚡ Zero Configuration - Works instantly with any project
• 🛡️ 100% Private - All processing happens locally in VS Code

🎯 Quick Start Guide

1. Install the extension from VS Code Marketplace
2. Open any project in VS Code
3. Extension auto-activates and detects your tech stack
4. Use command palette (Ctrl+Shift+P) → "Vibe: Apply Instructions"
5. Enhanced GitHub Copilot suggestions appear immediately

That's it! 🎉 Your development workflow is now supercharged.

📚 What Instructions Are Included?

🟢 Backend Development

• ✅ Go - 5 comprehensive instruction sets:
  • go.best-practices.instructions.md - Coding standards and style guidelines
  • go.development.instructions.md - Development workflows and patterns
  • go.design-architecture.instructions.md - Architectural patterns and system design
  • go.otel-observability-logging-metrics.instructions.md - OpenTelemetry and observability
  • go.power-user-guide.instructions.md - Advanced optimization techniques
• ✅ Python - python.instructions.md - PEP compliance, Django/Flask/FastAPI, testing, packaging

🔵 Infrastructure & DevOps

• ✅ Terraform - terraform.instructions.md - AWS, Azure, GCP best practices
• ✅ Bash Scripting - bash.instructions.md - Security, error handling, portability
• ✅ Software Requirements - software.requirements.instructions.md - Project planning and documentation standards

🎯 Smart Prompts System

• 🔍 Code Review - go.review.prompt.md - Automated Go code analysis
• 🔒 Security Analysis - secrets-detection.prompt.md - Secret detection and vulnerability scanning
• 📊 Effort Estimation - software.effort.estimation.prompt.md - Comprehensive project planning
• 🧹 Linting & Quality - linting.prompt.md - Code formatting and standards
• 🛠️ Jenkins Pipeline - jenkins.estimation.prompt.md - CI/CD optimization and estimation

📋 How to Use the Extension

⌨️ Method 1: Keyboard Shortcuts

• Ctrl+Shift+V A / Cmd+Shift+V A - Analyze Code & Apply Instructions
• Ctrl+Shift+V P / Cmd+Shift+V P - Suggest Contextual Prompt

🖱️ Method 2: Right-Click Context Menu

• Right-click any file → "Analyze Code & Apply Instructions" → Done!
• Right-click any file → "Apply Contextual Prompts" → Done!
• Right-click any file → "Add Workspace Guidelines" → Done!

⚙️ Configuration & Settings

🔧 Extension Settings

{
  "vibeAssistant.autoApplyInstructions": true,
  "vibeAssistant.enableContextualPrompts": true,
  "vibeAssistant.showNotifications": true,
  "vibeAssistant.autoIgnoreAIFiles": true,
  "vibeAssistant.supportedLanguages": ["go", "python", "terraform", "bash", "javascript", "typescript"]
}

📝 What Gets Created in Your Project?

When you use the extension, it creates a comprehensive resource structure:

your-project/
├── .github/
│   ├── instructions/          # 📚 Language-specific best practices
│   │   ├── go.best-practices.md
│   │   ├── go.development.md
│   │   ├── go.design-architecture.md
│   │   ├── go.otel-observability-logging-metrics.md
│   │   ├── go.power-user-guide.md
│   │   ├── python.instructions.md
│   │   ├── terraform.instructions.md
│   │   ├── bash.instructions.md
│   │   └── software.requirements.md
│   ├── prompts/               # 🎯 Smart development prompts
│   │   ├── go.review.md
│   │   ├── software.effort.estimation.md
│   │   ├── secrets-detection.md
│   │   ├── linting.md
│   │   └── jenkins.estimation.md
├── .vscode/                  # ⚙️ VS Code workspace settings
│       └── mcp.json          # MCP server configurations
├── how-to-guides/            # 📖 Development guides
│       ├── vibe-workflow.md
│       ├── vs-copilot-how-to-instructions.md
│       ├── vs-copilot-how-to-mcp-server.md
│       └── vs-copilot-how-to-prompts.md
├── .gitignore                 # 🚫 Auto-updated to ignore AI files
└── your-code-files...

🌟 Real-World Examples

🔍 Go Development Example

// Extension automatically detects Go and applies:
// - Best practices from go.best-practices.instructions.md
// - OTEL patterns from go.otel-observability-logging-metrics.instructions.md
// - Architecture patterns from go.design-architecture.instructions.md

package main

import "github.com/gin-gonic/gin"  // ← Extension detects Gin framework

func main() {
    r := gin.Default()
    // Copilot now suggests OTEL middleware, proper error handling,
    // structured logging, and Go best practices automatically
}

🐍 Python Development Example

# Extension automatically detects Python and applies:
# - PEP 8 compliance instructions
# - Type hinting guidelines  
# - Django/Flask patterns (if detected)

from django.db import models  # ← Extension detects Django

class User(models.Model):
    # Copilot now suggests Django best practices
    name = models.CharField(max_length=100)
    # ... Enhanced suggestions for Django models

🧠 Smart Context Detection

The extension intelligently analyzes your codebase and automatically applies relevant instructions:

🔍 Technologies Auto-Detected

📋 Languages & Frameworks Auto-Detected

🏗️ Technical Architecture

Built with modern TypeScript and VS Code Extension API:

• src/extension.ts - Main extension entry point
• src/contextAnalyzer.ts - Intelligent code pattern recognition
• src/instructionManager.ts - Dynamic instruction loading and application
• src/promptManager.ts - Smart prompt suggestions
• src/resourceManager.ts - Comprehensive resource file management
• src/copilotIntegration.ts - Direct GitHub Copilot Chat enhancement

🛠️ For Developers: Building & Contributing

🚀 Quick Setup

# 1. Clone the repository
git clone https://github.com/vibe-tech/vibe-code-assistant.git
cd vibe-code-assistant-extension

# 2. Install dependencies
npm install

# 3. Compile TypeScript
npm run compile

# 4. Run in development mode
npm run watch    # Auto-recompile on changes

🧪 Testing the Extension

# Method 1: Debug Mode
1. Open VS Code in this project
2. Press F5 to launch Extension Development Host
3. New VS Code window opens with extension loaded
4. Open any project and test functionality

# Method 2: Package & Install
npm run package                           # Creates .vsix file
code --install-extension vibe-code-assistant-.vsix

📦 Build Commands

npm run compile          # Compile TypeScript
npm run watch           # Watch for changes  
npm run package         # Create .vsix package
npm run package:webpack # Create optimized bundle
npm run publish         # Publish to marketplace

🔧 Troubleshooting

❓ Common Issues & Solutions

🔍 Debug Information

Enable debug logging in settings:

{
  "vibeAssistant.showNotifications": true
}

Check Output panel: View > Output > Vibe Code Assistant

📧 Getting Help

• 🐛 Report Bugs: GitHub Issues
• 💡 Feature Requests: GitHub Discussions
• 📚 Documentation: GitHub Wiki
• 💬 Community: Discord Server

🤝 Contributing to Vibe Code Assistant

We ❤️ contributions! Here's how you can help make this extension even better:

🐛 Report Issues

Found a bug? Help us fix it!

1. Go to GitHub Issues
2. Click "New Issue" 
3. Describe the problem with:
   - Steps to reproduce
   - Expected vs actual behavior  
   - VS Code version & OS
   - Extension version

💡 Suggest New Features

Have ideas for new instructions or prompts?

1. Check existing GitHub Discussions
2. Create new discussion with:
   - Use case description
   - Example scenarios
   - Proposed implementation

🔧 Add New Instructions

Want to add support for a new language or framework?

# 1. Fork the repository
# 2. Add instruction file
echo "# New Framework Instructions" > resources/instructions/new-framework.instructions.md

# 3. Follow the format from existing instructions
# 4. Update src/instructionManager.ts if needed
# 5. Create pull request

🛡️ Privacy & Security

✅ 100% Local Processing - No data leaves your machine
✅ No Network Requests - All processing happens in VS Code ✅ No Telemetry - We don't collect usage data ✅ Open Source - Full transparency in all functionality ✅ Secure by Design - No credentials or sensitive data handled

📦 Publishing to VS Code Marketplace

📦 For Extension Publishers

# Install VSCE (VS Code Extension manager)
npm install -g vsce

# Login to Azure DevOps (one-time setup)
vsce login vibe-tech

# Package the extension
npm run package         # Creates .vsix file

# Publish to marketplace
vsce publish           # Auto-increments version

🔄 Updating the Extension

# Update version automatically
vsce publish patch    #  → 1.0.1
vsce publish minor    #  → 1.1.0  
vsce publish major    #  → 2.0.0

# Or update manually in package.json then:
vsce publish

📊 Extension Stats

• 📦 Package Size: 159KB (optimized with webpack bundling)
• 📁 File Count: 35+ files (reduced from 341 with .vscodeignore)
• 🎯 Supported Languages: 6+ (Go, Python, Terraform, Bash, JS, TS)
• 📚 Instructions Available: 9 comprehensive instruction sets
• 🎯 Prompts Available: 5+ contextual development prompts
• 📖 How-to Guides: 4 comprehensive development workflows
• ⚙️ VS Code Settings: MCP server configurations and workspace settings
• 🚀 Activation: Instant on file open
• 💾 Performance: Zero impact on VS Code startup

📝 License & Credits

📄 License

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

🎉 Credits

Built with ❤️ by the Vibe Development Team

Special Thanks:

• 🚀 VS Code Extension API Team - Excellent documentation and support
• 🤖 GitHub Copilot Team - Integration possibilities and guidance
• 🌟 Open Source Community - Inspiration, feedback, and contributions
• 👥 Beta Testers - Early feedback and bug reports

🌟 Show Your Support

If this extension helps you code better:

• ⭐ Star the repository on GitHub
• 📝 Leave a review on VS Code Marketplace
• 🐛 Report issues to help us improve
• 💡 Suggest features for future versions
• 🤝 Contribute with pull requests