Release/3.3.0 (#29)

This v3.3.0 release is a big PR that focuses on code-parity with macOS
Valet, enhanced emergency uninstallation, significant code quality
improvements and lots of refactoring for improved maintainability. Valet
will also no longer ship with the executable for Acrylic, instead the
latest version is dynamically downloaded and installed from SourceForge.

Here are some notable changes:

### New Features

- Added new http 500 error page to help users debug nginx errors that
fail silently.

- Added new `Packages\Package` and `Packages\Acrylic` classes for better
maintainability and usability.

- Added `Ansicon` to the emergency uninstall services script to help
cases where Ansicon fails to uninstall properly via `valet uninstall`,
which leaves it's path in the registry, and upon reinstalling valet, the
`"The system cannot find the path specified"` error then fails the
installation process. This is a workaround and not a direct fix for
issue #28. Also improved the UX of the script.

- Many code-parity changes, additions, and fixes with the Mac version
(v4.8.7). Including moving the drivers into the PSR-4 autoloaded `Valet`
directory and namespacing them as `Valet\Drivers` or
`Valet\Drivers\Specific`. Also introduced new legacy drivers to extend
the namespaced drivers so user custom drivers will still work.

### Removals

- Removed all the bin files for Acrylic, in favour of downloading the
latest versions from SourceForge.

- Removed the redundant `CommandLine::runAsUser`,
`Valet::composerGlobalDiagnose`, `Valet::composerGlobalUpdate`, and
`ValetException::githubApiRateLimitExceededError` methods.

### Deprecations

- The new legacy drivers are all deprecated by default and will be
removed in v4.0.0.

### Fixes

- Fixed the coping of Unicode characters in the `Diagnose` output.

- Fixed errors when the Valet home directory (`~/.config/valet`) doesn't
exist during the `Upgrader` run. `Upgrader` now only runs if the home
path exists.

- Fixed `Upgrader::upgradeSymbolicLinks` method running when the
directory is empty causing redundant console messages. It now only runs
when the config key is missing and there are symlinks in the directory.

- Fixed system compatibility check to PHP 7.4 as a minimum.

- Fixed `set-ngrok-token` command errors that was caused by a method
name change. It now uses the `Ngrok::getConfig` instead of the old
`Ngrok::getNgrokConfig`.

- Fixed updating old isolated site conf files on `valet install`.
Secured site conf files have always been updated on installing valet,
but isolated sites were stuck using old configs. All files are now
rewritten to use the updated conf structure.

- Fixed `Site::unisolate` and `Site::isolate` methods to not output info
directly to the terminal, as this causes progress bars to mess up. The
output is now moved to the commands that called the methods.

Author: yCodeTech

.editorconfig

@@ -2,7 +2,7 @@ root = true
 
 [*]
 charset = utf-8
-end_of_line = lf
+end_of_line = crlf
 insert_final_newline = true
 indent_style = tab
 indent_size = 4

.prettierrc.json

@@ -4,5 +4,6 @@
 	"semi": true,
 	"printWidth": 150,
 	"bracketSameLine": true,
-	"bracketSpacing": false
+	"bracketSpacing": false,
+	"endOfLine": "crlf"
 }

CHANGELOG.md

