Portman

Portman is solely needed for development and contributions. Magewire itself runs seamlessly without requiring Portman.

Portman, developed by Justin van Elst, is a command-line utility designed to simplify the process of porting PHP libraries between frameworks.

What is Portman?

The idea for Portman was born during a two-hour car ride, sparked by a discussion between Justin van Elst and Willem Poortman, about some ideal solutions to avoid the challenges faced during the development of the Magewire 3 port from Livewire. Throughout the process, a number of workarounds had to be implemented to make things function — many of which were less than ideal — as Livewire wasn’t built with cross-framework compatibility in mind.

During that conversation, a rough sketch of a possible solution was made. Justin took that concept and turned it into Portman — one of the most critical tools that made Magewire V3 possible.

Portman enables developers to perform various porting tasks without the need to overwrite original source files. Since Magewire draws heavy inspiration from Livewire’s codebase, keeping up with upstream changes would have been nearly impossible through manual syncing alone. Thanks to Portman’s intelligent porting capabilities, only minimal modifications were needed to adapt Livewire’s functionality for Magento.

More details, please refer to the GitHub repository.

Requirements

Before we start, make sure you have the following installed:

PHP version 8.2 or later

Installation

To start contributing to Magewire, follow these steps:

Require Portman via Composer:

composer require magewirephp/portman --dev

CD into the Magewirephp module:
```
cd vendor/magewirephp/magewire
```
Optionally, initialize a configuration when it does not exist:
```
../../bin/portman init
```
Optionally, download the donor source
```
../../bin/portman download-source
```
Build a new distribution:
```
../../bin/portman build
```
Optionally, use a watcher while programming:
```
../../bin/portman watch
```

Watcher

The watcher will automatically trace files and rebuild a new distribution on file changes.

Install chokidar-cli:
```
npm install chokidar-cli
```
Optionally, install it globally:
```
npm install chokidar-cli -g
```
Run the watcher:
```
../../bin/portman watch
```

Troubleshooting

Some common issues are:

Issue	Solution
The `/dist` folder is missing after requiring Magewire via Composer	The distribution is only build when a new release is being pushed. When you require Magewire manually, you need to first build a new distribution.
Disctribution build, but shows a warning that one or more files have a augmentation but no source.	Use `../../bin/portman download-source` and rebuild once more.