Provides functionality to merge and synchronize .gitignore files.
Description
This command merges the canonical .gitignore from dev-tools with the project's existing .gitignore, removing duplicates and sorting entries.
The command accepts two options: --source and --target to specify the paths to the canonical and project .gitignore files respectively.
'gitignore'
'Merges and synchronizes .gitignore files.'
"This command merges the canonical .gitignore from dev-tools with the project's existing .gitignore."
Properties
Methods
Creates a new GitIgnoreCommand instance.
Configures the current command.
Executes the gitignore merge process.
Computes the absolute path for a given relative or absolute path.
Determines the correct absolute path to a configuration file.
Retrieves the current working directory of the application.
Resolves the absolute path to a file within the fast-forward/dev-tools package.
Configures and executes a registered console command by name.
Executes a given system process gracefully and outputs its buffer.
protected
Filesystem
$filesystem
private
MergerInterface
$merger
private
ReaderInterface
$reader
private
WriterInterface
$writer
Creates a new GitIgnoreCommand instance.
public
__construct(MergerInterface
$merger, ReaderInterface
$reader, WriterInterface|null
$writer, Filesystem
$filesystem) : mixed
Parameters
Description
the merger component
Description
the reader component
Description
the writer component
$filesystem
:
Filesystem
Description
the filesystem component
Configures the current command.
protected
configure() : void
Description
This method MUST define the name, description, and help text for the command. It SHALL identify the tool as the mechanism for script synchronization.
Executes the gitignore merge process.
protected
execute(InputInterface
$input, OutputInterface
$output) : int
Parameters
$input
:
InputInterface
Description
the input interface
$output
:
OutputInterface
Description
the output interface
Return values
Description
the status code
Computes the absolute path for a given relative or absolute path.
protected
getAbsolutePath(
string
$relativePath) : string
Description
This method MUST return the exact path if it is already absolute. If relative, it SHALL make it absolute relying on the current working directory.
Parameters
$relativePath
:
string
Description
the path to evaluate or resolve
Return values
Description
the resolved absolute path
Determines the correct absolute path to a configuration file.
protected
getConfigFile(
string
$filename[,
bool
$force = false]) : string
Description
The method MUST attempt to resolve the configuration file locally in the working directory. If absent and not forced, it SHALL provide the default equivalent from the package itself.
Parameters
$filename
:
string
Description
the name of the configuration file
$force
:
bool
=
false
Description
determines whether to bypass fallback and forcefully return the local file path
Return values
Description
the resolved absolute path to the configuration file
Retrieves the current working directory of the application.
protected
getCurrentWorkingDirectory() : string
Description
The method MUST return the initial working directory defined by the application. If not available, it SHALL fall back to the safe current working directory.
Return values
Description
the absolute path to the current working directory
Resolves the absolute path to a file within the fast-forward/dev-tools package.
protected
getDevToolsFile(
string
$filename) : string
Description
This method uses Composer's InstalledVersions to determine the installation path of the fast-forward/dev-tools package and returns the absolute path to the given filename within it. It is used as a fallback when a configuration file is not found in the project root.
Parameters
$filename
:
string
Description
the name of the file to resolve within the dev-tools package
Return values
Description
the absolute path to the file inside the dev-tools package
Configures and executes a registered console command by name.
protected
runCommand(
string
$command, OutputInterface
$output) : int
Description
The method MUST run the specified command with the provided input and output interfaces.
Parameters
$command
:
string
Description
the commandline name of the command to execute
$output
:
OutputInterface
Description
the interface for buffering output
Return values
Description
the status code resulting from the dispatched command
Executes a given system process gracefully and outputs its buffer.
protected
runProcess(Process
$command, OutputInterface
$output[,
bool
$tty = true]) : int
Description
The method MUST execute the provided command ensuring the output is channeled
to the OutputInterface. It SHOULD leverage TTY if supported. If the process
fails, it MUST return self::FAILURE; otherwise, it SHALL return self::SUCCESS.
Parameters
$command
:
Process
Description
the configured process instance to run
$output
:
OutputInterface
Description
the output interface to log warnings or results
$tty
:
bool
=
true
Return values
Description
the status code of the command execution