Finalize v0.5.0: docs, tests, and code cleanup for release

Author: Wilson421

docs/CONFIGURATION.md

@@ -156,10 +156,14 @@ Ctrl+Shift+P → "Excel Power Query: Apply Recommended Defaults"
 
 | Setting             | Type    | Default | Description                          | Use Cases                                                        |
 | ------------------- | ------- | ------- | ------------------------------------ | ---------------------------------------------------------------- |
-| `verboseMode`       | boolean | `false` | Detailed logs in Output panel        | ✅ Troubleshooting<br>✅ Understanding operations<br>❌ Clean UI |
-| `debugMode`         | boolean | `false` | Debug-level logging + files          | ✅ Extension development<br>❌ Normal usage                      |
+| `logLevel`          | string  | `info`  | Set logging level (`none`, `error`, `warn`, `info`, `verbose`, `debug`). Replaces legacy settings. | ✅ Control log detail<br>✅ Troubleshooting<br>❌ Minimal UI |
+| `verboseMode`       | boolean | `false` | **[DEPRECATED]** Use `logLevel` instead. Detailed logs in Output panel. | ✅ Troubleshooting<br>✅ Understanding operations<br>❌ Clean UI |
+| `debugMode`         | boolean | `false` | **[DEPRECATED]** Use `logLevel` instead. Debug-level logging + files. | ✅ Extension development<br>❌ Normal usage                      |
 | `showStatusBarInfo` | boolean | `true`  | Show watch/sync status in status bar | ✅ Visual feedback<br>❌ Minimal UI                              |
 
+
+**Note:** `verboseMode` and `debugMode` are deprecated and will be removed in a future release. The extension will automatically migrate these to `logLevel` on upgrade.
+
 **Example - Troubleshooting Setup:**
 
 ```json
@@ -170,6 +174,15 @@ Ctrl+Shift+P → "Excel Power Query: Apply Recommended Defaults"
 }
 ```
 
