imponeer/composer-custom-commands

This package is abandoned and no longer maintained. No replacement package was suggested.

Adds possibility to define console commands as composer commands with Symfony console component syntax

0.2.1 2020-08-13 12:00 UTC

Requires

• php: >=7.2
• composer-plugin-api: ^1.1
• imponeer/project-cached-code-generator-from-composer.json-data-base: ^0.1.3
• symfony/console: *

Requires (Dev)

• composer/composer: ^1.6

MIT

• Raimondas Rimkevičius

README

Composer Custom Commands

Composer plugin that adds a possibility to define console commands as composer commands with Symfony console component syntax.

Usage

To start using this plugin you need just to do 4 easy steps:

1. Add plugin into your composer project:

Easiest way to do that is to execute composer command from console:

composer require imponeer/composer-custom-commands

2. Create class that that implements new command

It should be look something like this:

namespace My\Commands;

use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Command\Command;

/**
 * Your new command
 */
class DummyCommand extends Command
{

	/**
	 * Here we can configure command name, options and arguments.
	 * We using here Symfony Command syntax.
	 */
	protected function configure()
	{

	}

	/**
	 * Execute command
	 *
	 * @param InputInterface $input STDInput
	 * @param OutputInterface $output SRDOutput
	 */
	protected function execute(InputInterface $input, OutputInterface $output)
	{

	}

}

3. Create or edit config section in projects composer.json and add there section custom-commands with commands key and add there PHP class names of commands that should be added to composer

This should look something like this:

{
	"name": "my-project",
	"description": "",
	"type": "project",
	"require": {
		"imponeer/composer-custom-commands": "*"
	},
	"license": "MIT",
	"authors": [
		{
			"name": "SomeBody SomeOne",
			"email": "[e-mail]"
		}
	],
	"autoload": {
		"psr-4": {
			"My\\": "src/"
		}
	},
	"extra": {
		"custom-commands": {
			"commands": [
				"My\\Commands\\DummyCommand"
			]
		}
	}
}

If you need that some script should be executed before every command (f.e. you need to define some constants), you can add there boot key with value that is filename relative from place where composer.json is.

In that case your composer.json should look similar to this:

{
	"name": "my-project",
	"description": "",
	"type": "project",
	"require": {
		"imponeer/composer-custom-commands": "*"
	},
	"license": "MIT",
	"authors": [
		{
			"name": "SomeBody SomeOne",
			"email": "[e-mail]"
		}
	],
	"autoload": {
		"psr-4": {
			"My\\": "src/"
		}
	},
	"extra": {
		"custom-commands": {
			"commands": [
				"My\\Commands\\DummyCommand"
			],
			"boot": "boot.php"
		}
	}
}

4. If you did everything correctly, you will be able to use new composer command that is embeded in your project.

How to contribute?

If you want to add some functionality or fix bugs, you can fork, change and create pull request. If you not sure how this works, try interactive GitHub tutorial.

If you found any bug or have some questions, use issues tab and write there your questions.