Migrate to Velopack & Github Action

.github/actions/spelling/allow.txt

@@ -3,3 +3,21 @@ https
 ssh
 ubuntu
 runcount
+nunit
+velopack
+vpk
+vsc
+appveyor
+appwrite
+IME
+hotkey
+prioritise
+runas
+softpedia
+sourcelink
+TRAYMOUSEMESSAGE
+uninstaller
+vkcode
+winget
+workaround
+nupkg

.github/actions/spelling/excludes.txt

@@ -71,3 +71,4 @@ ignore$
 \.csproj$
 \.DotSettings$
 \.targets$
+.*Test.cs$

.github/actions/spelling/expect.txt

@@ -34,7 +34,7 @@
 pythonw
 dotnet
 winget
 jjw24
 wolframalpha
 gmail
 duckduckgo
@@ -49,7 +49,7 @@
 EWX
 dlgtext
 CMD
 appref-ms
 appref
 TSource
 runas
@@ -68,9 +68,9 @@
 ddd
 dddd
 clearlogfolder
 ACCENT_ENABLE_TRANSPARENTGRADIENT
 ACCENT_ENABLE_BLURBEHIND
 WCA_ACCENT_POLICY
 HGlobal
 dopusrt
 firefox
@@ -90,13 +90,13 @@
 KListener
 requery
 vkcode
 čeština
 Polski
 Srpski
 Português
 Português (Brasil)
 Italiano
 Slovenský
 Droplex
 Preinstalled
 errormetadatafile
@@ -104,6 +104,14 @@
 pluginsmanager
 alreadyexists
 JsonRPC
 JsonRPCV2
 Softpedia
 img
+ime
+LPWStr
+flowlauncher
+hotkeys
+LPW
+productversion
+requery
+Wnd

.github/actions/spelling/patterns.txt

@@ -27,7 +27,14 @@
 # Automatically suggested patterns
 # hit-count: 360 file-count: 108
 # IServiceProvider
-\bI(?=(?:[A-Z][a-z]{2,})+\b)
+# IPublicAPI
+\bI(?=(?:[A-Z][a-z]{2,}[A-Z]*)+\b)
+
+# KListener
+\bK(?=(?:[A-Z][a-z]{2,})+\b)
+
+# TApplication
+\bT(?=(?:[A-Z][a-z]{2,})+\b)
 
 # hit-count: 297 file-count: 18
 # uuid:

.github/workflows/dotnet.yml