+
+**Example - Set Logging Level:**
+
+```json
+{
+  "excel-power-query-editor.logLevel": "debug"
+}
+```
+
 **Example - Extension Development:**
 
 ```json
@@ -311,30 +324,37 @@ Ctrl+Shift+P → "Excel Power Query: Apply Recommended Defaults"
 
 ### New Settings in v0.5.0:
 
+- `logLevel` - Set the logging level for the extension (replaces `verboseMode` and `debugMode`)
 - `sync.openExcelAfterWrite` - Automatically open Excel after sync
 - `sync.debounceMs` - Configurable sync delay (prevents CoPilot triple-sync)
 - `watch.checkExcelWriteable` - Excel file access validation
 - `backup.maxFiles` - Replaces deprecated `maxBackups`
 
 ### Deprecated Settings:
 
+- `verboseMode` - Use `logLevel` instead. Will be removed in a future release.
+- `debugMode` - Use `logLevel` instead. Will be removed in a future release.
 - `syncDeleteTurnsWatchOff` - Functionality merged with `watchOffOnDelete`
 
+
 ### Automatic Migration:
 
-The extension automatically migrates your v0.4.x settings. **No action required.**
+The extension automatically migrates your v0.4.x settings, including legacy logging settings (`verboseMode`, `debugMode`) to the new `logLevel` setting. **No action required.**
 
 ### Manual Migration (Optional):
 
 ```json
 // v0.4.x
 {
-  "excel-power-query-editor.maxBackups": 5
+  "excel-power-query-editor.maxBackups": 5,
+  "excel-power-query-editor.verboseMode": true,
+  "excel-power-query-editor.debugMode": false
 }
 
 // v0.5.0 (improved)
 {
-  "excel-power-query-editor.backup.maxFiles": 5
+  "excel-power-query-editor.backup.maxFiles": 5,
+  "excel-power-query-editor.logLevel": "verbose"
 }
 ```
 

docs/TESTING_NOTES_v0.5.0.md

@@ -1658,63 +1658,85 @@ async function rawExtraction(uri?: vscode.Uri, uris?: vscode.Uri[]): Promise<voi
 function dumpAllExtensionSettings(): void {
 	try {
 		log('=== EXTENSION SETTINGS DUMP ===', 'dumpAllExtensionSettings', 'debug');
-		
 		const extensionId = 'excel-power-query-editor';
-		
 		// Get all configuration scopes
 		const userConfig = vscode.workspace.getConfiguration(extensionId, null);
 		const workspaceConfig = vscode.workspace.getConfiguration(extensionId, vscode.workspace.workspaceFolders?.[0]?.uri);
-		
-		// Define all known extension settings
-		const knownSettings = [
-			'watchAlways',
-			'watchAlwaysMaxFiles',
-			'watchOffOnDelete', 
-			'syncDeleteAlwaysConfirm',
-			'verboseMode',
-			'autoBackupBeforeSync',
-			'backupLocation',
-			'customBackupPath',
-			'backup.maxFiles',
-			'autoCleanupBackups',
-			'syncTimeout',
-			'debugMode',
-			'showStatusBarInfo',
-			'sync.openExcelAfterWrite',
-			'sync.debounceMs',
-			'watch.checkExcelWriteable'
-		];
-		
-		log('USER SETTINGS (Global):', 'dumpAllExtensionSettings', 'debug');
-		for (const setting of knownSettings) {
-			const value = userConfig.get(setting);
-			const hasValue = userConfig.has(setting);
-			log(`  ${setting}: ${hasValue ? JSON.stringify(value) : '<not set>'}`, 'dumpAllExtensionSettings', 'debug');
-		}
-		
-		log('WORKSPACE SETTINGS:', 'dumpAllExtensionSettings', 'debug');
-		for (const setting of knownSettings) {
-			const value = workspaceConfig.get(setting);
-			const hasValue = workspaceConfig.has(setting);
-			log(`  ${setting}: ${hasValue ? JSON.stringify(value) : '<not set>'}`, 'dumpAllExtensionSettings', 'debug');
+		// Collect all keys from both configs
+		const allKeys = new Set<string>();
+		for (const key of Object.keys(userConfig)) { allKeys.add(key); }
+		for (const key of Object.keys(workspaceConfig)) { allKeys.add(key); }
+		// Always include logLevel
+		// allKeys.add('logLevel');
+		// Dump each setting with its value and source
+		for (const key of Array.from(allKeys).sort()) {
+			let value: any = undefined;
+			let source: string = 'default';
+			if (workspaceConfig.has(key)) {
+				value = workspaceConfig.get(key);
+				source = 'workspace';
+			} else if (userConfig.has(key)) {
+				value = userConfig.get(key);
+				source = 'user';
+			} else {
+				value = vscode.workspace.getConfiguration(extensionId).inspect(key)?.defaultValue;
+			}
+			log(`  ${key}: ${JSON.stringify(value)} [${source}]`, 'dumpAllExtensionSettings', 'debug');
 		}
-		
 		// Check environment info
 		log('ENVIRONMENT INFO:', 'dumpAllExtensionSettings', 'debug');
 		log(`  Remote Name: ${vscode.env.remoteName || '<not remote>'}`, 'dumpAllExtensionSettings', 'info');
 		log(`  VS Code Version: ${vscode.version}`, 'dumpAllExtensionSettings', 'info');
 		log(`  Workspace Folders: ${vscode.workspace.workspaceFolders?.length || 0}`, 'dumpAllExtensionSettings', 'info');
-
 		// Check if we're in a dev container
 		const isDevContainer = vscode.env.remoteName?.includes('dev-container');
 		log(`  Is Dev Container: ${isDevContainer}`, 'dumpAllExtensionSettings', 'info');
-
 		log('=== END SETTINGS DUMP ===', 'dumpAllExtensionSettings', 'info');
-		
 	} catch (error) {
 		log(`Failed to dump settings: ${error}`, 'dumpAllExtensionSettings', 'error');
 	}
 }
+// Migrate legacy debugMode/verboseMode to logLevel at activation
+export async function migrateLegacySettings() {
+	const extensionId = 'excel-power-query-editor';
+	const config = vscode.workspace.getConfiguration(extensionId);
+	const debugMode = config.get('debugMode');
+	const verboseMode = config.get('verboseMode');
+	let needsUpdate = false;
+	let newLogLevel: string | undefined = undefined;
+	if (debugMode === true) {
+		newLogLevel = 'debug';
+		needsUpdate = true;
+	} else if (verboseMode === true) {
+		newLogLevel = 'verbose';
+		needsUpdate = true;
+	}
+	if (needsUpdate) {
+		await config.update('logLevel', newLogLevel, vscode.ConfigurationTarget.Workspace);
+		await config.update('debugMode', undefined, vscode.ConfigurationTarget.Workspace);
+		await config.update('verboseMode', undefined, vscode.ConfigurationTarget.Workspace);
+		log(`Migrated legacy settings to logLevel='${newLogLevel}' and removed debugMode/verboseMode from workspace settings`, 'settingsMigration', 'info');
+	}
+	// Also check user settings
+	const userConfig = vscode.workspace.getConfiguration(extensionId, null);
+	const userDebug = userConfig.get('debugMode');
+	const userVerbose = userConfig.get('verboseMode');
+	let userNeedsUpdate = false;
+	let userLogLevel: string | undefined = undefined;
+	if (userDebug === true) {
+		userLogLevel = 'debug';
+		userNeedsUpdate = true;
+	} else if (userVerbose === true) {
+		userLogLevel = 'verbose';
+		userNeedsUpdate = true;
+	}
+	if (userNeedsUpdate) {
+		await userConfig.update('logLevel', userLogLevel, vscode.ConfigurationTarget.Global);
+		await userConfig.update('debugMode', undefined, vscode.ConfigurationTarget.Global);
+		await userConfig.update('verboseMode', undefined, vscode.ConfigurationTarget.Global);
+		log(`Migrated legacy settings to logLevel='${userLogLevel}' and removed debugMode/verboseMode from user settings`, 'settingsMigration', 'info');
+	}
+}
 
 async function findExcelFile(mFilePath: string): Promise<string | undefined> {
 	const dir = path.dirname(mFilePath);
@@ -1735,6 +1757,8 @@ async function findExcelFile(mFilePath: string): Promise<string | undefined> {
 
 async function cleanupBackupsCommand(uri?: vscode.Uri): Promise<void> {
 	try {
+		// Migrate legacy settings on every activation
+		await migrateLegacySettings();
 		// Validate URI parameter - don't show file dialog for invalid input
 		if (uri && (!uri.fsPath || typeof uri.fsPath !== 'string')) {
 			const errorMsg = 'Invalid URI parameter provided to cleanupBackups command';

src/extension.ts

@@ -11,7 +11,6 @@ suite('Utils Tests', () => {
 	suiteSetup(() => {
 		// Initialize test configuration system
 		initTestConfig();
-		
 		// Ensure temp directory exists
 		if (!fs.existsSync(tempDir)) {
 			fs.mkdirSync(tempDir, { recursive: true });
@@ -21,7 +20,6 @@ suite('Utils Tests', () => {
 	suiteTeardown(() => {
 		// Clean up test configuration
 		cleanupTestConfig();
-		
 		// Clean up temp directory
 		if (fs.existsSync(tempDir)) {
 			fs.rmSync(tempDir, { recursive: true, force: true });
@@ -276,3 +274,46 @@ suite('Utils Tests', () => {
 		});
 	});
 });
+
+
+// --- Legacy Settings Migration Tests ---
+import { migrateLegacySettings } from '../src/extension';
+
+suite('Legacy Settings Migration', () => {
+setup(() => {
+	initTestConfig();
+});
+teardown(() => {
+	cleanupTestConfig();
+});
+
+	test('Migrates both debugMode and verboseMode set', async () => {
+		await testConfigUpdate('debugMode', true);
+		await testConfigUpdate('verboseMode', true);
+		await migrateLegacySettings();
+		const config = vscode.workspace.getConfiguration('excel-power-query-editor');
+		assert.strictEqual(config.get('logLevel'), 'debug', 'logLevel should be set to debug');
+		assert.strictEqual(config.get('debugMode'), undefined, 'debugMode should be removed');
+		assert.strictEqual(config.get('verboseMode'), undefined, 'verboseMode should be removed');
+	});
+
+	test('Migrates only debugMode set', async () => {
+		await testConfigUpdate('debugMode', true);
+		await testConfigUpdate('verboseMode', false);
+		await migrateLegacySettings();
+		const config = vscode.workspace.getConfiguration('excel-power-query-editor');
+		assert.strictEqual(config.get('logLevel'), 'debug', 'logLevel should be set to debug');
+		assert.strictEqual(config.get('debugMode'), undefined, 'debugMode should be removed');
+		assert.strictEqual(config.get('verboseMode'), undefined, 'verboseMode should be removed');
+	});
+
+	test('Migrates only verboseMode set', async () => {
+		await testConfigUpdate('debugMode', false);
+		await testConfigUpdate('verboseMode', true);
+		await migrateLegacySettings();
+		const config = vscode.workspace.getConfiguration('excel-power-query-editor');
+		assert.strictEqual(config.get('logLevel'), 'verbose', 'logLevel should be set to verbose');
+		assert.strictEqual(config.get('debugMode'), undefined, 'debugMode should be removed');
+		assert.strictEqual(config.get('verboseMode'), undefined, 'verboseMode should be removed');
+	});
+});