Toolkit

GitHooksCommands extends AbstractCommands
in package

Provides commands to interact with git hooks.

Tags
SuppressWarnings

("unused")

Table of Contents

Methods

getConfigurationFile()  : string
Path to YAML configuration file containing command defaults.
getJson()  : array<string|int, mixed>
Returns the JSON parsed content.
getWorkingDir()  : string
Returns the current working directory.
hooksDeleteAll()  : void
Remove all existing hooks, this will ignore active hooks list.
hooksDisable()  : int
Disable the git hooks.
hooksEnable()  : int
Enable the git hooks defined in the configuration or in given option.
hooksList()  : void
List available hooks and its status.
hooksRun()  : int
Run a specific hook.
isWebsiteInstalled()  : bool
Check if the website is installed.
getBin()  : string
Validate and return the path to given bin.
getBinPath()  : string
Return the path to given bin.
getConfigValue()  : mixed|null
Return the configuration value.
getNodeBin()  : string
Validate and return the path to given bin from node packages.
getNodeBinPath()  : string
Return the path to given bin from node packages.
isJunit()  : bool
Check whether Junit option is being used, or env var is set.
isSimulating()  : bool
Check if current command is being executed with option simulate.
taskExecute()  : CollectionBuilder
Execute a command.
taskProcess()  : ReplaceBlock|CollectionBuilder
Process the file.
taskReplaceBlock()  : ReplaceBlock|CollectionBuilder
Replace block in a file.
convertHookToMethod()  : false|string
Converts a hook name to method name.
getAvailableHooks()  : array<string|int, string>
Return the available hooks from Toolkit and Project.
getHookFiles()  : array<string|int, string>
Return the hooks present in given directory.
runCommitMsg()  : int
Hook: Executes the commit-msg conditions.
runPreCommit()  : int
Hook: Executes the PHPcs against the modified files.
runPrePush()  : int
Hook: Executes the pre-push commands.

Methods

getConfigurationFile()

Path to YAML configuration file containing command defaults.

public getConfigurationFile() : string
Return values
string —

Configuration file path.

getJson()

Returns the JSON parsed content.

public getJson(string $filename[, bool $throwException = true ]) : array<string|int, mixed>
Parameters
$filename : string
$throwException : bool = true

If the file is not found.

Return values
array<string|int, mixed> —

Json parsed content.

getWorkingDir()

Returns the current working directory.

public getWorkingDir() : string
Return values
string —

The current working directory.

hooksDeleteAll()

Remove all existing hooks, this will ignore active hooks list.

public hooksDeleteAll(ConsoleIO $io) : void
Parameters
$io : ConsoleIO
Tags
command

toolkit:hooks-delete-all

Return values
void —

The hooks deleted status.

@aliases tk-hdel

hooksDisable()

Disable the git hooks.

public hooksDisable(ConsoleIO $io[, array<string|int, mixed> $options = ['hooks' => InputOption::VALUE_REQUIRED] ]) : int
Parameters
$io : ConsoleIO
$options : array<string|int, mixed> = ['hooks' => InputOption::VALUE_REQUIRED]

Command options.

Tags
command

toolkit:hooks-disable

aliases

tk-hdis

option

hooks The hooks to disable (default: toolkit.git.hooks)

Return values
int —

The exit code.

hooksEnable()

Enable the git hooks defined in the configuration or in given option.

public hooksEnable(ConsoleIO $io[, array<string|int, mixed> $options = ['hooks' => InputOption::VALUE_REQUIRED] ]) : int
Parameters
$io : ConsoleIO
$options : array<string|int, mixed> = ['hooks' => InputOption::VALUE_REQUIRED]

Command options.

Tags
command

toolkit:hooks-enable

option

hooks The hooks to enable (default: toolkit.hooks.active)

aliases

tk-hen

usage

--hooks=pre-push

Return values
int —

The exit code.

hooksList()

List available hooks and its status.

public hooksList(ConsoleIO $io) : void
Parameters
$io : ConsoleIO
Tags
command

toolkit:hooks-list

aliases

tk-hlist

SuppressWarnings

(PHPMD.CyclomaticComplexity)

SuppressWarnings