@@ -0,0 +1,107 @@
+# This workflow will build a .NET project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net
+
+name: .NET
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - dev
+      - master
+  pull_request:
+    branches:
+      - dev
+      - master
+
+jobs:
+  build:
+
+    runs-on: windows-latest
+    env:
+      FlowVersion: 1.17.2
+      NUGET_CERT_REVOCATION_MODE: offline
+      BUILD_NUMBER: ${{ github.run_number }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set Flow.Launcher.csproj version
+        id: update
+        uses: vers-one/dotnet-project-version-updater@v1.5
+        with:
+          file: |
+            "**/SolutionAssemblyInfo.cs"
+          version: ${{ env.FlowVersion }}.${{ env.BUILD_NUMBER }}
+      - uses: actions/cache@v4
+        name: Restore Nuget Cache
+        with:
+          path: |
+            ~/.nuget/packages
+          key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj') }}
+          restore-keys: |
+            ${{ runner.os }}-nuget
+      - uses: actions/cache@v4
+        name: Restore dotnet tool Cache
+        with:
+          path: |
+            ~/.dotnet/tools
+          key: ${{ runner.os }}-dotnet-tools-${{ hashFiles('~/.dotnet/tools/**') }}
+          restore-keys: |
+            ${{ runner.os }}-dotnet-tools
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 7.0.x
+#      - name: Install vpk
+        # Install vpk tool (dotnet tool install will not reinstall if already installed)
+        # We will update the cli by removing cache
+#        run: dotnet tool install -g vpk
+      - name: Restore dependencies
+        run: dotnet restore
+      - name: Build
+        run: dotnet build --no-restore -c Release
+      - name: Initialize Service
+        run: |
+          sc config WSearch start= auto # Starts Windows Search service- Needed for running ExplorerTest
+          net start WSearch
+      - name: Test
+        run: dotnet test --no-build --verbosity normal -c Release
+      - name: Perform post_build tasks
+        shell: pwsh
+        run: .\Scripts\post_build.ps1 -flowversion "${env:FlowVersion}-build.${env:BUILD_NUMBER}"
+      - name: Upload Plugin Nupkg
+        uses: actions/upload-artifact@v4
+        with:
+          name: Plugin nupkg
+          path: |
+            Output\Release\Flow.Launcher.Plugin.*.nupkg
+          compression-level: 0
+      - name: Upload Setup
+        uses: actions/upload-artifact@v4
+        with:
+          name: Flow Installer
+          path: |
+            Releases\FlowLauncher-*.exe
+          compression-level: 0
+      - name: Upload Portable Version
+        uses: actions/upload-artifact@v4
+        with:
+          name: Portable Version
+          path: |
+            Releases\FlowLauncher-*-Portable.zip
+          compression-level: 0
+#      - name: Upload Full Nupkg
+#        uses: actions/upload-artifact@v4
+#        with:
+#          name: Full nupkg
+#          path: |
+#            Releases\FlowLauncher-*-full.nupkg
+#          
+#          compression-level: 0
+#      - name: Upload Release Information
+#        uses: actions/upload-artifact@v4
+#        with:
+#          name: RELEASES
+#          path: |
+#            Releases\RELEASES*
+#          compression-level: 0
+#      

Flow.Launcher.Core/Configuration/IPortable.cs

@@ -5,12 +5,6 @@ public interface IPortable
     {
         void EnablePortableMode();
         void DisablePortableMode();
-        void RemoveShortcuts();
-        void RemoveUninstallerEntry();
-        void CreateShortcuts();
-        void CreateUninstallerEntry();
-        void MoveUserDataFolder(string fromLocation, string toLocation);
-        void VerifyUserDataAfterMove(string fromLocation, string toLocation);
         bool CanUpdatePortability();
     }
-}
+}

Flow.Launcher.Core/Configuration/Portable.cs

@@ -1,5 +1,4 @@
 using Microsoft.Win32;
-using Squirrel;
 using System;
 using System.IO;
 using System.Reflection;
@@ -9,41 +8,26 @@
 using Flow.Launcher.Infrastructure.UserSettings;
 using Flow.Launcher.Plugin.SharedCommands;
 using System.Linq;
