Add Uninstall CTT PowerShell Profile feature

ChrisTitusTech / winutil

Chris Titus Tech's Windows Utility - Install Programs, Tweaks, Fixes, and Updates

MIT License

24.59k stars 1.49k forks source link

Type of Change

[x] New feature
[ ] Bug fix
[ ] Documentation update
[ ] Refactoring
[ ] Hotfix
[ ] Security patch
[x] UI/UX improvement

Description

Implements the ability to uninstall the CTT PowerShell Profile and all its related dependencies.

Testing

I have tested the profile uninstallation functionality by running it in the following test scenarios:

Baseline: Installing the CTT PowerShell Profile
Test 1: Uninstallation of OhMyPosh dependency: [✅] Successful
Test 2: Uninstallation of Nerd Fonts dependency: [❓] Conditional
- Additional Context: See Notes for Test 2 in Additional Information.
Test 3: Uninstallation of Terminal-Icons dependency: [✅] Successful
Test 4: Uninstallation of Zoxide dependency: [✅] Successful
Test 5: Skipping uninstallation of in-use dependencies: [✅] Successful
Test 6: Uninstallation of CTT PowerShell Profile: [✅] Successful

Impact

Covered by ## Description, ## Testing, and ## Additional Information.

Issue related to PR

Resolves #2836

Additional Information

New Files Created

$PSProfile.hash: A file that stores the hash of the CTT PowerShell Profile; this is used to check if the profile is installed on the system.
- Additional Context:
- The path is derived from the $PSProfile variable with .hash being appended to the end of the file path.
- Example Hash File Path: C:\Users\<user>\Documents\PowerShell\Microsoft.PowerShell_profile.ps1.hash.
- This file will be cleaned up and removed when the CTT PowerShell Profile is uninstalled from the system.
- $PSProfile.bak: A file that is used as a backup of the PowerShell profile prior to the CTT PowerShell Profile being installed on the system.
  - Additional Context:
  - The path is derived from the $PSProfile variable with .bak being appended to the end of the file path.
  - Example Backup File Path: C:\Users\<user>\Documents\PowerShell\Microsoft.PowerShell_profile.ps1.bak.
  - This file will be moved back to the original PowerShell profile's location when the CTT PowerShell Profile is uninstalled from the system.

Notes For Test 2

Note 1: Nerd Fonts won't always be installed due to an issue with the setup script for the PowerShell profile.
Note 2: If the font is not installed, the user will see the message: ===> Already Uninstalled: Nerd Fonts. <===.

Possible Change

I'm not sure if the documentation files in ./docs/dev/features/PowerShell-Profile are necessary, I added them for completeness but if they aren't needed please let me know so I can remove them.

Checklist

[x] My code adheres to the coding and style guidelines of the project.
[x] I have performed a self-review of my own code.
[ ] I have commented my code, particularly in hard-to-understand areas.
[x] I have made corresponding changes to the documentation.
[x] My changes generate no errors/warnings/merge conflicts.

ChrisTitusTech / winutil