ai-changelog-generator-extension 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/QUICK-START.md ADDED
@@ -0,0 +1,211 @@
1
+ # Quick Start Guide - v0.2.0
2
+
3
+ ## 🚀 Installation
4
+
5
+ 1. Install the VSIX file:
6
+ ```bash
7
+ code --install-extension ai-changelog-generator-extension-0.2.0.vsix
8
+ ```
9
+
10
+ 2. Or install from VSCode:
11
+ - Open Extensions (Cmd+Shift+X)
12
+ - Click "..." menu → "Install from VSIX"
13
+ - Select `ai-changelog-generator-extension-0.2.0.vsix`
14
+
15
+ ## 🎯 First Time Setup (Improved!)
16
+
17
+ ### Step 1: Launch Setup Wizard
18
+ - Extension automatically prompts on first activation
19
+ - Or run: **Command Palette** → `AI Changelog: Setup Wizard`
20
+
21
+ ### Step 2: Follow the 3-Step Process
22
+
23
+ **Step 1 of 3: Choose Storage**
24
+ - 🔒 **Secure Storage** (Recommended) - VSCode secret storage
25
+ - 📄 **Environment File** - .env.local in workspace
26
+ - ⚙️ **Settings File** - settings.json (not recommended)
27
+
28
+ **Step 2 of 3: Select Provider**
29
+ Choose from:
30
+ - OpenAI (GPT-4, GPT-4 Turbo, GPT-4o)
31
+ - Anthropic (Claude 3.5 Sonnet, Opus)
32
+ - Google (Gemini Pro, Ultra)
33
+ - Azure OpenAI
34
+ - AWS Bedrock
35
+ - Ollama (local)
36
+ - LM Studio (local)
37
+
38
+ **Step 3 of 3: Enter Credentials**
39
+ - Enter API key (validated for length)
40
+ - Azure users: also enter endpoint and deployment
41
+ - Local providers: configure host URL
42
+
43
+ ### Step 3: Test Connection
44
+ After setup, click **"Test Now"** to verify everything works!
45
+
46
+ ## 📊 Check Your Status
47
+
48
+ ### Status Bar Indicator
49
+ Look at the bottom-right of VSCode:
50
+ - ✅ **AI Changelog: Ready** - All configured and working
51
+ - ⚠️ **AI Changelog: Setup Required** - Needs configuration
52
+ - ❌ **AI Changelog: Error** - Something's wrong
53
+
54
+ **Click the status bar** to see detailed report!
55
+
56
+ ### View Detailed Status
57
+ Run: `AI Changelog: Show Status`
58
+
59
+ You'll see:
60
+ ```markdown
61
+ # AI Changelog Generator Status
62
+
63
+ ## Configuration Status
64
+ ✅ Setup completed
65
+ ✅ Provider configured: openai
66
+ ✅ API key configured
67
+ ✅ Storage mode: secrets
68
+
69
+ ## Provider Details
70
+ - Provider: OpenAI
71
+ - Model: gpt-4-turbo
72
+ - Available: Yes
73
+
74
+ ## Recommendations
75
+ ✓ Everything looks good! You're ready to generate commits and changelogs.
76
+ ```
77
+
78
+ ## 🔍 Test Your Connection
79
+
80
+ Run: `AI Changelog: Test Connection`
81
+
82
+ **Success:**
83
+ ```
84
+ ✅ Connection test successful!
85
+ Provider: OpenAI
86
+ Response time: 847ms
87
+
88
+ Configuration is working correctly.
89
+ ```
90
+
91
+ **Failure:**
92
+ ```
93
+ ❌ Connection test failed
94
+ Provider: OpenAI
95
+ Error: Invalid API key
96
+
97
+ [Open Logs] [Reconfigure]
98
+ ```
99
+
100
+ ## 📝 View Logs
101
+
102
+ Run: `AI Changelog: Show Logs`
103
+
104
+ See exactly what the extension is doing:
105
+ ```
106
+ [2024-01-15 10:30:00] Extension activation started
107
+ [2024-01-15 10:30:01] Setup complete: true
108
+ [2024-01-15 10:30:01] Configuration loaded successfully
109
+ [2024-01-15 10:30:02] Status bar updated: Ready
110
+ ```
111
+
112
+ ## 🎨 Using the Extension
113
+
114
+ ### Generate Commit Messages
115
+
116
+ 1. Make changes to your files
117
+ 2. Open **Source Control** sidebar
118
+ 3. Click **"AI Changelog: Commit Assistant"** panel
119
+ 4. Review changed files
120
+ 5. Click **"Generate Commit Message"**
121
+ 6. AI analyzes changes and suggests commit message
122
+ 7. Copy or edit as needed
123
+
124
+ ### Generate Release Notes
125
+
126
+ 1. Open **"AI Changelog: Release Manager"** panel
127
+ 2. View available tags
128
+ 3. Select tag range (e.g., v1.0.0...v2.0.0)
129
+ 4. Click **"Generate Changelog"**
130
+ 5. AI analyzes all commits in range
131
+ 6. Get formatted changelog with categories
132
+
133
+ ## 🔧 Troubleshooting
134
+
135
+ ### Status Bar Shows ⚠️
136
+ **Problem:** Setup not complete
137
+ **Solution:** Run `AI Changelog: Setup Wizard`
138
+
139
+ ### Status Bar Shows ❌
140
+ **Problem:** Configuration error
141
+ **Solutions:**
142
+ 1. Click status bar to see detailed error
143
+ 2. Run `AI Changelog: Show Logs` for details
144
+ 3. Run `AI Changelog: Test Connection` to verify
145
+ 4. Re-run setup wizard if needed
146
+
147
+ ### Connection Test Fails
148
+ **Solutions:**
149
+ 1. Check API key is correct
150
+ 2. Verify provider endpoint (Azure/Bedrock)
151
+ 3. Check network connection
152
+ 4. View logs for detailed error
153
+ 5. Try reconfiguring with setup wizard
154
+
155
+ ### .env File Not Detected
156
+ **Solution:**
157
+ - Ensure .env or .env.local exists in workspace root
158
+ - Run `AI Changelog: Detect Environment Variables`
159
+ - Or manually configure in setup wizard
160
+
161
+ ## 💡 Pro Tips
162
+
163
+ 1. **Keep Status Bar Visible** - Always know your configuration state
164
+ 2. **Test After Setup** - Verify everything works immediately
165
+ 3. **Check Logs** - When something doesn't work, logs show exactly what happened
166
+ 4. **Use .env Files** - Easier to manage and share configurations
167
+ 5. **Click Status Bar** - Quick access to detailed status report
168
+
169
+ ## 📚 Command Reference
170
+
171
+ | Command | Purpose | When to Use |
172
+ |---------|---------|-------------|
173
+ | `AI Changelog: Setup Wizard` | Initial configuration | First time or reconfigure |
174
+ | `AI Changelog: Test Connection` | Verify AI provider | After setup or when unsure |
175
+ | `AI Changelog: Show Status` | View configuration | Check what's configured |
176
+ | `AI Changelog: Show Logs` | View activity logs | Troubleshooting |
177
+ | `AI Changelog: Configure AI Provider` | Change provider | Switch providers |
178
+ | `AI Changelog: Detect Environment Variables` | Find .env keys | Import existing keys |
179
+ | `AI Changelog: Generate Commit Message` | Create commit | When ready to commit |
180
+ | `AI Changelog: Generate Release` | Create changelog | Preparing release |
181
+
182
+ ## 🎯 What's Different from v0.1.0?
183
+
184
+ ### Before (v0.1.0)
185
+ - ❌ No feedback - didn't know if setup worked
186
+ - ❌ Silent failures - errors hidden
187
+ - ❌ No testing - couldn't verify configuration
188
+ - ❌ No visibility - unclear what's configured
189
+
190
+ ### Now (v0.2.0)
191
+ - ✅ Status bar - always know the state
192
+ - ✅ Test connection - verify it works
193
+ - ✅ Detailed reports - see configuration
194
+ - ✅ Comprehensive logs - understand what's happening
195
+ - ✅ Better errors - clear messages with solutions
196
+ - ✅ Progress indicators - know what's happening
197
+
198
+ ## Need Help?
199
+
200
+ 1. **Check Status Bar** - See current state
201
+ 2. **View Status Report** - Detailed configuration
202
+ 3. **Test Connection** - Verify provider works
203
+ 4. **Check Logs** - See what's happening
204
+ 5. **Re-run Setup** - Start fresh if needed
205
+
206
+ ---
207
+
208
+ **Version:** 0.2.0
209
+ **Package:** ai-changelog-generator-extension-0.2.0.vsix
210
+ **Size:** 44.65 KB
211
+ **Ready to use!** 🚀
package/README.md ADDED
@@ -0,0 +1,95 @@
1
+ # AI Changelog Generator - VS Code Extension
2
+
3
+ AI-powered changelog and commit message generator integrated directly into VS Code.
4
+
5
+ ## Features
6
+
7
+ - 🤖 **AI Commit Messages** - Generate meaningful commit messages from your staged changes
8
+ - 📝 **Smart Changelog Generation** - Create professional changelogs with one click
9
+ - 🔄 **Multiple AI Providers** - Supports OpenAI, Anthropic, Google, Azure, and more
10
+ - 🔒 **Secure API Key Storage** - Keys stored in VS Code's secret storage
11
+ - 🎯 **Git Integration** - Works seamlessly with VS Code's built-in Git
12
+
13
+ ## Installation
14
+
15
+ 1. Install from VS Code Marketplace
16
+ 2. Run command: `AI Changelog: Configure AI Provider`
17
+ 3. Select your preferred AI provider and enter API key
18
+ 4. Start generating!
19
+
20
+ ## Usage
21
+
22
+ ### Generate Commit Message
23
+
24
+ 1. Stage your changes in VS Code's Source Control panel
25
+ 2. Open the AI Changelog sidebar
26
+ 3. Click "Generate Commit Message"
27
+ 4. Select from AI-generated suggestions
28
+
29
+ ### Create Release
30
+
31
+ 1. Open Release Manager in the sidebar
32
+ 2. Click "Draft New Release"
33
+ 3. Enter version number
34
+ 4. AI generates changelog from commits since last tag
35
+
36
+ ## Configuration
37
+
38
+ Configure in VS Code Settings (search for "AI Changelog"):
39
+
40
+ - `aiChangelog.provider` - AI provider (openai, anthropic, etc.)
41
+ - `aiChangelog.model` - Override default model
42
+ - `aiChangelog.temperature` - Control creativity (0.0-1.0)
43
+
44
+ ## Requirements
45
+
46
+ - Node.js >= 22.21.1
47
+ - Git repository
48
+ - API key for chosen AI provider
49
+
50
+ ## Supported AI Providers
51
+
52
+ - **OpenAI** (GPT-4.1, o3, o4)
53
+ - **Anthropic** (Claude 3.5 Sonnet, Opus)
54
+ - **Google** (Gemini 2.0)
55
+ - **Azure OpenAI**
56
+ - **AWS Bedrock**
57
+ - **Ollama** (Local models)
58
+ - **LM Studio** (Local models)
59
+
60
+ ## Extension Settings
61
+
62
+ This extension contributes the following settings:
63
+
64
+ * `aiChangelog.provider`: Select AI provider
65
+ * `aiChangelog.model`: Override default model
66
+ * `aiChangelog.temperature`: Control generation creativity
67
+
68
+ ## Known Issues
69
+
70
+ - First-time setup requires manual API key entry
71
+ - Large diffs may take longer to analyze
72
+
73
+ ## Release Notes
74
+
75
+ ### 0.1.0
76
+
77
+ Initial release:
78
+ - Commit message generation
79
+ - Changelog generation
80
+ - Multi-provider support
81
+ - Secure key storage
82
+
83
+ ## Development
84
+
85
+ Built on top of [@entro314labs/ai-changelog-generator](https://www.npmjs.com/package/@entro314labs/ai-changelog-generator)
86
+
87
+ ## License
88
+
89
+ MIT
90
+
91
+ ## Links
92
+
93
+ - [GitHub Repository](https://github.com/entro314-labs/ai-changelog-generator-vscode)
94
+ - [Report Issues](https://github.com/entro314-labs/ai-changelog-generator-vscode/issues)
95
+ - [Core Package](https://github.com/entro314-labs/AI-changelog-generator)
@@ -0,0 +1,176 @@
1
+ # VSCode Extension - Version 0.2.0 Updates
2
+
3
+ ## What's New
4
+
5
+ ### 🎯 Major Improvements
6
+
7
+ **1. Status Bar Indicator**
8
+ - Added persistent status bar icon showing extension configuration state
9
+ - Visual indicators: ✅ (ready), ⚠️ (needs setup), ❌ (error)
10
+ - Click to view detailed status report
11
+ - Always visible so you know at a glance if everything is working
12
+
13
+ **2. Connection Testing**
14
+ - New "Test Connection" command to validate AI provider setup
15
+ - Automatically offered after setup wizard completion
16
+ - Tests actual API connectivity with progress indicators
17
+ - Clear success/error feedback with actionable buttons
18
+ - Command: `AI Changelog: Test Connection`
19
+
20
+ **3. Enhanced Setup Wizard**
21
+ - Now with detailed step indicators (Step 1 of 3, Step 2 of 3, etc.)
22
+ - Better validation with helpful error messages
23
+ - API key length validation
24
+ - More informative progress messages
25
+ - Automatic connection test offer after setup
26
+ - Better error handling and logging
27
+
28
+ **4. Status Report**
29
+ - Detailed markdown report showing:
30
+ - ✅ Setup completion status
31
+ - 🔑 API key configuration
32
+ - 📦 Storage mode (secrets/env/settings)
33
+ - 🤖 Selected provider and model
34
+ - 🎯 Provider availability check
35
+ - 💡 Actionable recommendations
36
+ - Command: `AI Changelog: Show Status`
37
+
38
+ **5. Logging System**
39
+ - Output channel for all extension activities
40
+ - View detailed logs to understand what's happening
41
+ - Helpful for troubleshooting
42
+ - Command: `AI Changelog: Show Logs`
43
+
44
+ ## New Commands
45
+
46
+ 1. **AI Changelog: Test Connection** - Test your AI provider connection
47
+ 2. **AI Changelog: Show Status** - View detailed configuration status
48
+ 3. **AI Changelog: Show Logs** - Open output channel with logs
49
+
50
+ ## Technical Improvements
51
+
52
+ ### StatusService
53
+ - Centralized status management
54
+ - Real-time status bar updates
55
+ - Configuration health checking
56
+ - Structured logging
57
+ - Status report generation
58
+
59
+ ### Enhanced Setup Wizard
60
+ - Step-by-step progress indicators
61
+ - Better validation and error messages
62
+ - Automatic .env detection and import
63
+ - Connection testing integration
64
+ - Comprehensive logging
65
+
66
+ ### Better Error Handling
67
+ - All operations now logged
68
+ - Clear error messages with context
69
+ - Actionable error prompts (buttons to fix issues)
70
+ - No more silent failures
71
+
72
+ ## User Experience Improvements
73
+
74
+ ### Before (v0.1.0)
75
+ - ❌ No way to know if setup worked
76
+ - ❌ No feedback during operations
77
+ - ❌ Silent failures
78
+ - ❌ Unclear what was configured
79
+ - ❌ No way to test if provider works
80
+
81
+ ### After (v0.2.0)
82
+ - ✅ Status bar shows configuration state
83
+ - ✅ Progress indicators during setup
84
+ - ✅ Test connection validates everything works
85
+ - ✅ Detailed status reports available
86
+ - ✅ Comprehensive logging for troubleshooting
87
+ - ✅ Clear error messages with fix suggestions
88
+ - ✅ Always know what's working and what isn't
89
+
90
+ ## How to Use
91
+
92
+ ### First Time Setup
93
+ 1. Extension will show welcome message
94
+ 2. Click "Start Setup" to begin wizard
95
+ 3. Follow 3 simple steps:
96
+ - Choose storage method
97
+ - Select AI provider
98
+ - Enter credentials
99
+ 4. Click "Test Now" to verify connection
100
+ 5. Check status bar for ✅ indicator
101
+
102
+ ### Check Status Anytime
103
+ - Click status bar icon for detailed report
104
+ - Or run: `AI Changelog: Show Status`
105
+
106
+ ### Test Connection
107
+ - Run: `AI Changelog: Test Connection`
108
+ - Get instant feedback if your provider is working
109
+
110
+ ### View Logs
111
+ - Run: `AI Changelog: Show Logs`
112
+ - See what the extension is doing behind the scenes
113
+
114
+ ## File Changes
115
+
116
+ ### New Files
117
+ - `src/services/StatusService.ts` - Status bar and reporting
118
+ - `src/commands/testConnection.ts` - Connection testing
119
+
120
+ ### Enhanced Files
121
+ - `src/extension.ts` - Integrated status service, logging, new commands
122
+ - `src/commands/setupWizard.ts` - Better UX, validation, testing
123
+ - `package.json` - Added 3 new commands
124
+
125
+ ### Commands Registered
126
+ ```json
127
+ {
128
+ "ai-changelog.testConnection": "Test Connection",
129
+ "ai-changelog.showStatus": "Show Status",
130
+ "ai-changelog.showLogs": "Show Logs"
131
+ }
132
+ ```
133
+
134
+ ## Testing the Extension
135
+
136
+ 1. Open Extension Development Host (F5)
137
+ 2. Run setup wizard or check status bar
138
+ 3. Test all new commands:
139
+ - Test Connection
140
+ - Show Status
141
+ - Show Logs
142
+ 4. Verify status bar updates correctly
143
+ 5. Try different scenarios:
144
+ - Fresh install (no setup)
145
+ - After setup completion
146
+ - With .env file detected
147
+ - Connection failures
148
+
149
+ ## Build Info
150
+
151
+ - **Version**: 0.2.0
152
+ - **Package Size**: 44.65 KB (was 35.9 KB - added features)
153
+ - **Files**: 25 files
154
+ - **New Dependencies**: None (no package changes)
155
+ - **Compiled**: ✅ No TypeScript errors
156
+ - **Packaged**: ✅ ai-changelog-generator-extension-0.2.0.vsix
157
+
158
+ ## What This Solves
159
+
160
+ ### Original Issue
161
+ > "needs more work, it is almost unusable, the setup should be more robust and intuitive as well as the setting should have reactiveness and feedback, right now i have no idea what work and what doesnt"
162
+
163
+ ### Resolution
164
+ ✅ **Robust Setup** - Step-by-step wizard with validation and error handling
165
+ ✅ **Intuitive** - Clear progress indicators, helpful messages, guided flow
166
+ ✅ **Reactiveness** - Status bar updates in real-time
167
+ ✅ **Feedback** - Progress indicators, success/error messages, logging
168
+ ✅ **Know What Works** - Status bar icon, status report, connection testing
169
+
170
+ ## Next Steps
171
+
172
+ 1. Test the extension thoroughly
173
+ 2. Verify all commands work as expected
174
+ 3. Check that status bar updates correctly
175
+ 4. Ensure connection testing works with different providers
176
+ 5. Validate error scenarios are handled gracefully