Developing Laravel Packages with Local Composer Dependencies

Tutorials

May 9th, 2018

composer-local-laravel-package-development.png

Developing Composer packages locally through a local file symlink speeds up development immensely when you want to create Laravel packages and try them out on a real application. I was reading about a fancy bash alias by Caleb Porzio, which is a bash alias inspired by npm link.

I have been working on improving my local workflow for taking a Laravel package from development to release, and I often find myself installing my dependency through the GitHub repo, and then continue running composer update over and over as I update things because I am lazy.

I thought I’d document my workflow for developing new and existing Laravel packages and running them in a real Laravel application, all locally.

Package Setup

I am going to walk you through creating a quick Composer package from scratch and adding a service provider. I know a couple of package developers that use a boilerplate repository as a starting point for PHP and Laravel packages (see Spatie’s PHP Skeleton for inspiration).

First, let’s create an example composer project and hook up a Laravel service provider. I like to start my code from ~/code so update to whatever you use:

1cd ~/code
2mkdir example-pkg
3cd example-pkg/
4mkdir src/
5composer init
6# Walk through the prompts to init...

After you generate the composer.json file, let’s add a few things for autoloading and automatic service providers:

1{
2 "name": "paul/example-package",
3 "authors": [
4 {
5 "name": "Paul Redmond",
6 "email": "paul@example.com"
7 }
8 ],
9 "autoload": {
10 "psr-4": {
11 "ExamplePackage\\": "src/"
12 }
13 },
14 "require": {},
15 "extra": {
16 "laravel": {
17 "providers": [
18 "ExamplePackage\\ExamplePackageServiceProvider"
19 ]
20 }
21 }
22}

Last, let’s create a skeleton service provider:

1<?php
2
3namespace ExamplePackage;
4
5use Illuminate\Support\ServiceProvider;
6
7class ExamplePackageServiceProvider extends ServiceProvider
8{
9 public function boot()
10 {
11 # code...
12 }
13
14 public function register()
15 {
16 # code...
17 }
18}

Linking Your Package to a Laravel Project

Now that we have a local composer project that we can use to start developing a new Laravel package, let’s create a demo Laravel app to link our example package up using a local file path:

1cd ~/code
2laravel new laravel-demo
3cd laravel-demo

I encourage you to check out Caleb Portzio’s bash alias, but here’s the static command you would need to link up your local repository:

1composer config repositories.local '{"type": "path", "url": "../example-pkg"}' --file composer.json

Next, we need to run composer require to add the local repository as a dependency. Remember to use the "name" key you defined in the example-package composer file:

1composer require paul/example-package
2
3Using version dev-master for paul/example-package
4./composer.json has been updated
5Loading composer repositories with package information
6Updating dependencies (including require-dev)
7Nothing to install or update
8Generating optimized autoload files
9> Illuminate\Foundation\ComposerScripts::postAutoloadDump
10> @php artisan package:discover
11Discovered Package: fideloper/proxy
12Discovered Package: laravel/tinker
13Discovered Package: nunomaduro/collision
14Discovered Package: paul/example-package
15Package manifest generated successfully.

You can see that our package was discovered through the "extra" key in the composer.json file, sweet!

If you check the filesystem, you’ll notice that the package is symlinked, which means you can continue to develop on the package locally and immediately try it out in a demo project:

1cd ~/code/laravel-demo
2ls -la vendor/paul
3total 0
4.
5..
6example-package -> ../../../example-pkg

Now you have an excellent way to develop Laravel packages locally alongside a Laravel application! Thank you Caleb for the fantastic alias!

Filed in:

Paul Redmond

Full stack web developer. Author of Lumen Programming Guide and Docker for PHP Developers.