A new plugin for the Community (that I've dreamed to have)

[llaville]

Introduction

Is it not annoying to see the execution of an action failed, simply because you forgot to install the package ?

For example :

Presentation

I'm proud to announce that I'll publish very soon now my first plugin for CaptainHook.

It's main goal is to execute vendor dependency binary action only if their package is installed.

Example when package not installed

Example when package is installed

For attentive users, you've probably noticed that, even if the terminal support colors, actions run but not render their output with colorized copy. And even if action has auto-detection like https://github.com/carthage-software/mago

This is the reason and other goal of this plugin : make it configurable to be able to run action as they are supposed to be without to hard-coded as much as possible the action line.

More details will come when documentation will be finished to write and source code officially opened.
The project is still private, under polishing state at URL https://github.com/llaville/captainhook-bin-plugin

Warnings

I've applied on core CaptainHook code some modifications :

For easy reading only :

• Make captainhook.json config file human-readable with long action line contents #302
• Make it easy to debug with Placeholders #303

And a mandatory

• Allow to use Plugin Options with the CONFIG placeholder #304

To do so, I've used the awesome https://github.com/cweagans/composer-patches Composer Plugin

Caution

I've noticed big issues with major version 2.0 of this plugin, so stay on version 1.7 (latest stable available, that accept local patches)

[llaville]

With pretty jobs of @sebastianfeldmann on version 5.28.4, I should be able to release officially my plugin in next 48 hours.

No more need to patch CaptainHook ;-)

[llaville]

The repository where you can find my plugin : source code, documentation, examples is now public

In waiting an official release on Composer, you can visit the project at https://github.com/llaville/captainhook-bin-plugin

[llaville]

For better readability of the online documentation, please visit https://llaville.github.io/captainhook-bin-plugin/1.x/

[llaville]

For users that prefer using PHAR distribution installed by phive, be happy it's on way ... I'm working on this feature !

[llaville]

PHAR distribution tools installed by Phive is now supported !

Official Composer Package of my plugin will be release soon.
Just to let me time to finish documentation and writes unit tests suites.

From current source code available, here are changes applied :

• PHP minimum requirement is raise to 8.1 (previously I've synchronized with Cap'n : PHP 8.0), because I used PHP Enums feature to handle the new dependency-manager option.

The Dependency Manager used (composer: default, or phive ... and whatever we want else, depending of a new Condition implementation) is visible easily on standard output (Applied line)

For example with

vendor/bin/captainhook hook:pre-commit -c captainhook.json.mago-sample --verbose

We could see

  Applied: Composer package installed carthage-software/mago (with constraint "*")

And with new upcoming Phive support

For example with

vendor/bin/captainhook hook:pre-commit -c captainhook.json.phpcs-sample --verbose

We could see

 Applied: PHAR tool installed squizlabs/php_codesniffer (with constraint "^3.3 || ^4.0")

Here is a teaser screenshot

[llaville]

Of course there are still the Condition line that allow to identify the Dependency Manager used (too)