(PHPMD.NPathComplexity)

Return values
void —

The hooks list.

hooksRun()

Run a specific hook.

public hooksRun(ConsoleIO $io, string $hook[, string $arg1 = '' ][, string $arg2 = '' ][, string $arg3 = '' ]) : int
Parameters
$io : ConsoleIO
$hook : string

The hook to run.

$arg1 : string = ''

The first argument of the given hook.

$arg2 : string = ''

The second argument of the given hook.

$arg3 : string = ''

The third argument of the given hook.

Tags
command

toolkit:hooks-run

aliases

tk-hrun

phpcs:disable DrupalPractice.CodeAnalysis.VariableAnalysis.UnusedVariable

Return values
int —

The exit code.

isWebsiteInstalled()

Check if the website is installed.

public isWebsiteInstalled() : bool
Return values
bool

getBin()

Validate and return the path to given bin.

protected getBin(string $name) : string
Parameters
$name : string

The bin to look for.

Tags
throws
TaskException
Return values
string —

The bin path.

getBinPath()

Return the path to given bin.

protected getBinPath(string $name) : string
Parameters
$name : string
Return values
string —

The path to given binary.

getConfigValue()

Return the configuration value.

protected getConfigValue(string $key[, mixed|null $default = null ]) : mixed|null
Parameters
$key : string

The config item to look up.

$default : mixed|null = null

Default configuration value for the key item if neither has value nor exists.

Return values
mixed|null —

The configuration value.

getNodeBin()

Validate and return the path to given bin from node packages.

protected getNodeBin(string $name) : string
Parameters
$name : string

The bin to look for.

Tags
throws
TaskException
Return values
string —

The bin path.

getNodeBinPath()

Return the path to given bin from node packages.

protected getNodeBinPath(string $name) : string
Parameters
$name : string
Return values
string —

The path to given binary.

isJunit()

Check whether Junit option is being used, or env var is set.

protected isJunit() : bool
Return values
bool

isSimulating()

Check if current command is being executed with option simulate.

protected isSimulating() : bool
Return values
bool —

True if using --simulate, false otherwise.

taskExecute()

Execute a command.

protected taskExecute(array<string|int, string> $tasks) : CollectionBuilder
Parameters
$tasks : array<string|int, string>

An array with tasks to execute.

Return values
CollectionBuilder —

The task executed.

taskProcess()

Process the file.

protected taskProcess(string $source[, string $destination = '' ]) : ReplaceBlock|CollectionBuilder
Parameters
$source : string

The source file to process.

$destination : string = ''

The destination file.

Return values
ReplaceBlock|CollectionBuilder —

The file task processed.

taskReplaceBlock()

Replace block in a file.

protected taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder
Parameters
$filename : string = ''

The file to process.

Return values
ReplaceBlock|CollectionBuilder —

The file replaced.

convertHookToMethod()

Converts a hook name to method name.

private convertHookToMethod(string $hook) : false|string
Parameters
$hook : string

The hook name to convert.

Return values
false|string —

The converted hook name, i.e: the pre-push becomes runPrePush, FALSE if empty hook provided.

getAvailableHooks()

Return the available hooks from Toolkit and Project.

private getAvailableHooks() : array<string|int, string>
Return values
array<string|int, string> —

A list of available hooks.

getHookFiles()

Return the hooks present in given directory.

private getHookFiles(string $directory) : array<string|int, string>
Parameters
$directory : string

The directory to check for hooks.

Return values
array<string|int, string> —

An array keyed by hook name and path as value, false if do not exist.

runCommitMsg()

Hook: Executes the commit-msg conditions.

private runCommitMsg(ConsoleIO $io) : int
Parameters
$io : ConsoleIO
Return values
int —

The commit-msg hook status.

runPreCommit()

Hook: Executes the PHPcs against the modified files.

private runPreCommit(ConsoleIO $io) : int
Parameters
$io : ConsoleIO
Return values
int —

The phpcs pre-commit hook status.

runPrePush()

Hook: Executes the pre-push commands.

private runPrePush(ConsoleIO $io) : int
Parameters
$io : ConsoleIO
Return values
int —

The pre-push hook status.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results