[FEAT] Remove Start Menu Recommendations / Fix GetToggle Logic (#3089)

* add WPFToggleRemoveRecommended - add WPFToggleStartMenuRecommendations - add reg entrys to modify for toggle - add non working link bc devdocs are broken in general * add iseducationenvironment notice * improve handling if entry does not exist - add DefaultState property - add handler for DefaultState in Get-WinUtilToggleStatus * remove helper console logs * fix search defaultstate * added missing default states
ChrisTitusTech · Jan 10, 2025 · 201f24c · 201f24c
1 parent 9183e92
commit 201f24c
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 6 deletions.
diff --git a/config/tweaks.json b/config/tweaks.json
@@ -3301,13 +3301,15 @@
         "Name": "AppsUseLightTheme",
         "Value": "0",
         "OriginalValue": "1",
+        "DefaultState": "false",
         "Type": "DWord"
       },
       {
         "Path": "HKCU:\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Themes\\Personalize",
         "Name": "SystemUsesLightTheme",
         "Value": "0",
         "OriginalValue": "1",
+        "DefaultState": "false",
         "Type": "DWord"
       }
     ],
@@ -3342,6 +3344,7 @@
         "Name": "BingSearchEnabled",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "true",
         "Type": "DWord"
       }
     ],
@@ -3360,13 +3363,15 @@
         "Name": "InitialKeyboardIndicators",
         "Value": "2",
         "OriginalValue": "0",
+        "DefaultState": "false",
         "Type": "DWord"
       },
       {
         "Path": "HKCU:\\Control Panel\\Keyboard",
         "Name": "InitialKeyboardIndicators",
         "Value": "2",
         "OriginalValue": "0",
+        "DefaultState": "false",
         "Type": "DWord"
       }
     ],
@@ -3385,24 +3390,61 @@
         "Name": "VerboseStatus",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "false",
         "Type": "DWord"
       }
     ],
     "link": "https://christitustech.github.io/winutil/dev/tweaks/Customize-Preferences/VerboseLogon"
   },
+  "WPFToggleStartMenuRecommendations": {
+    "Content": "Recommendations in Start Menu",
+    "Description": "If disabled then you will not see recommendations in the Start Menu. | Enables 'iseducationenvironment' | Relogin Required.",
+    "category": "Customize Preferences",
+    "panel": "2",
+    "Order": "a104_",
+    "Type": "Toggle",
+    "registry": [
+      {
+        "Path": "HKLM:\\SOFTWARE\\Microsoft\\PolicyManager\\current\\device\\Start",
+        "Name": "HideRecommendedSection",
+        "Value": "0",
+        "OriginalValue": "1",
+        "DefaultState": "true",
+        "Type": "DWord"
+      },
+      {
+        "Path": "HKLM:\\SOFTWARE\\Microsoft\\PolicyManager\\current\\device\\Education",
+        "Name": "IsEducationEnvironment",
+        "Value": "0",
+        "OriginalValue": "1",
+        "DefaultState": "true",
+        "Type": "DWord"
+      },
+      {
+        "Path": "HKLM:\\SOFTWARE\\Policies\\Microsoft\\Windows\\Explorer",
+        "Name": "HideRecommendedSection",
+        "Value": "0",
+        "OriginalValue": "1",
+        "DefaultState": "true",
+        "Type": "DWord"
+      }
+    ],
+    "link": "https://christitustech.github.io/winutil/dev/tweaks/Customize-Preferences/WPFToggleStartMenuRecommendations"
+  },
   "WPFToggleSnapWindow": {
     "Content": "Snap Window",
     "Description": "If enabled you can align windows by dragging them. | Relogin Required",
     "category": "Customize Preferences",
     "panel": "2",
-    "Order": "a104_",
+    "Order": "a105_",
     "Type": "Toggle",
     "registry": [
       {
         "Path": "HKCU:\\Control Panel\\Desktop",
         "Name": "WindowArrangementActive",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "true",
         "Type": "String"
       }
     ],
@@ -3413,14 +3455,15 @@
     "Description": "If enabled then Snap preview is disabled when maximize button is hovered.",
     "category": "Customize Preferences",
     "panel": "2",
-    "Order": "a105_",
+    "Order": "a106_",
     "Type": "Toggle",
     "registry": [
       {
         "Path": "HKCU:\\Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\Advanced",
         "Name": "EnableSnapAssistFlyout",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "true",
         "Type": "DWord"
       }
     ],
@@ -3441,14 +3484,15 @@
     "Description": "If enabled then you will get suggestions to snap other applications in the left over spaces.",
     "category": "Customize Preferences",
     "panel": "2",
-    "Order": "a106_",
+    "Order": "a107_",
     "Type": "Toggle",
     "registry": [
       {
         "Path": "HKCU:\\Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\Advanced",
         "Name": "SnapAssist",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "true",
         "Type": "DWord"
       }
     ],
@@ -3469,28 +3513,31 @@
     "Description": "If Enabled then Cursor movement is affected by the speed of your physical mouse movements.",
     "category": "Customize Preferences",
     "panel": "2",
-    "Order": "a107_",
+    "Order": "a108_",
     "Type": "Toggle",
     "registry": [
       {
         "Path": "HKCU:\\Control Panel\\Mouse",
         "Name": "MouseSpeed",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "true",
         "Type": "DWord"
       },
       {
         "Path": "HKCU:\\Control Panel\\Mouse",
         "Name": "MouseThreshold1",
         "Value": "6",
         "OriginalValue": "0",
+        "DefaultState": "true",
         "Type": "DWord"
       },
       {
         "Path": "HKCU:\\Control Panel\\Mouse",
         "Name": "MouseThreshold2",
         "Value": "10",
         "OriginalValue": "0",
+        "DefaultState": "true",
         "Type": "DWord"
       }
     ],
@@ -3501,14 +3548,15 @@
     "Description": "If Enabled then Sticky Keys is activated - Sticky keys is an accessibility feature of some graphical user interfaces which assists users who have physical disabilities or help users reduce repetitive strain injury.",
     "category": "Customize Preferences",
     "panel": "2",
-    "Order": "a108_",
+    "Order": "a109_",
     "Type": "Toggle",
     "registry": [
       {
         "Path": "HKCU:\\Control Panel\\Accessibility\\StickyKeys",
         "Name": "Flags",
         "Value": "510",
         "OriginalValue": "58",
+        "DefaultState": "true",
         "Type": "DWord"
       }
     ],
@@ -3527,6 +3575,7 @@
         "Name": "Hidden",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "false",
         "Type": "DWord"
       }
     ],
