Support simple Composer-based Command plugin mechanism #604
Conversation
greg-1-anderson
force-pushed
the
plugin-commands
branch
from
acd8df8
to
c8f4ed8
Compare
|
This implements a plugin scheme based on the idea of @thom8 in acquia/blt#1793. The examples RoboFile has been repackaged as an example Robo plugin. |
|
The command plugin commandfile collection code should be factored out of the runner; beyond that, though, this is pretty simple and works well. |
|
Another alternative would be to use something like Flex, but that would be a lot more heavyweight. We could also consider using a "files" autoload entry in each plugin, and have each plugin register itself at autoload time. This would require declaring a global function with a static or global variable, or use a singleton to cache the registered classes. The implementation in this PR seems better to me than that, though. |
| * 2. Add command files to the specified directory. The command files must | ||
| * have names ending `Commands.php`. They must either be immediately | ||
| * inside the directory specified in the psr-4 autoload section, or they | ||
| * may be anywhere inside a directory named `Commands`. |
There was a problem hiding this comment.
You can put hooks in any command file. If you prefer, we could also define a default naming convention for files that are intended to have only hooks in them.
Note, however, that there is no difference in behavior between command files and hook files; you could put commands in hook files, or visa-versa.
|
Testing here: https://github.com/acquia/blt/pull/1821/files |
src/Runner.php
Outdated
| } | ||
|
|
||
| $discovery = new CommandFileDiscovery(); | ||
| $discovery->setSearchLocations(['Commands']); |
There was a problem hiding this comment.
@grasmash Would it make things better for your use cases if the search locations could be altered via a method call that specified the locations? Alternately, we could factor this out into a separate class, and you could call it explicitly with the CommandFileDiscovery object of your choice.
|
|
||
| protected function getPluginCommandClasses() | ||
| { | ||
| $commandClasses = []; |
There was a problem hiding this comment.
Would you mind making this method public? That way, an application that leverages robo can call it and build its own command classes. You may also want to consider making getRoboFileCommands() public as well.
There was a problem hiding this comment.
Yes and no. I don't think it would be good for folks to be calling methods of the runner to do this, but we could provide a plugin discovery class that provided this service. Then Runner could use the new class.
greg-1-anderson
force-pushed
the
plugin-commands
branch
from
2a6e363
to
3b5832c
Compare
…SR-4 autoload namespace.
greg-1-anderson
force-pushed
the
plugin-commands
branch
from
3b5832c
to
1fff0b3
Compare
|
I'm really looking forward to this feature. Is there any further momentum that can be made with this? Looking at the TravisCI report the issue was with a PHP |
|
See alternate implementation in #671 |
based on the PSR-4 autoload namespace.
Overview
This pull request:
Summary
Simple command plugin mechanism.