4.1.0 Release
This release contains two brand new great features:
- The Run Configuration integration for the Adobe Commerce Upgrade Compatibility Tool
- The built-in Upgrade Compatibility Tool (MVP)
Run Configurations are used to run internal and external processes from within IntelliJ Platform based products. To get familiar with the concept of a Run Configuration refer Run/Debug Configuration section of IntelliJ IDEA Web Help.
The Upgrade Compatibility Tool Run Configuration is a GUI for the Upgrade Compatibility Tool.
The UCT Run Configuration provides the ability to configure UCT installed for the project via composer. If the UCT was installed separately (outside the project), such UCT executable can also be chosen in the dedicated Run Configuration. In the case when the UCT was not found in the current project, the corresponding message is shown with the link that provides the ability to download and install the UCT for the current project. Be aware, that the UCT is an Adobe Commerce feature, so to install it you should have your Adobe Commerce license key.
The UCT Run Configuration template can be found in the Run/Debug configurations dialog -> Add New Configuration -> Upgrade Compatibility Tool:
The UCT Run Configuration template has the next view:
These are the main components of the configuration template:
-
UCT Executable - path to the UCT executable script which is located by the path
bin/uctfrom the UCT source root directory, required field - Project Root - current PHPStorm Project root directory, it is determined automatically, required field
- Path To Analyse - this field allows you to restrict the search to the specified folder, optional field
- Coming Version - the Adobe Commerce targeted version, required field
- Min Issue Level - minimum issue level to show in the report. Default is [WARNING], optional field
- Ignore Current Version Compatibility Issues - use this option when you do not want to include known critical issues, errors and warnings in your Upgrade Compatibility Tool report, optional field
- Message that appears if the UCT could not be found for the current PHPStorm Project
- Link to install the UCT for the current PHPStorm Project.
After the Run Configuration template is configured it can be used to easily run the tool via a single click whenever needed.
The UCT installation for the current project (if composer wasn't authenticated with the Adobe Commerce repository):
The composer would request the auth keys if they can not be found, for more information refer to the official documentation.
After providing your auth keys you will get the same output as for the authenticated users:
To run the UCT click on the Run 'UCT Run' green button:
The results of UCT execution is displayed in the console including handy navigation to the compatibility issues in the code.
The output of the tool is displayed in the PHPStorm console with the ability to click on the references to:
- navigate to the code that has an issue
- navigate to the issue code description on the DevDocs page
- navigate to the report file
