maslosoft/sitcom

Signals based console application wrapper

2.0.0 2023-05-11 15:25 UTC

This package is auto-updated.

Last update: 2024-05-11 17:28:59 UTC


README

Signals based console application wrapper

Latest Stable Version License Scrutinizer Code Quality Code Coverage

Quick Install

composer require maslosoft/sitcom

Documentation

Full Sitcom Documentation

Crucial Commands Combined

Sitcom allows you to collect all commands from scatterred application and make them available in common environment.

Sitcom allows you to call commands from many sources from one executable.

Note: Currently this will only work for self-contained commands. If command relies on it's application, it will not be provided to it.

To add command to sitcom add it via signals, here is example from hedron:

// Use statments skipped
class RenderTemplateCommand extends Symfony\Component\Console\Command\Command
{
	protected function configure()
	{
		// irrelevant
	}

	protected function execute(InputInterface $input, OutputInterface $output)
	{
		// irrelevant
	}
	
	/**
	 * @SlotFor(Maslosoft\Sitcom\Command)
	 * @param Maslosoft\Signals\Command $signal
	 */
	public function reactOn(\Maslosoft\Sitcom\Command $signal)
	{
		$signal->add($this, 'hedron');
	}

Call sitcom collect, this will generate command list.

Now call sitcom to list commands, here is the output:

   _____ _ __
  / ___/(_) /__________  ____ ___
  \__ \/ / __/ ___/ __ \/ __ `__ \
 ___/ / / /_/ /__/ /_/ / / / / / /
/____/_/\__/\___/\____/_/ /_/ /_/

Sitcom version 1.0.0

Usage:
 command [options] [arguments]

Options:
 --help (-h)           Display this help message
 --quiet (-q)          Do not output any message
 --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 --version (-V)        Display this application version
 --ansi                Force ANSI output
 --no-ansi             Disable ANSI output
 --no-interaction (-n) Do not ask any interactive question

Available commands:
 collect          Build a list of commands
 help             Displays help for a command
 list             Lists commands
hedron
 hedron:commit    Apply headers to all php classes
 hedron:preview   Show list of files to which headers will be applied
 hedron:show      Show how current template will look like