@@ -3555,6 +3604,7 @@
         "Name": "HideFileExt",
         "Value": "0",
         "OriginalValue": "1",
+        "DefaultState": "false",
         "Type": "DWord"
       }
     ],
@@ -3583,6 +3633,7 @@
         "Name": "SearchboxTaskbarMode",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "true",
         "Type": "DWord"
       }
     ],
@@ -3601,6 +3652,7 @@
         "Name": "ShowTaskViewButton",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "true",
         "Type": "DWord"
       }
     ],
@@ -3619,6 +3671,7 @@
         "Name": "TaskbarDa",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "true",
         "Type": "DWord"
       }
     ],
@@ -3637,6 +3690,7 @@
         "Name": "TaskbarAl",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "true",
         "Type": "DWord"
       }
     ],
@@ -3655,13 +3709,15 @@
         "Name": "DisplayParameters",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "false",
         "Type": "DWord"
       },
       {
         "Path": "HKLM:\\SYSTEM\\CurrentControlSet\\Control\\CrashControl",
         "Name": "DisableEmoticon",
         "Value": "1",
         "OriginalValue": "0",
+        "DefaultState": "false",
         "Type": "DWord"
       }
     ],

diff --git a/functions/private/Get-WinUtilToggleStatus.ps1 b/functions/private/Get-WinUtilToggleStatus.ps1
@@ -35,15 +35,33 @@ Function Get-WinUtilToggleStatus {
 
         foreach ($regentry in $ToggleSwitchReg) {
             try {
+                if (!(Test-Path $regentry.Path)) {
+                    New-Item -Path $regentry.Path -Force | Out-Null
+                }
                 $regstate = (Get-ItemProperty -path $regentry.Path).$($regentry.Name)
                 if ($regstate -eq $regentry.Value) {
                     $count += 1
                     Write-Debug "$($regentry.Name) is true (state: $regstate, value: $($regentry.Value), original: $($regentry.OriginalValue))"
                 } else {
                     Write-Debug "$($regentry.Name) is false (state: $regstate, value: $($regentry.Value), original: $($regentry.OriginalValue))"
                 }
+                if (!$regstate) {
+                    switch ($regentry.DefaultState) {
+                        "true" {
+                            $regstate = $regentry.Value
+                            $count += 1
+                        }
+                        "false" {
+                            $regstate = $regentry.OriginalValue
+                        }
+                        default {
+                            Write-Error "Entry for $($regentry.Name) does not exist and no DefaultState is defined."
+                            $regstate = $regentry.OriginalValue
+                        }
+                    }
+                }
             } catch {
-                Write-Error "An error occurred while accessing registry entry $($regentry.Path): $_"
+                Write-Error "An unexpected error occurred: $_"
             }
         }