From 5ebd9eb577efa6f355d85899ef49c67a09fd5557 Mon Sep 17 00:00:00 2001
From: stefansjfw <57057282+stefansjfw@users.noreply.github.com>
Date: Thu, 28 May 2020 16:23:03 +0200
Subject: [PATCH] [ShortcutGuide&Installer] Move Shortcut Guide to separate
 build and install folder (#3810)

* Move Shortcut Guide to separate build and install folder

* Rename shortcut_guide to ShortcutGuide

* Propagate change to the pipeline
---
 .pipelines/pipeline.user.windows.yml              |  2 +-
 installer/PowerToysSetup/Product.wxs              | 15 ++++++++++-----
 src/modules/shortcut_guide/shortcut_guide.vcxproj |  5 +++--
 src/runner/main.cpp                               |  6 ++++--
 4 files changed, 18 insertions(+), 10 deletions(-)

diff --git a/.pipelines/pipeline.user.windows.yml b/.pipelines/pipeline.user.windows.yml
index 8c23f3e9f8..632c56c998 100644
--- a/.pipelines/pipeline.user.windows.yml
+++ b/.pipelines/pipeline.user.windows.yml
@@ -103,7 +103,7 @@ build:
             - 'modules\launcher\Wox.Plugin.dll'
             - 'modules\Microsoft.Launcher.dll'
             - 'modules\PowerRenameExt.dll'
-            - 'modules\shortcut_guide.dll'
+            - 'modules\ShortcutGuide\ShortcutGuide.dll'
             - 'Notifications.dll'
             - 'os-detection.dll'
             - 'PowerToys.exe'
diff --git a/installer/PowerToysSetup/Product.wxs b/installer/PowerToysSetup/Product.wxs
index 6c2e17d771..b19ad0ce0f 100644
--- a/installer/PowerToysSetup/Product.wxs
+++ b/installer/PowerToysSetup/Product.wxs
@@ -3,6 +3,8 @@
      xmlns:util="http://schemas.microsoft.com/wix/UtilExtension"
      xmlns:netfx="http://schemas.microsoft.com/wix/NetFxExtension" >
 
+  <?define ShortcutGuideProjectName="ShortcutGuide"?>
+
   <?define RepoDir="$(var.ProjectDir)..\..\" ?>
   <?define BinX64Dir="$(var.RepoDir)x64\$(var.Configuration)\" ?>
   <Product Id="*"
@@ -215,6 +217,7 @@
         <Directory Id="INSTALLFOLDER" Name="PowerToys">
           <Directory Id="SvgsInstallFolder" Name="svgs"/>
           <Directory Id="ModulesInstallFolder" Name="modules">
+            <Directory Id="ShortcutGuideInstallFolder" Name="$(var.ShortcutGuideProjectName)"/>
             <!-- Resource file directories -->
             <?foreach Language in ar;bg;ca;cs;de;es;eu-ES;fr;he;hu;it;nb-NO;nl;pl;pt-BR;ru;sk;tr;zh-Hans?>
               <!--NB: Ids can't contain hyphens-->
@@ -402,10 +405,6 @@
     </DirectoryRef>
 
     <DirectoryRef Id="ModulesInstallFolder" FileSource="$(var.BinX64Dir)modules\">
-      <Component Id="Module_ShortcutGuide" Guid="CBD0AC09-91D3-428E-B2B3-05745ADF3473" Win64="yes">
-        <File Source="$(var.BinX64Dir)modules\shortcut_guide.dll" KeyPath="yes" />
-      </Component>
-
       <Component Id="Module_PowerRename" Guid="E4401D08-27FE-4F96-BA17-0C61FD79E684" Win64="yes">
         <File Source="$(var.BinX64Dir)modules\PowerRenameExt.dll" KeyPath="yes" />
         <RegistryKey Root="HKCR" Key="CLSID\{0440049F-D1DC-4E46-B27B-98393D79486B}">
@@ -571,7 +570,13 @@
         </RegistryKey>
       </Component>
     </DirectoryRef>
-    
+
+    <DirectoryRef Id="ShortcutGuideInstallFolder" FileSource="$(var.BinX64Dir)modules\$(var.ShortcutGuideProjectName)\">
+      <Component Id="Module_ShortcutGuide" Guid="CBD0AC09-91D3-428E-B2B3-05745ADF3473" Win64="yes">
+        <File Source="$(var.BinX64Dir)modules\$(var.ShortcutGuideProjectName)\$(var.ShortcutGuideProjectName).dll" KeyPath="yes" />
+      </Component>
+    </DirectoryRef>
+
     <DirectoryRef Id="FileExplorerPreviewInstallFolder" FileSource="$(var.RepoDir)\modules\FileExplorerPreview\">
       <Component Id="Module_PowerPreview" Guid="FF1700D5-1B07-4E07-9A62-4D206645EEA9" Win64="yes">
         <!-- Component to include PowerPreview Module Source dll's -->
diff --git a/src/modules/shortcut_guide/shortcut_guide.vcxproj b/src/modules/shortcut_guide/shortcut_guide.vcxproj
index 8198660e4f..dc2fc4d839 100644
--- a/src/modules/shortcut_guide/shortcut_guide.vcxproj
+++ b/src/modules/shortcut_guide/shortcut_guide.vcxproj
@@ -17,6 +17,7 @@
     <Keyword>Win32Proj</Keyword>
     <RootNamespace>overlaywindow</RootNamespace>
     <WindowsTargetPlatformVersion>10.0.17134.0</WindowsTargetPlatformVersion>
+    <ProjectName>ShortcutGuide</ProjectName>
   </PropertyGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
@@ -48,12 +49,12 @@
   <PropertyGroup Label="UserMacros" />
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
     <LinkIncremental>false</LinkIncremental>
-    <OutDir>$(SolutionDir)$(Platform)\$(Configuration)\modules\</OutDir>
+    <OutDir>$(SolutionDir)$(Platform)\$(Configuration)\modules\$(ProjectName)\</OutDir>
     <IntDir>$(SolutionDir)$(Platform)\$(Configuration)\obj\$(ProjectName)\</IntDir>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
     <LinkIncremental>true</LinkIncremental>
-    <OutDir>$(SolutionDir)$(Platform)\$(Configuration)\modules\</OutDir>
+    <OutDir>$(SolutionDir)$(Platform)\$(Configuration)\modules\$(ProjectName)\</OutDir>
     <IntDir>$(SolutionDir)$(Platform)\$(Configuration)\obj\$(ProjectName)\</IntDir>
   </PropertyGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
diff --git a/src/runner/main.cpp b/src/runner/main.cpp
index cb8e46f38b..d6e3113e51 100644
--- a/src/runner/main.cpp
+++ b/src/runner/main.cpp
@@ -126,7 +126,7 @@ int runner(bool isProcessElevated)
         std::wstring baseModuleFolder = L"modules/";
 
         std::unordered_set<std::wstring> known_dlls = {
-            L"shortcut_guide.dll",
+            L"ShortcutGuide.dll",
             L"fancyzones.dll",
             L"PowerRenameExt.dll",
             L"Microsoft.Launcher.dll",
@@ -135,10 +135,12 @@ int runner(bool isProcessElevated)
             L"KeyboardManager.dll"
         };
 
+        // TODO(stefan): When all modules get their OutputDir delete this and simplify "search for .dll logic"
         std::unordered_set<std::wstring> module_folders = {
             L"",
             L"FileExplorerPreview/",
-            L"FancyZones/"
+            L"FancyZones/",
+            L"ShortcutGuide/"
         };
 
         for (std::wstring subfolderName : module_folders)