Linting and Formatting (#3)

* Formatted Markdown * Formatted PowerShell * Removed PowerShell aliases
2025-11-17 02:56:17 +00:00 · 2023-05-15 16:38:11 -06:00
parent 80fdfbf0ee
commit 671565425c
2 changed files with 94 additions and 124 deletions
--- a/README.md
+++ b/README.md
@@ -1,9 +1,11 @@
 # Win10Debloat
+
 Win10Debloat is a simple and lightweight powershell script that removes pre-installed windows 10/11 bloatware apps, disables telemetry and declutters the experience by disabling or removing intrusive interface elements, ads and context menu items. No need to painstakingly go through all the settings yourself, or removing apps one by one. Win10Debloat makes the process quick and simple!

 You can pick and choose exactly which modifications you want the script to make, but the default settings should be fine for most people. All of the changes can be easily reverted using the registry files that are included in the 'Regfiles' folder, and all of the apps that are removed by default can be reinstalled from the microsoft store.

-### The windows 10 default settings will:
+## The windows 10 default settings will
+
 - Remove all bloatware apps from [this list](#these-apps-will-be-deleted-by-default).
 - Disable telemetry, diagnostic data & targeted ads.
 - Disable bing & cortana in windows search.
@@ -15,7 +17,8 @@ You can pick and choose exactly which modifications you want the script to make,
 - Disable the 'Give access to' from context menu.
 - Disable the 'Share' from context menu. (Does not remove the onedrive share option)

-### The windows 11 default settings will:
+## The windows 11 default settings will
+
 - Remove all bloatware apps from [this list](#these-apps-will-be-deleted-by-default).
 - Disable telemetry, diagnostic data & targeted ads.
 - Disable bing & cortana in windows search.
@@ -23,31 +26,36 @@ You can pick and choose exactly which modifications you want the script to make,
 - Disable tips, tricks and suggestions in the startmenu and settings, and sync provider ads in windows explorer.
 - Hide the Chat & Widget icons from the taskbar.

-### Or select the 'Custom' option in the menu to customize the script to your needs.
+## Or select the 'Custom' option in the menu to customize the script to your needs

 ## Donate a cup of coffee to support my work
+
 [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/M4M5C6UPC)

 ## Usage
+
 Disclaimer: I believe this script to be completely safe to run, but use this script at your own risk!

-### Easy method:
+### Easy method
+
 1. [Download the latest version of the script](https://github.com/Raphire/Win10Debloat/archive/master.zip), and extract the .ZIP file to your desired location.
 2. Navigate to the Win10Debloat folder
 3. Double click the 'Run.bat' file to start the script. Note: If the console window immediately closes and nothing happens, try the advanced method below.
 4. Accept the windows UAC prompt to run the script as administrator, this is required for the script to function.
 5. A new powershell window will now open, showing the Win10Debloat menu. Select either the default or custom setup to continue.

-### Advanced method:
+### Advanced method
+
 This method gives you the option to run the script with certain parameters to tailor the behaviour of the script to your needs without requiring any user input during runtime, making it quicker and easier to deploy on a large number of systems.
+
 1. [Download the latest version of the script](https://github.com/Raphire/Win10Debloat/archive/master.zip), and extract the .ZIP file to your desired location.
 2. Open powershell as an administrator.
-3. Enable powershell execution by entering the following command: <code>Set-ExecutionPolicy Unrestricted -Force</code>
-4. In powershell, navigate to the directory where the files were extracted. Example: <code>cd c:\\Win10Debloat</code>
-5. Enter this into powershell to run the script: <code>.\Win10Debloat.ps1</code> 
+3. Enable powershell execution by entering the following command: `Set-ExecutionPolicy Unrestricted -Force`
+4. In powershell, navigate to the directory where the files were extracted. Example: `cd c:\\Win10Debloat`
+5. Enter this into powershell to run the script: `.\Win10Debloat.ps1`
 6. A menu will now open. Select either the default or custom setup to continue.

-To run the script without any user input, simply add parameters at the end, example: <code>.\Win10Debloat.ps1 -RemoveApps -DisableBing</code>
+To run the script without any user input, simply add parameters at the end, example: `.\Win10Debloat.ps1 -RemoveApps -DisableBing`

 | Parameter | Description |
 | --------- | ----------- |
@@ -68,9 +76,11 @@ To run the script without any user input, simply add parameters at the end, exam
 | -DisableShare                 |    Disable the 'Share' option in the context menu. |

 ## Debloat Windows 10/11
+
 By default, this script only removes apps that most people are unlikely to ever need or use. You can of course customize which apps are removed by this script by editing the apps list found in the 'Win10Debloat.ps1' file.

-### These apps will be deleted by default:
+### These apps will be deleted by default
+
 - AdobeSystemsIncorporated.AdobePhotoshopExpress
 - Clipchamp.Clipchamp
 - Dolby
@@ -120,7 +130,8 @@ By default, this script only removes apps that most people are unlikely to ever
 - king.com.CandyCrushSaga
 - king.com.CandyCrushSodaSaga

-### These apps will NOT be deleted by default:
+### These apps will NOT be deleted by default
+
 - Microsoft.GamingApp
 - Microsoft.MSPaint (Paint 3D)
 - Microsoft.People
@@ -140,7 +151,9 @@ By default, this script only removes apps that most people are unlikely to ever
 - Microsoft.YourPhone

 ## Declutter Windows 10/11
+
 This script can also make various changes to declutter windows 10/11, such as:
+
 - Disable telemetry, diagnostic data & targeted ads.
 - Disable bing & cortana in windows search.
 - Disable tips & tricks on the lockscreen. (This changes your lockscreen wallpaper to the windows default)
--- a/Win10Debloat.ps1
+++ b/Win10Debloat.ps1
@@ -3,28 +3,27 @@
 [CmdletBinding(SupportsShouldProcess)]
 param 
 (
-    [Parameter(ValueFromPipeline=$true)][switch]$RunDefaults,
-    [Parameter(ValueFromPipeline=$true)][switch]$RunWin11Defaults,
-    [Parameter(ValueFromPipeline=$true)][switch]$RemoveApps,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableTelemetry,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableBingSearches,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableBing,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableLockscreenTips,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableWindowsSuggestions,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableSuggestions,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableChat,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableWidgets,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableOnedrive,
-    [Parameter(ValueFromPipeline=$true)][switch]$Disable3dObjects,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableMusic,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableIncludeInLibrary,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableGiveAccessTo,
-    [Parameter(ValueFromPipeline=$true)][switch]$DisableShare
+    [Parameter(ValueFromPipeline = $true)][switch]$RunDefaults,
+    [Parameter(ValueFromPipeline = $true)][switch]$RunWin11Defaults,
+    [Parameter(ValueFromPipeline = $true)][switch]$RemoveApps,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableTelemetry,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableBingSearches,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableBing,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableLockscreenTips,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableWindowsSuggestions,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableSuggestions,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableChat,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableWidgets,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableOnedrive,
+    [Parameter(ValueFromPipeline = $true)][switch]$Disable3dObjects,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableMusic,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableIncludeInLibrary,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableGiveAccessTo,
+    [Parameter(ValueFromPipeline = $true)][switch]$DisableShare
 )

 # Removes all apps in the list
-function RemoveApps
-{
+function RemoveApps {
    Write-Output "> Removing pre-installed windows 10 apps..."

    $apps = @(
@@ -111,13 +110,12 @@ function RemoveApps

        Get-AppxPackage -Name $app -AllUsers | Remove-AppxPackage

-        Get-AppxProvisionedPackage -Online | Where-Object {$_.PackageName -like $app} | ForEach-Object { Remove-ProvisionedAppxPackage -Online -AllUsers -PackageName $_.PackageName }
+        Get-AppxProvisionedPackage -Online | Where-Object { $_.PackageName -like $app } | ForEach-Object { Remove-ProvisionedAppxPackage -Online -AllUsers -PackageName $_.PackageName }
    }
 }

 # Import & execute regfile
-function RegImport
-{
+function RegImport {
    param 
    (
        $Message,
@@ -129,20 +127,16 @@ function RegImport
 }

 # Change mode based on provided parameters or user input
-if((-NOT $PSBoundParameters.Count) -or $RunDefaults -or $RunWin11Defaults -or (($PSBoundParameters.Count -eq 1) -and ($PSBoundParameters.ContainsKey('WhatIf') -or $PSBoundParameters.ContainsKey('Confirm') -or $PSBoundParameters.ContainsKey('Verbose'))))
-{
-    if($RunDefaults)
-    {
+if ((-NOT $PSBoundParameters.Count) -or $RunDefaults -or $RunWin11Defaults -or (($PSBoundParameters.Count -eq 1) -and ($PSBoundParameters.ContainsKey('WhatIf') -or $PSBoundParameters.ContainsKey('Confirm') -or $PSBoundParameters.ContainsKey('Verbose')))) {
+    if ($RunDefaults) {
        $Mode = '1';
    }
-    elseif($RunWin11Defaults)
-    {
+    elseif ($RunWin11Defaults) {
        $Mode = '2';
    }
-    else
-    {
+    else {
        Do { 
-            Clear
+            Clear-Host
            Write-Output "-------------------------------------------------------------------------------------------"
            Write-Output " Win10Debloat Script - Setup"
            Write-Output "-------------------------------------------------------------------------------------------"
@@ -155,8 +149,8 @@ if((-NOT $PSBoundParameters.Count) -or $RunDefaults -or $RunWin11Defaults -or ((
            Write-Output ""
            $Mode = Read-Host "Please select an option (1/2/3/0)" 

-            if($Mode -eq '0') {
-                Clear
+            if ($Mode -eq '0') {
+                Clear-Host
                Write-Output "-------------------------------------------------------------------------------------------"
                Write-Output " Win10Debloat - Information"
                Write-Output "-------------------------------------------------------------------------------------------"
@@ -198,11 +192,9 @@ if((-NOT $PSBoundParameters.Count) -or $RunDefaults -or $RunWin11Defaults -or ((
    }

    # Add execution parameters based on the mode
-    switch($Mode)
-    {
-        '1' 
-        { 
-            Clear
+    switch ($Mode) {
+        '1' { 
+            Clear-Host
            Write-Output "-------------------------------------------------------------------------------------------"
            Write-Output " Win10Debloat Script - Windows 10 Default Configuration"
            Write-Output "-------------------------------------------------------------------------------------------"
@@ -219,9 +211,8 @@ if((-NOT $PSBoundParameters.Count) -or $RunDefaults -or $RunWin11Defaults -or ((
            $PSBoundParameters.Add('DisableShare', $DisableShare)  
        }

-        '2' 
-        { 
-            Clear
+        '2' { 
+            Clear-Host
            Write-Output "-------------------------------------------------------------------------------------------"
            Write-Output " Win10Debloat Script - Windows 11 Default Configuration"
            Write-Output "-------------------------------------------------------------------------------------------"
@@ -234,83 +225,66 @@ if((-NOT $PSBoundParameters.Count) -or $RunDefaults -or $RunWin11Defaults -or ((
            $PSBoundParameters.Add('DisableWidgets', $DisableWidgets) 
        }

-        '3' 
-        { 
-            Clear
+        '3' { 
+            Clear-Host
            Write-Output "-------------------------------------------------------------------------------------------"
            Write-Output " Win10Debloat Script - Custom Configuration"
            Write-Output "-------------------------------------------------------------------------------------------"

-            if($( Read-Host -Prompt "Remove the pre-installed windows 10 apps? (y/n)" ) -eq 'y')
-            {
+            if ($( Read-Host -Prompt "Remove the pre-installed windows 10 apps? (y/n)" ) -eq 'y') {
                $PSBoundParameters.Add('RemoveApps', $RemoveApps)   
            }

-            if($( Read-Host -Prompt "Disable telemetry, diagnostic data and targeted ads? (y/n)" ) -eq 'y')
-            {
+            if ($( Read-Host -Prompt "Disable telemetry, diagnostic data and targeted ads? (y/n)" ) -eq 'y') {
                $PSBoundParameters.Add('DisableTelemetry', $DisableTelemetry)   
            }

-            if($( Read-Host -Prompt "Disable bing & cortana in windows search? (y/n)" ) -eq 'y')
-            {
+            if ($( Read-Host -Prompt "Disable bing & cortana in windows search? (y/n)" ) -eq 'y') {
                $PSBoundParameters.Add('DisableBing', $DisableBing)   
            }

-            if($( Read-Host -Prompt "Disable tips & tricks on the lockscreen? (y/n)" ) -eq 'y')
-            {
+            if ($( Read-Host -Prompt "Disable tips & tricks on the lockscreen? (y/n)" ) -eq 'y') {
                $PSBoundParameters.Add('DisableLockscreenTips', $DisableLockscreenTips)   
            } 

-            if($( Read-Host -Prompt "Disable tips, tricks and suggestions in the startmenu and settings, and ads in windows explorer? (y/n)" ) -eq 'y')
-            {
+            if ($( Read-Host -Prompt "Disable tips, tricks and suggestions in the startmenu and settings, and ads in windows explorer? (y/n)" ) -eq 'y') {
                $PSBoundParameters.Add('DisableSuggestions', $DisableSuggestions)   
            }

-            if($( Read-Host -Prompt "Do you want to hide any icons from the taskbar? (y/n)" ) -eq 'y')
-            {
-                if($( Read-Host -Prompt "Hide the chat (meet now) icon on the taskbar? (y/n)" ) -eq 'y')
-                {
+            if ($( Read-Host -Prompt "Do you want to hide any icons from the taskbar? (y/n)" ) -eq 'y') {
+                if ($( Read-Host -Prompt "Hide the chat (meet now) icon on the taskbar? (y/n)" ) -eq 'y') {
                    $PSBoundParameters.Add('DisableChat', $DisableChat)   
                }

-                if($( Read-Host -Prompt "Hide the widget (news and interests) icon on the taskbar? (y/n)" ) -eq 'y')
-                {
+                if ($( Read-Host -Prompt "Hide the widget (news and interests) icon on the taskbar? (y/n)" ) -eq 'y') {
                    $PSBoundParameters.Add('DisableWidgets', $DisableWidgets)   
                }
            }

-            if($( Read-Host -Prompt "Do you want to hide any folders from the windows explorer sidepanel? (y/n)" ) -eq 'y')
-            {
-                if($( Read-Host -Prompt "Hide the onedrive folder in windows explorer? (y/n)" ) -eq 'y')
-                {
+            if ($( Read-Host -Prompt "Do you want to hide any folders from the windows explorer sidepanel? (y/n)" ) -eq 'y') {
+                if ($( Read-Host -Prompt "Hide the onedrive folder in windows explorer? (y/n)" ) -eq 'y') {
                    $PSBoundParameters.Add('DisableOnedrive', $DisableOnedrive)   
                }

-                if($( Read-Host -Prompt "Hide the 3D objects folder in windows explorer? (y/n)" ) -eq 'y')
-                {
+                if ($( Read-Host -Prompt "Hide the 3D objects folder in windows explorer? (y/n)" ) -eq 'y') {
                    $PSBoundParameters.Add('Disable3dObjects', $Disable3dObjects)   
                }

-                if($( Read-Host -Prompt "Hide the music folder in windows explorer? (y/n)" ) -eq 'y')
-                {
+                if ($( Read-Host -Prompt "Hide the music folder in windows explorer? (y/n)" ) -eq 'y') {
                    $PSBoundParameters.Add('DisableMusic', $DisableMusic)   
                }
            }

-            if($( Read-Host -Prompt "Do you want to disable any context menu options? (y/n)" ) -eq 'y')
-            {
-                if($( Read-Host -Prompt "Disable the 'Include in library' option in the context menu? (y/n)" ) -eq 'y')
-                {
+            if ($( Read-Host -Prompt "Do you want to disable any context menu options? (y/n)" ) -eq 'y') {
+                if ($( Read-Host -Prompt "Disable the 'Include in library' option in the context menu? (y/n)" ) -eq 'y') {
                    $PSBoundParameters.Add('DisableIncludeInLibrary', $DisableIncludeInLibrary)   
                }

-                if($( Read-Host -Prompt "Disable the 'Give access to' option in the context menu? (y/n)" ) -eq 'y')
-                {
+                if ($( Read-Host -Prompt "Disable the 'Give access to' option in the context menu? (y/n)" ) -eq 'y') {
                    $PSBoundParameters.Add('DisableGiveAccessTo', $DisableGiveAccessTo)   
                }

-                if($( Read-Host -Prompt "Disable the 'Share' option in the context menu? (y/n)" ) -eq 'y')
-                {
+                if ($( Read-Host -Prompt "Disable the 'Share' option in the context menu? (y/n)" ) -eq 'y') {
                    $PSBoundParameters.Add('DisableShare', $DisableShare)   
                }
            }
@@ -319,75 +293,58 @@ if((-NOT $PSBoundParameters.Count) -or $RunDefaults -or $RunWin11Defaults -or ((
        }
    }
 }
-else
-{
-    Clear
+else {
+    Clear-Host
    Write-Output "-------------------------------------------------------------------------------------------"
    Write-Output " Win10Debloat Script - Custom Configuration"
    Write-Output "-------------------------------------------------------------------------------------------"
 }

 # Execute all selected/provided parameters
-switch ($PSBoundParameters.Keys)
-{
-    'RemoveApps' 
-    {
+switch ($PSBoundParameters.Keys) {
+    'RemoveApps' {
        RemoveApps
    }
-    'DisableTelemetry'
-    {
+    'DisableTelemetry' {
        RegImport "> Disabling telemetry, diagnostic data and targeted ads..." $PSScriptRoot\Regfiles\Disable_Telemetry.reg
    }
-    'DisableBingSearches'
-    {
+    'DisableBingSearches' {
        RegImport "> Disabling bing & cortana in windows search..." $PSScriptRoot\Regfiles\Disable_Bing_Cortana_In_Search.reg
    }
-    'DisableBing'
-    {
+    'DisableBing' {
        RegImport "> Disabling bing & cortana in windows search..." $PSScriptRoot\Regfiles\Disable_Bing_Cortana_In_Search.reg
    }
-    'DisableLockscreenTips'
-    {
+    'DisableLockscreenTips' {
        RegImport "> Disabling tips & tricks on the lockscreen..." $PSScriptRoot\Regfiles\Disable_Lockscreen_Tips.reg
    }
-    'DisableWindowsSuggestions'
-    {
+    'DisableWindowsSuggestions' {
        RegImport "> Disabling tips, tricks and suggestions in the startmenu and settings, and ads in windows explorer..." $PSScriptRoot\Regfiles\Disable_Windows_Suggestions.reg
    }
-    'DisableSuggestions'
-    {
+    'DisableSuggestions' {
        RegImport "> Disabling tips, tricks and suggestions in the startmenu and settings, and ads in windows explorer..." $PSScriptRoot\Regfiles\Disable_Windows_Suggestions.reg
    }
-    'DisableChat'
-    {
+    'DisableChat' {
        RegImport "> Hiding the chat icon on the taskbar..." $PSScriptRoot\Regfiles\Disable_Chat_Taskbar.reg
    }
-    'DisableWidgets'
-    {
+    'DisableWidgets' {
        RegImport "> Hiding the widget icon on the taskbar..." $PSScriptRoot\Regfiles\Disable_Widgets_Taskbar.reg
    }
-    'DisableOnedrive'
-    {
+    'DisableOnedrive' {
        RegImport "> Hiding the onedrive folder in windows explorer..." $PSScriptRoot\Regfiles\Hide_Onedrive_Folder.reg
    }
-    'Disable3dObjects'
-    {
+    'Disable3dObjects' {
        RegImport "> Hiding the 3D objects folder in windows explorer..." $PSScriptRoot\Regfiles\Hide_3D_Objects_Folder.reg
    }
-    'DisableMusic'
-    {
+    'DisableMusic' {
        RegImport "> Hiding the music folder in windows explorer..." $PSScriptRoot\Regfiles\Hide_Music_folder.reg
    }
-    'DisableIncludeInLibrary'
-    {
+    'DisableIncludeInLibrary' {
        RegImport "> Disabling 'Include in library' in the context menu..." $PSScriptRoot\Regfiles\Disable_Include_in_library_from_context_menu.reg
    }
-    'DisableGiveAccessTo'
-    {
+    'DisableGiveAccessTo' {
        RegImport "> Disabling 'Give access to' in the context menu..." $PSScriptRoot\Regfiles\Disable_Give_access_to_context_menu.reg
    }
-    'DisableShare'
-    {
+    'DisableShare' {
        RegImport "> Disabling 'Share' in the context menu..." $PSScriptRoot\Regfiles\Disable_Share_from_context_menu.reg
    }
 }