Generates and synchronizes CODEOWNERS files from local project metadata.
'codeowners'
'Generates .github/CODEOWNERS from local project metadata.'
'This command infers CODEOWNERS entries from composer.json metadata, falls back to a commented template, and supports drift-aware preview and overwrite flows.'
Interfaces
Defines the logger contract consumed by reusable command result helpers.
Properties
Methods
Creates a new command instance.
Adds the standard JSON output options to the current command.
{@inheritDoc}
Generates or updates the CODEOWNERS file.
Determines whether JSON output was requested.
Determines whether pretty JSON output was requested.
Logs a failed command result and returns the failure exit code.
Logs an informational command message at notice level.
Prompts for CODEOWNERS entries when metadata inference is insufficient.
Prompts whether the generated CODEOWNERS file should be written.
Logs a successful command result and returns the success exit code.
private
FileDiffer
$fileDiffer
private
FilesystemInterface
$filesystem
private
CodeOwnersGenerator
$generator
private
LoggerInterface
$logger
Creates a new command instance.
public
__construct(CodeOwnersGenerator
$generator, FilesystemInterface
$filesystem, FileDiffer
$fileDiffer, LoggerInterface
$logger) : mixed
Parameters
Description
the generator used to infer and render CODEOWNERS contents
Description
the filesystem used to read and write the target file
Description
the differ used to report managed-file drift
$logger
:
LoggerInterface
Description
the output-aware logger
Adds the standard JSON output options to the current command.
protected
addJsonOption() : static
Return values
{@inheritDoc}
protected
configure() : void
Generates or updates the CODEOWNERS file.
protected
execute(InputInterface
$input, OutputInterface
$output) : int
Parameters
$input
:
InputInterface
Description
the command input
$output
:
OutputInterface
Description
the command output
Return values
Description
the command status code
Determines whether JSON output was requested.
protected
isJsonOutput(InputInterface
$input) : bool
Description
The pretty-json flag SHALL imply JSON output.
Parameters
$input
:
InputInterface
Return values
Determines whether pretty JSON output was requested.
protected
isPrettyJsonOutput(InputInterface
$input) : bool
Parameters
$input
:
InputInterface
Return values
Logs a failed command result and returns the failure exit code.
private
failure(
string
$message, InputInterface
$input[,
array<string, mixed>
$context = []][,
string|null
$file = null][,
int|null
$line = null]) : int
Parameters
$message
:
string
Description
the failure message
$input
:
InputInterface
Description
the originating command input
$context
:
array<string, mixed>
=
[]
Description
optional extra log context
$file
:
string|null
=
null
Description
the related file path when known
$line
:
int|null
=
null
Description
the related line when known
Return values
Logs an informational command message at notice level.
private
notice(
string
$message, InputInterface
$input[,
array<string, mixed>
$context = []]) : void
Parameters
$message
:
string
Description
the notice message
$input
:
InputInterface
Description
the originating command input
$context
:
array<string, mixed>
=
[]
Description
optional extra log context
Prompts for CODEOWNERS entries when metadata inference is insufficient.
private
promptForOwners() : array<int, string>
Return values
Prompts whether the generated CODEOWNERS file should be written.
private
shouldWriteCodeOwners(
string
$targetPath) : bool
Parameters
$targetPath
:
string
Description
the target file path
Return values
Description
true when the write SHOULD proceed
Logs a successful command result and returns the success exit code.
private
success(
string
$message, InputInterface
$input[,
array<string, mixed>
$context = []][,
string
$logLevel = LogLevel::INFO]) : int
Parameters
$message
:
string
Description
the success message
$input
:
InputInterface
Description
the originating command input
$context
:
array<string, mixed>
=
[]
Description
optional extra log context
$logLevel
:
string
=
LogLevel::INFO
Description
the PSR-3 log level used for the successful result