CaptainHook\App\Hook\Condition\File\Staged

Complexity

Total Complexity

2

Size/Duplication

Total Lines	21
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getFiles()	0	3	1
A	getRestriction()	0	3	1

<?php

/**
 * This file is part of CaptainHook.
 *
 * (c) Sebastian Feldmann <sf@sebastian-feldmann.info>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace CaptainHook\App\Hook\Condition\File;

use CaptainHook\App\Console\IO;
use CaptainHook\App\Hook\Restriction;
use CaptainHook\App\Hooks;
use SebastianFeldmann\Git\Repository;

/**
 * Trait for all Conditions checking for staged files
 *
 * Normally we would inject that functionality into the condition but since we want to have individual classes
 * that can be referenced in a configuration file, using a Trait is a bit of a workaround.
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>
 * @link    https://github.com/captainhook-git/captainhook
 * @since   Class available since Release 5.27.3
 */
trait Staged
{
    /**
     * Return the hook restriction information
     *
     * @return \CaptainHook\App\Hook\Restriction
     */
    public static function getRestriction(): Restriction
    {
        return Restriction::fromArray([Hooks::PRE_COMMIT]);
    }

    /**
     * @param  \CaptainHook\App\Console\IO       $io
     * @param  \SebastianFeldmann\Git\Repository $repository
     * @param  array<string>                     $filter
     * @return array<string>
     */
    protected function getFiles(IO $io, Repository $repository, array $filter): array

The parameter $filter is not used and could be removed.

The parameter $io is not used and could be removed.

    {
        return $repository->getIndexOperator()->getStagedFiles($this->diffFilter);
    }
}