+using Flow.Launcher.Core.Plugin;
+using Velopack;
+using Velopack.Locators;
+using Velopack.Windows;
 
 namespace Flow.Launcher.Core.Configuration
 {
     public class Portable : IPortable
     {
-        /// <summary>
-        /// As at Squirrel.Windows version 1.5.2, UpdateManager needs to be disposed after finish
-        /// </summary>
-        /// <returns></returns>
-        private UpdateManager NewUpdateManager()
-        {
-            var applicationFolderName = Constant.ApplicationDirectory
-                                            .Split(new[] { Path.DirectorySeparatorChar }, StringSplitOptions.None)
-                                            .Last();
-
-            return new UpdateManager(string.Empty, applicationFolderName, Constant.RootDirectory);
-        }
-
         public void DisablePortableMode()
         {
             try
             {
                 MoveUserDataFolder(DataLocation.PortableDataPath, DataLocation.RoamingDataPath);
-#if !DEBUG
-                // Create shortcuts and uninstaller are not required in debug mode, 
-                // otherwise will repoint the path of the actual installed production version to the debug version
-                CreateShortcuts();
-                CreateUninstallerEntry();
-#endif
                 IndicateDeletion(DataLocation.PortableDataPath);
 
                 MessageBox.Show("Flow Launcher needs to restart to finish disabling portable mode, " +
-                    "after the restart your portable data profile will be deleted and roaming data profile kept");
+                                "after the restart your portable data profile will be deleted and roaming data profile kept");
 
-                UpdateManager.RestartApp(Constant.ApplicationFileName);
+                PluginManager.API.RestartApp();
             }
             catch (Exception e)
             {
@@ -56,42 +40,19 @@ public void EnablePortableMode()
             try
             {
                 MoveUserDataFolder(DataLocation.RoamingDataPath, DataLocation.PortableDataPath);
-#if !DEBUG
-                // Remove shortcuts and uninstaller are not required in debug mode, 
-                // otherwise will delete the actual installed production version
-                RemoveShortcuts();
-                RemoveUninstallerEntry();
-#endif
                 IndicateDeletion(DataLocation.RoamingDataPath);
 
                 MessageBox.Show("Flow Launcher needs to restart to finish enabling portable mode, " +
-                    "after the restart your roaming data profile will be deleted and portable data profile kept");
+                                "after the restart your roaming data profile will be deleted and portable data profile kept");
 
-                UpdateManager.RestartApp(Constant.ApplicationFileName);
+                PluginManager.API.RestartApp();
             }
             catch (Exception e)
             {
                 Log.Exception("|Portable.EnablePortableMode|Error occurred while enabling portable mode", e);
             }
         }
 
-        public void RemoveShortcuts()
-        {
-            using (var portabilityUpdater = NewUpdateManager())
-            {
-                portabilityUpdater.RemoveShortcutsForExecutable(Constant.ApplicationFileName, ShortcutLocation.StartMenu);
-                portabilityUpdater.RemoveShortcutsForExecutable(Constant.ApplicationFileName, ShortcutLocation.Desktop);
-                portabilityUpdater.RemoveShortcutsForExecutable(Constant.ApplicationFileName, ShortcutLocation.Startup);
-            }
-        }
-
-        public void RemoveUninstallerEntry()
-        {
-            using (var portabilityUpdater = NewUpdateManager())
-            {
-                portabilityUpdater.RemoveUninstallerRegistryEntry();
-            }
-        }
 
         public void MoveUserDataFolder(string fromLocation, string toLocation)
         {
@@ -104,36 +65,10 @@ public void VerifyUserDataAfterMove(string fromLocation, string toLocation)
             FilesFolders.VerifyBothFolderFilesEqual(fromLocation, toLocation);
         }
 
-        public void CreateShortcuts()
-        {
-            using (var portabilityUpdater = NewUpdateManager())
-            {
-                portabilityUpdater.CreateShortcutsForExecutable(Constant.ApplicationFileName, ShortcutLocation.StartMenu, false);
-                portabilityUpdater.CreateShortcutsForExecutable(Constant.ApplicationFileName, ShortcutLocation.Desktop, false);
-                portabilityUpdater.CreateShortcutsForExecutable(Constant.ApplicationFileName, ShortcutLocation.Startup, false);
-            }
-        }
-
-        public void CreateUninstallerEntry()
-        {
-            var uninstallRegSubKey = @"Software\Microsoft\Windows\CurrentVersion\Uninstall";
-
-            using (var baseKey = RegistryKey.OpenBaseKey(RegistryHive.CurrentUser, RegistryView.Default))
-            using (var subKey1 = baseKey.CreateSubKey(uninstallRegSubKey, RegistryKeyPermissionCheck.ReadWriteSubTree))
-            using (var subKey2 = subKey1.CreateSubKey(Constant.FlowLauncher, RegistryKeyPermissionCheck.ReadWriteSubTree))
-            {
-                subKey2.SetValue("DisplayIcon", Path.Combine(Constant.ApplicationDirectory, "app.ico"), RegistryValueKind.String);
-            }
 
-            using (var portabilityUpdater = NewUpdateManager())
-            {
-                _ = portabilityUpdater.CreateUninstallerRegistryEntry();
-            }
-        }
-
-        internal void IndicateDeletion(string filePathTodelete)
+        internal void IndicateDeletion(string filePathToDelete)
         {
-            var deleteFilePath = Path.Combine(filePathTodelete, DataLocation.DeletionIndicatorFile);
+            var deleteFilePath = Path.Combine(filePathToDelete, DataLocation.DeletionIndicatorFile);
             using (var _ = File.CreateText(deleteFilePath))
             {
             }
@@ -145,23 +80,35 @@ internal void IndicateDeletion(string filePathTodelete)
         ///</summary>
         public void PreStartCleanUpAfterPortabilityUpdate()
         {
+            // check whether the package locate in %LocalAppData%
+            // if not create the portable data folder
+            // Don't create the folder if the version is 1.0.0 (Dev) to allow potential debugging with data in the project folder
+            // It is still possible to create the UserData folder for dev version manually but we want to keep the current behavior
+            if (!Constant.ProgramDirectory.IsSubPathOf(
+                    Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData))
+                && Constant.Version != "1.0.0")
+            {
+                Directory.CreateDirectory(DataLocation.PortableDataPath);
+            }
+
             // Specify here so this method does not rely on other environment variables to initialise
-            var portableDataDir = Path.Combine(Directory.GetParent(Assembly.GetExecutingAssembly().Location.NonNull()).ToString(), "UserData");
-            var roamingDataDir = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "FlowLauncher");
+            var portableDataDir = DataLocation.PortableDataPath;
+            var roamingDataDir = DataLocation.RoamingDataPath;
+
 
             // Get full path to the .dead files for each case
             var portableDataDeleteFilePath = Path.Combine(portableDataDir, DataLocation.DeletionIndicatorFile);
             var roamingDataDeleteFilePath = Path.Combine(roamingDataDir, DataLocation.DeletionIndicatorFile);
 
-            // If the data folder in %appdata% is marked for deletion,
+            // If the data folder in %AppData% is marked for deletion,
             // delete it and prompt the user to pick the portable data location
             if (File.Exists(roamingDataDeleteFilePath))
             {
                 FilesFolders.RemoveFolderIfExists(roamingDataDir);
 
                 if (MessageBox.Show("Flow Launcher has detected you enabled portable mode, " +
                                     "would you like to move it to a different location?", string.Empty,
-                                    MessageBoxButton.YesNo) == MessageBoxResult.Yes)
+                        MessageBoxButton.YesNo) == MessageBoxResult.Yes)
                 {
                     FilesFolders.OpenPath(Constant.RootDirectory);
 
@@ -175,7 +122,7 @@ public void PreStartCleanUpAfterPortabilityUpdate()
                 FilesFolders.RemoveFolderIfExists(portableDataDir);
 
                 MessageBox.Show("Flow Launcher has detected you disabled portable mode, " +
-                                    "the relevant shortcuts and uninstaller entry have been created");
+                                "the relevant shortcuts and uninstaller entry have been created");
             }
         }
 
