Extending Composer

www.easybib.com [email protected]
Extending Composer
Make composer do all the things.

View Slide

Till
I’m Till Klampäckel. Good to meet you.
@klimpong
http://github.com/till
http://till.klampaeckel.de/

View Slide

ImagineEasy Solutions LLC
We are an information literacy company.
What is information literacy?

View Slide

Commercial break
Some rights reserved by claire.whitehouse
http://www.ﬂickr.com/photos/citysnidget/

View Slide

EasyBib.com
EasyBib is an citation management platform. 40 million students use EasyBib every year.
Over 1000 institutions subscribe, including 100 large US universities and 900 high schools
and districts.

View Slide

ResearchReady.com
ResearchReady teaches information literacy skills in a core curriculum. Universities and
districts subscribe to give their students a research skill boost. Launched in January 2013.

View Slide

Anyway
There is always more.
But that’s not what I’m here for.

View Slide

Composer
• Dependency management.
• Composer is extendable.

View Slide

Extending Composer
• In the beginning, there were custom installers.
• Some examples:
• custom installers for frameworks
• custom installers for software
• custom installers for assets and related

View Slide

[email protected]
www.easybib.com
You want moar?

View Slide

Composer Plugins
• From custom installers came plugins.

View Slide

Some very gut advice
• Open source project management pro tip!
• Add a plugin API so you don’t need to maintain
what users are doing.
• Second pro tip: don’t break the plugin API.

View Slide

Composer Plugins
{
“name”: “till/fancy-plugin”,
“license”: “BSD-2-Clause”,
“type”: “composer-plugin”,
“require”: {
“composer-plugin-api”: “1.0.0”
},
“extra”: {
“class”: “till\\Composer\\ExamplePlugin”
}
}

View Slide

Composer Plugins
namespace till\Composer;
use Composer\Composer, Composer\IO\IOInterface,
Composer\Plugin\PluginInterface, Composer\Plugin\PluginEvents,
Composer\Plugin\CommandEvent;
class ExamplePlugin implements PluginInterface
{
protected $c, $io;
public function activate(Composer $c, IOInterface $io) {
$this->c = $c; $this->io = $io;
}
public static function getSubcribedEvents() {
return array(PluginEvents::COMMAND => array(array(‘onCommand’, 0)));
}
public function onCommand(CommandEvent $e) {
/* ... */
}
}

View Slide

Composer Plugin Events
• Events live in Composer\Plugin\PluginEvents.
• COMMAND
• PRE_FILE_DOWNLOAD

View Slide

It’s so simple.

View Slide

Wait, just two?
• Currently two events are available.
• If you need another event, let’s add it.
• Example implementations
• composer-aws:
https://github.com/naderman/composer-aws
• composer-newrelic:
https://github.com/easybiblabs/composer-newrelic

View Slide

Go write a plugin. Now.

View Slide

Don’t forget.
Publish code. —

View Slide

Wait!

View Slide

Global
• `./composer.phar global install|update|require`
• I don’t want to talk about it too much:
http://getcomposer.org/doc/03-cli.md#global
• Install plugins globally:
./composer.phar global require till/fancy-plugin:dev-master

View Slide

Questions?

View Slide

Extending Composer

Extending Composer

Till Klampaeckel

More Decks by Till Klampaeckel

Other Decks in Technology

Featured

Transcript