Add uninstall hook to alert on incomplete uninstalls

Update vsce file ignore list

Author: illixion

.vscodeignore

@@ -1 +1,4 @@
-firstload.lock
+firstload.lock
+build
+images/*
+!images/logo.png

changelog.md

@@ -1,3 +1,8 @@
+# 1.1.46
+
+* Reduced package size by excluding unnecessary files
+* Added an alert when uninstalling without performing the "Disable Vibrancy" action
+
 # 1.1.45
 
 * Windows on ARM is now supported (resolves [#9](https://github.com/illixion/vscode-vibrancy-continued/issues/9))
@@ -205,7 +210,7 @@
 
 # 1.1.1
 
-Add Noir et blanc theme (by [pryter](https://github.com/pryter))
+* Add Noir et blanc theme (by [pryter](https://github.com/pryter))
 
 # 1.1.0
 
@@ -221,6 +226,7 @@ Add Noir et blanc theme (by [pryter](https://github.com/pryter))
 # 1.0.14
 
 * fix: not work with Customize UI
+
 # 1.0.13
 
 * fix: not working in vscode 1.53.0-insider

extension/index.js

@@ -3,6 +3,7 @@ var fs = require('mz/fs');
 var fsExtra = require('fs-extra');
 var path = require('path');
 var { pathToFileURL } = require('url')
+var os = require('os');
 
 /**
  * @type {(info: string) => string}
@@ -12,7 +13,7 @@ const localize = require('./i18n');
 /**
  * @type {'unknown' | 'win10' | 'macos'}
  */
-const os = require('./platform');
+const osType = require('./platform');
 
 var themeStylePaths = {
   'Default Dark': '../themes/Default Dark.css',
@@ -317,7 +318,7 @@ function activate(context) {
     const imports = await generateImports(config);
 
     const injectData = {
-      os: os,
+      os: osType,
       config: config,
       theme: themeConfig,
       themeCSS: themeCSS,
@@ -568,11 +569,37 @@ function activate(context) {
     }
   }
 
+  async function getActiveFlagPath() {
+    const envPaths = (await import('env-paths')).default;
+
+    const paths = envPaths('vscode-vibrancy');
+    const activeFlagPath = path.join(paths.config, 'active');
+
+    // Ensure the directory exists recursively
+    await fs.mkdir(paths.config, { recursive: true }).catch(() =>
+      console.warn(`Failed to create directory: ${paths.config}`)
+    );
+
+    return activeFlagPath;
+  }
+
+  // This function will create or remove the active flag file
+  async function setActiveFlag(state) {
+    const activeFlagPath = await getActiveFlagPath();
+
+    if (state) {
+      await fs.writeFile(activeFlagPath, '');
+    } else {
+      await fs.unlink(activeFlagPath).catch(() => { });
+    }
+  }
+
+
   // ####  main commands ######################################################
 
   async function Install() {
 
-    if (os === 'unknown') {
+    if (osType === 'unknown') {
       vscode.window.showInformationMessage(localize('messages.unsupported'));
       throw new Error('unsupported');
     }
@@ -587,14 +614,15 @@ function activate(context) {
       await fs.stat(JSFile);
       await fs.stat(HTMLFile);
 
-      if (os === 'win10') {
+      if (osType === 'win10') {
         await installRuntimeWin();
       } else {
         await installRuntime();
       }
       await installJS();
       await installHTML();
       await changeTerminalSettings();
+      await setActiveFlag(true);
     } catch (error) {
       if (error && (error.code === 'EPERM' || error.code === 'EACCES')) {
         vscode.window.showInformationMessage(localize('messages.admin') + error);
@@ -614,6 +642,7 @@ function activate(context) {
       // uninstall old version
       await fs.stat(HTMLFile);
       await uninstallHTML();
+      await setActiveFlag(false);
     } finally {
 
     }

extension/uninstallHook.js

@@ -0,0 +1,49 @@
+// This script will alert the user on uninstalling Vibrancy without prior cleanup
+// TODO: investigate if we can perform all cleanup steps here including VSCode settings update
+
+const { exec } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+(async () => {
+    const envPaths = (await import('env-paths')).default;
+    const paths = envPaths('vscode-vibrancy');
+    const activeFlagPath = path.join(paths.config, 'active');
+    
+    function isActive() {
+        return fs.existsSync(activeFlagPath);
+    }
+    
+    function showWarning(message) {
+        // Escape quotes for macOS/Linux
+        const escapedMessageUnix = message.replace(/"/g, '\\"');
+    
+        if (process.platform === 'win32') {
+            // Use VBScript to generate the alert
+            // PowerShell wasn't used as VSCode terminates the nodejs process, which then closes the alert
+            const vbsPath = path.join(__dirname, 'uninstallHookAlert.vbs');
+    
+            exec(`cscript //nologo "${vbsPath}"`, (err, stdout, stderr) => {
+                if (err) {
+                    console.error('Error executing VBScript:', err);
+                    return;
+                }
+                if (stderr) {
+                    console.error('VBScript error:', stderr);
+                    return;
+                }
+                console.log('VBScript executed successfully:', stdout);
+            });        
+        } else if (process.platform === 'darwin') {
+            // Use AppleScript to show a message box
+            exec(`osascript -e 'display alert "Warning" message "${escapedMessageUnix}" as critical'`);
+        } else {
+            // Use Zenity to show a message box, assumes Linux
+            exec(`zenity --warning --title="Warning" --text="${escapedMessageUnix}"`);
+        }
+    }
+    
+    if (isActive()) {
+        showWarning("Uninstalling Vibrancy Continued without disabling it first will NOT remove the effect! Please reinstall the extension and disable it using the command palette action \"Disable Vibrancy\" first.\n\nCheck Vibrancy Continued description for more information.");
+    }
+})();  

extension/uninstallHookAlert.vbs

@@ -0,0 +1,3 @@
+Dim message
+message = "Uninstalling Vibrancy Continued without disabling it first will NOT remove the effect! Please reinstall the extension and disable it using the command palette action ""Disable Vibrancy"" first." & vbCrLf & vbCrLf & "Check Vibrancy Continued description for more information."
+MsgBox message, 48, "Warning"

package-lock.json

@@ -196,9 +196,11 @@
     }
   },
   "scripts": {
-    "build-win10": "node-gyp rebuild"
+    "build-win10": "node-gyp rebuild",
+    "vscode:uninstall": "node ./extension/uninstallHook.js"
   },
   "dependencies": {
+    "env-paths": "^3.0.0",
     "fs-extra": "^10.1.0",
     "mz": "^2.7.0"
   },