`DefaultIO` raised a deprecation on PHP `trim` call

[llaville]

Hello @sebastianfeldmann

I'm currently working on a new CaptainHook Plugin (that I think, it may be useful for the Community), and I found some core issues during my tests.

About: CaptainHook 5.28.0

I'll open reports now.

First one is

Trying to retrieve getStandardInput values from DefaultIO inside the beforeHook

For example

use CaptainHook\App\Config;
use CaptainHook\App\Plugin;
use CaptainHook\App\Runner\Hook as RunnerHook;

class BinPlugin extends Plugin\Hook\Base implements Plugin\Hook
{
    public function beforeHook(RunnerHook $hook): void
    {
        $stdInput = $this->io->getStandardInput();
    }
}

I got this PHP error

Deprecated: trim(): Passing null to parameter #1 ($string) of type string is deprecated in /shared/backups/bartlett/captainhook-bin-plugin/vendor/captainhook/captainhook/src/Console/IO/DefaultIO.php on line 112

My patch to fix it, could be :

    public function getStandardInput(): array
    {
        if (empty($this->stdIn)) {
            if (empty($this->input->getOption('input'))) {
                $this->stdIn = $this->input->getOptions();
            } else {
                $this->stdIn = explode(PHP_EOL, trim($this->input->getOption('input'), '"'));
            }
        }
        return $this->stdIn;
    }

[sebastianfeldmann]

What do you want to do with the stdIn?
Do you need the user stdIn, or the original git command stdIn?

I convert the original input to the --input option. The user stdIn is a different story. That's not possible for all hooks. Especially those that have stdIn themselves.

Those two things are not the same.

$this->stdIn = $this->input->getOptions();

and

$this->stdIn = explode(PHP_EOL, trim($this->input->getOption('input'), '"'));

[llaville]

I want the first syntax ... getting options from input console

[llaville]

\CaptainHook\App\Console\IO contract does not provide ability to retrieve input options.

Only original arguments from CLI may be get with the getArguments() function.

[sebastianfeldmann]

Yes, if you need the original hook arguments you can use IO::getArgument you can find the list of argument names in the Hooks class.

    public const ARG_COMMAND       = 'command';
    public const ARG_GIT_COMMAND   = 'git-command';
    public const ARG_HASH          = 'hash';
    public const ARG_MESSAGE_FILE  = 'message-file';
    public const ARG_MODE          = 'mode';
    public const ARG_NEW_HEAD      = 'new-head';
    public const ARG_PREVIOUS_HEAD = 'previous-head';
    public const ARG_SQUASH        = 'squash';
    public const ARG_TARGET        = 'target';
    public const ARG_URL           = 'url';

Not all arguments are available for all hooks. You can also find a mapping of hook to arguments in the Hooks class in line 137.

    public static function getOriginalHookArguments(string $hook): string
    {
        static $arguments = [
            Hooks::COMMIT_MSG         => ' {$FILE}',
            Hooks::POST_MERGE         => ' {$SQUASH}',
            Hooks::PRE_COMMIT         => '',
            Hooks::POST_COMMIT        => '',
            Hooks::PRE_PUSH           => ' {$TARGET} {$URL}',
            Hooks::PREPARE_COMMIT_MSG => ' {$FILE} {$MODE} {$HASH}',
            Hooks::POST_CHECKOUT      => ' {$PREVIOUSHEAD} {$NEWHEAD} {$MODE}',
            Hooks::POST_REWRITE       => ' {$GIT-COMMAND}',
        ];

        return $arguments[$hook];
    }

So if you need the FILE with the prepared commit message in a commit-message hook you can use.

$io->getArgument(Hooks::ARG_MESSAGE_FILE);

If you want all arguments getArguments should do the trick.

[llaville]

I don't want arguments, but options, that will allow in a plugin to get something like

    public function beforeHook(RunnerHook $hook): void
    {
        $bootstrapFile = $this->io->getOptions()['bootstrap'];

        if (!empty($bootstrapFile) && \file_exists($bootstrapFile)) {
            require $bootstrapFile;
        }

    }

Even if I found a work around to this problem, with your answer at #292 (comment)

I create a custom autoloaders that include all files if present

<?php

$autoloadFiles = [
    dirname(__DIR__) . '/vendor-bin/phpstan/vendor/autoload.php',
    dirname(__DIR__) . '/vendor-bin/phpunit/vendor/autoload.php',
];

foreach ($autoloadFiles as $autoloadFile) {
    if (\file_exists($autoloadFile)) {
        require $autoloadFile;
    }
}

[sebastianfeldmann]

In the Plugin the configure method is called with the Config object as an argument.
You can keep track of it putting it into $this->config or something then you can ask it $this->config->getBootstrap() to gain access to the bootstrap option. Be aware that it by default returns vendor/autoload.php.

[sebastianfeldmann]

I went with this option

$this->stdIn = explode(PHP_EOL, trim((string)$this->input->getOption('input'), '"'));