@@ -187,8 +134,8 @@ public bool CanUpdatePortability()
             if (roamingLocationExists && portableLocationExists)
             {
                 MessageBox.Show(string.Format("Flow Launcher detected your user data exists both in {0} and " +
-                                    "{1}. {2}{2}Please delete {1} in order to proceed. No changes have occurred.", 
-                                    DataLocation.PortableDataPath, DataLocation.RoamingDataPath, Environment.NewLine));
+                                              "{1}. {2}{2}Please delete {1} in order to proceed. No changes have occurred.",
+                    DataLocation.PortableDataPath, DataLocation.RoamingDataPath, Environment.NewLine));
 
                 return false;
             }

Flow.Launcher.Core/Flow.Launcher.Core.csproj

@@ -57,8 +57,8 @@
     <PackageReference Include="FSharp.Core" Version="7.0.401" />
     <PackageReference Include="Meziantou.Framework.Win32.Jobs" Version="3.2.1" />
     <PackageReference Include="Microsoft.IO.RecyclableMemoryStream" Version="3.0.0" />
-    <PackageReference Include="squirrel.windows" Version="1.5.2" NoWarn="NU1701" />
     <PackageReference Include="StreamJsonRpc" Version="2.17.11" />
+    <PackageReference Include="Velopack" Version="0.0.359" />
   </ItemGroup>
 
   <ItemGroup>

Flow.Launcher.Core/Properties/AssemblyInfo.cs

@@ -1,3 +1,4 @@
-using System.Runtime.CompilerServices;
+using System.Reflection;
+using System.Runtime.CompilerServices;
 
 [assembly: InternalsVisibleTo("Flow.Launcher.Test")]