@@ -7,6 +7,100 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased](https://github.com/yCodeTech/valet-windows/tree/master)
 
+## [3.3.0](https://github.com/yCodeTech/valet-windows/tree/v3.3.0) - 2025-10-22
+
+This is a large [Release PR](https://github.com/yCodeTech/valet-windows/pull/29) that focuses on code-parity with macOS Valet, enhanced emergency uninstallation, significant code quality improvements and lots of refactoring for improved maintainability. Valet will also no longer ship with the executable for Acrylic, instead the latest version is dynamically downloaded and installed from SourceForge.
+
+For the full changelog please view the PR commits.
+
+### Added
+
+-   Added the ability for nginx to display http status 500 error page. This is important because if a PHP error occurs internally while trying to access a site, nginx fails silently, and the browser just displays a generic 500 error page. To help users debug the error, and narrow down the cause of the error, the new valet 500 error page will tell users where to look for the error in the logs.
+
+-   Added a command to the `Diagnose` class to get the `winsw` version via reading it's README.
+
+-   Added the ability to get the structure of both Valet's home directory and the Valet bin directory and output it in the `Diagnose` output as a directory tree diagram. This will help diagnose any issues in the future by making sure the Valet home directory and Valet bin directory has all the required files and named correctly. A new `Filesystem::scanDirRecursive` method has also been added to assist with scanning and retrieving of the directories and files.
+
+-   Added the ability to download the latest version of `Acrylic`.
+
+    -   Added new `Acrylic` class with the namespace `Valet\Packages` that extend the new base `Package` class. This class will download the latest version from SourceForge.
+
+    -   Added new `Acrylic_IPv4_Binding_Address.ini` stub file to add the custom IPv4 binding localhost loopback address as fixed in PR [#15](https://github.com/yCodeTech/valet-windows/pull/15).
+
+    -   Added a `changeLocalIpv4BindingAddress` method to replace the default value of `LocalIPv4BindingAddress` with our custom value from the new stub file.
+
+### Changed
+
+-   Extract much of `GithubPackage` class into a new `Package` class as the new base class, refactor and make the method and variable names generic.
+
+-   Improved the emergency uninstall services creation during Valet installation. The emergency uninstall files are now located in `~/.config/valet/Emergency Uninstall`.
+
+    -   Fixed the script to automatically run with admin privileges if it doesn't already have them.
+
+    -   Added `Ansicon` to the script to handle cases where `Ansicon` fails to uninstall properly.
+
+        In cases where valet has uninstalled for a composer update, there is sometimes a remnants of the Ansicon path in the registry. This will cause installation issues where a system message will appear `"The system cannot find the path specified"` or similar, and installation will fail. This emergency script has a copy of Ansicon in the `~/.config/valet/Emergency Uninstall` directory and will attempt to uninstall it again. This is just a workaround, and not a direct fix for issue [#28](https://github.com/yCodeTech/valet-windows/issues/28).
+
+    -   Fixed the script to remove all the `valet\Services` files after uninstalling them.
+
+-   Code-parity with the Mac version (v4.8.7):
+
+    -   Moved the basic and laravel drivers into a new `Drivers` directory within the `Valet` directory, and namespaced them as `Valet\Drivers`.
+
+        Moved the rest of the drivers into the `Specific` subdirectory of `Drivers`, and namespaced them as `Valet\Drivers\Specific`.
+
+        This is so they can be autoloaded by PSR-4.
+
+    -   Introduced empty legacy driver classes that extend the namespaced drivers so that user custom drivers still work. These legacy drivers are deprecated by default.
+
+    -   Added the requirement for custom drivers to be namespaced as `Valet\Drivers\Custom`.
+
+    -   Added a more robust check for `Bedrock` environments and checking the composer dependencies for the required package.
+
+    -   Fixed Drupal JSON:API support for non-standard urls. More info on the Valet for Mac PR [#1218](https://github.com/laravel/valet/pull/1218).
+
+    -   Added new drivers for `Nette`, `Radicle`, and `Statamic V2`.
+
+    -   Fixed `Craft` driver to prevent sites breaking when applying security patches to Craft. More info on the Valet for Mac PR [#1516](https://github.com/laravel/valet/pull/1516).
+
+    -   Gracefully handle the old `SampleValetDriver.php` and upgrade it to the new namespaced sample via a new `Upgrader::fixOldSampleValetDriver` method.
+
+    -   Added upgrade instructions for custom drivers in [UPGRADE.md](/UPGRADE.md), including namespace and inheritance requirements.
+
+    -   Update logos to support GitHub dark/light theme.
+
+-   Moved the `services` command from being an installed-only command to being available without installation.
+
+-   Various refactoring for better organisation, maintainability, and improved code quality.
+
+### Fixed
+
+-   Fixed the copying of Unicode character in the `Diagnose` output. The Windows clip.exe program doesn't support copying of all Unicode characters, so if there's a character it doesn't know, it will display `????` in the output instead of the character. This is especially true for the box characters (eg. `┣━`) used for directory trees. The `copyToClipboard` method now writes the output to a temp file as UTF-8 with BOM encoding to allow usage of copyable Unicode characters, and uses the Powershell command `Set-Clipboard` to copy to the clipboard.
+
+-   Fixed errors when the Valet home directory (`~/.config/valet`) doesn't exist during the `Upgrader` run. `Upgrader` now only runs if the home path exists.
+
+-   Fixed `Upgrader::upgradeSymbolicLinks` method running when the directory is empty causing redundant console messages. It now only runs when the config key is missing and there are symlinks in the directory.
+
+-   Fixed system compatibility check to PHP 7.4 as a minimum.
+
+-   Fixed `set-ngrok-token` command errors that was caused by a method name change. The `Ngrok::getNgrokConfig` method was changed to the generic `Ngrok::getConfig` in the release PR of v3.2.0 and specifically in commit [db085bd](https://github.com/yCodeTech/valet-windows/commit/db085bd1ddb0be1d58a6b59b33acae5ee1050924), but it's usage in the command was never changed. Changed the method call to the new name.
+
+-   Fixed updating old isolated site conf files on `valet install`. Secured site conf files have always been updated on installing valet via the `Nginx::rewriteSecureNginxFiles` method, but isolated sites were stuck using old configurations. All conf files are now rewritten and updated to prevent old nginx configurations causing issues.
+
+-   Fixed `Site::unisolate` and `Site::isolate` methods to not output info directly to the terminal, as this causes progress bars to mess up in the terminal when using the `Site::reisolateForNewTld` method which calls the `un/isolate` methods. The info output is now moved to the commands that called the methods.
+
+### Removed
+
+-   Removed the `CommandLine::runAsUser` method because it is a duplicate method of `run`. It doesn't do anything different or special. So we can just use `run` instead.
+
+-   Removed the unused `Valet::composerGlobalDiagnose`, `Valet::composerGlobalUpdate`, and `ValetException::githubApiRateLimitExceededError` methods.
+
+-   Removed all bin files for `Acrylic`, in favour of downloading the latest versions from SourceForge.
+
+### Deprecated
+
+-   The new legacy drivers are all deprecated by default and will be removed in v4.0.0.
+
 ## [3.2.1](https://github.com/yCodeTech/valet-windows/tree/v3.2.1) - 2025-08-03
 
 ### Added

README.md

@@ -1,4 +1,4 @@
-<p align="center"><img src="./laravel_valet_windows_3_logo.svg" style="width:500px; background: none;"></p>
+<p align="center"><img src="./art/laravel_valet_windows_3_logo.svg" style="width:500px; background: none;"></p>
 
 <p align="center">
 <a href="https://packagist.org/packages/ycodetech/valet-windows"><img src="https://poser.pugx.org/ycodetech/valet-windows/downloads" alt="Total Downloads"></a>
@@ -10,7 +10,7 @@
 <p align="center">This is a Windows port of the popular Mac development environment <a href="https://github.com/laravel/valet">Laravel Valet</a>.</p>
 <p align="center">Laravel Valet <i>Windows</i> 3 is a much needed updated fork of <a href="https://github.com/cretueusebiu/valet-windows">cretueusebiu/valet-windows</a>, with lots of improvements and new commands. This version hopes to achieve as much parity as possible with the Mac version. For command parity, please refer to the <a href="#command-parity-checker">parity checker</a>.</p>
 
-<p align="center"><img src="./composer_laravel_valet_windows_3_logo.svg" style="width:400px; background: none;"></p>
+<p align="center"><img src="./art/composer_laravel_valet_windows_3_logo.svg" style="width:400px; background: none;"></p>
 
 ```sh
 composer global require ycodetech/valet-windows
@@ -152,10 +152,9 @@ This is 3.0 of Valet Windows, branded under the name _Laravel Valet Windows 3_,
 
 Valet ships with and installs these services:
 
-|                                                                       Service | Version |
-| ----------------------------------------------------------------------------: | ------- |
-| [Acrylic DNS Proxy](https://mayakron.altervista.org/support/acrylic/Home.htm) | 2.1.0   |
-|                                                   [ngrok](https://ngrok.com/) | 3.3.1   |
+|                     Service | Version |
+| --------------------------: | ------- |
+| [ngrok](https://ngrok.com/) | 3.3.1   |
 
 > [!IMPORTANT]
 > ngrok may error out that it is "too old" when running it for some accounts. In the upcoming v3.2.0 release, Valet will ship with the latest version of ngrok.
@@ -166,14 +165,15 @@ Valet ships with and installs these services:
 >
 > For both commands, valet automatically appends the config file location as a flag to the command, so ngrok will already know where the config file is.
 
-As of v3.2.0, Valet no longer ships with the executables for the following services, instead they will be downloaded and installed automatically from GitHub's API. This is so that the latest versions with bug fixes and security updates can be installed.
+As of v3.2.0 and v3.3.0, Valet no longer ships with the executables for the following services, instead they will be downloaded and installed automatically from it's online source (GitHub, SourceForge, etc.). This is so that the latest versions with bug fixes and security updates can be installed.
 
-|                                     Service | Latest Version as of 13/05/2025 |
-| ------------------------------------------: | ------------------------------- |
-| [Ansicon](https://github.com/adoxa/ansicon) | 1.89                            |
-|  [gsudo](https://github.com/gerardog/gsudo) | 2.6.0                           |
-|                 [nginx](https://nginx.org/) | 1.28.0                          |
-|     [WinSW](https://github.com/winsw/winsw) | 2.12.0                          |
+|                                                                       Service | Latest Version as of 2025-10-22 |
+| ----------------------------------------------------------------------------: | ------------------------------- |
+|                                   [Ansicon](https://github.com/adoxa/ansicon) | 1.89                            |
+|                                    [gsudo](https://github.com/gerardog/gsudo) | 2.6.1                           |
+|                                                   [nginx](https://nginx.org/) | 1.29.2                          |
+|                                       [WinSW](https://github.com/winsw/winsw) | 2.12.0                          |
+| [Acrylic DNS Proxy](https://mayakron.altervista.org/support/acrylic/Home.htm) | 2.2.1                           |
 
 > [!IMPORTANT]
 >
@@ -205,7 +205,7 @@ Also make sure to open your preferred terminal (Windows Terminal, CMD, Git Bash,
 
 -   Install Valet with Composer via `composer global require ycodetech/valet-windows`.
 
-    <p align="center"><img src="./composer_laravel_valet_windows_3_logo.svg" style="width:400px; background: none;"></p>
+    <p align="center"><img src="./art/composer_laravel_valet_windows_3_logo.svg" style="width:400px; background: none;"></p>
 
     > [!WARNING]
     >
@@ -1537,17 +1537,25 @@ Doesn't affect valet functionality.
 
 ## Emergency Stop and Uninstall Services
 
-As of v3.1.6, Valet has an emergency stop and uninstall services script. This script is copied to the `/.config/valet` directory for safe keeping.
+As of v3.1.6, Valet has an emergency stop and uninstall services script. This script is copied to the `/.config/valet/Emergency Uninstall` directory for safe keeping.
 
 So if `composer global update` is ran before valet is uninstalled, and several running services prevent composer from removing the files and updating valet, then you can run the `emergency_uninstall_services.bat` file to stop and uninstall the services.
 
 To run, open a CMD terminal with Admin privileges and run this:
 
 ```sh
-> %UserProfile%\.config\valet\emergency_uninstall_services.bat
+> "%UserProfile%\.config\valet\Emergency Uninstall\emergency_uninstall_services.bat"
 ```
 
-All services will have been stopped and you can then be able to run `composer global update`.
+Alternatively, find it in the File Explorer and double clicking the file will also run it.
+
+All services will have been stopped and removed and you can then be able to run `composer global update`.
+
+> [!IMPORTANT]
+>
+> If you receive the `The system cannot find the path specified` error or similar while installing valet, then usually it's to do with Ansicon leaving it's path in the registry after uninstalling, which then fails Valet's installation.
+>
+> The emergency uninstall script can help to uninstall Ansicon again and hopefully fully removing it from the registry.
 
 ## Valet Directories
 
@@ -1595,7 +1603,13 @@ Upon installation, Valet creates the following directories and config files:
 -   `~/.config/valet/config.json`
     This is the main Valet config file.
 
--   `~/.config/valet/emergency_uninstall_services.bat`
+-   `~/.config/valet/Emergency Uninstall`
+    Contains the emergency uninstall files.
+
+-   `~/.config/valet/Emergency Uninstall/ansicon`
+    Contains the Ansicon files and executable to help uninstall it.
+
+-   `~/.config/valet/Emergency Uninstall/emergency_uninstall_services.bat`
     This is an batch file to do an emergency stop and uninstall of all services. See the [Emergency Stop and Uninstall Services section](#emergency-stop-and-uninstall-services).
 
 > [!WARNING]
@@ -1655,6 +1669,12 @@ Upon installation, Valet creates the following directories and config files:
 
     If the WMI error does occur, try running the command again. If different WMI errors occur, please submit an issue with all relevant details.
 
+-   If there is a large error and it's file trace output to the terminal, the top of the error may be cut off/overwritten. Apparently Symfony can only write to the terminal that is viewable, if it goes outside of the viewable area (ie. you need to scroll up to view) then the output is overwritten and the most important part of the error, the description at the start is cut off. (See https://github.com/symfony/symfony/issues/35012). If this happens, make the terminal larger in height and try the command again to try and view the full error.
+
+-   When trying to install Valet after updating via Composer, and you receive this error or similiar: `The system cannot find the path specified`; it could be that Ansicon hasn't uninstalled properly and left it's path in the registry. Because it happens unpredictably, there is no way of debugging or fixing it.
+
+    The only "workaround" is to use the emergency uninstall script (`emergency_uninstall_services.bat`) in the `~/.config/valet/Emergency Uninstall` directory to allow Ansicon another chance to uninstall itself properly. (See [issue 28](https://github.com/yCodeTech/valet-windows/issues/28)). See the [Emergency Stop and Uninstall Services section](#emergency-stop-and-uninstall-services).
+
 ## Xdebug Installation
 
 Valet only installs a specific Xdebug PHP CGI service on a separate port to work alongside the PHP service. To install Xdebug itself, follow the [official guide](https://xdebug.org/docs/install).

UPGRADE.md

@@ -0,0 +1,9 @@
+# Upgrading
+
+-   If you have any issues with your drivers, all custom drivers (including the `SampleValetDriver` published by previous versions of Valet) must have the following:
+
+    -   Have the namespace of `Valet\Drivers\Custom`.
+
+    -   Extend the new namespaced drivers instead of the old non-namespaced drivers by specifying a `use` keyword like `use Valet\Drivers\ValetDriver;`
+
+    See the [new SampleValetDriver](https://github.com/yCodeTech/valet-windows/blob/master/cli/stubs/SampleValetDriver.php) for an example.