README

Vejamos a criação, a publicação no Packagist.org e a instalação e publicação do pacote num aplicativo Laravel.

Pacotes/packages

Um package no laravel estende as funcionalidades dos aplicativos sem alterar o código dos mesmos. Com um pacote podemos adicionar um simples pacote até praticamente outro aplicativo, contendo models, controllers, migrations, rotas, e mais ao aplicativo existente. Aqui mostro apenas um pequeno pacote que empacota um pequeno comando com uma mensagem, mas que pode ser usado para criar algo mais útil. Ao final passo sugestões de pacotes bem mais úteis.

Boa leitura

https://ashallendesign.co.uk/blog/8-essential-questions-to-ask-before-using-a-laravel-package

Cenário/Planejamento

Vamos criar um pequeno pacote, que basicamente tem um command que ao ser executado mostra a mensagem "Hello World"

URL deste projeto

https://github.com/ribafs/hello-world-package-laravel

Criação

Aqui estou oferecendo duas formas de criação do pacote:

From scratch. Para isso veja o exemplo Inspire
Usando o gerador online

Usarei o gerador que me entrega a estrutura básica pronta

Criando a estrutura básica

Para isso acesso o gerador em

https://laravelpackageboilerplate.com/

Rolo um pouco a tela e preencho o formulário com os dados do pacote que desejo:

Ele já vem com pacote Laravel selecionado por default.

Preenchendo o form. Adapte para seus dados

Vendor Name - ribafs
Package Name - hello-world
Author Name - Ribamar FS
Author E-Mail - ribafs@gmail.com
Package Description - Pequeno pacote para a criação de pacotes para o Laravel 9

Então clico em "Download my package" e salvo o pacote.

Com isso ele me gera a estrutura básica de um pacote laravel, já com o

composer.json
src/ViewMaker.php
src/ViewMakerFacade.php
src/ViewMakerServiceProvider.php
README.md
E outros

Então descompacto em alguma pasta.

Customizando a estrutura básica

Criar o comando helloWorld

cd packagesLaravel

php artisan make:command helloWorld

Será criado em

app/Console/Commands
 
nano helloWorld.php

Edite e deixe assim:

<?php
namespace App\Console\Commands;

use Illuminate\Console\Command;

class helloWorld extends Command
{
    protected $signature = 'hello:world';

    protected $description = 'Pequeno comando para demonstração sobre a criação de comandos no laravel 9';

    public function handle()
    {
        return $this->info(PHP_EOL.'Olá Mundo dos pacotes no Laravel 9 '.PHP_EOL);
    }
}

Executar o comando criado pelo pacote

php artisan hello:world

Agora iremos adicionar este pequeno comando ao nosso pacote

Criar a pasta

src/Commands

Então copiamos

app/Console/Commands/helloWorld.php para a pasta src/Commands do pacote

Adicionando o comando ao Service Provider

Edite no pacote hello-world

src/HelloWorldServiceProvider.php

O método boot()

    public function boot()
    {
            ...

            // Publishing the command.
            $this->publishes([
                __DIR__.'/Commands' => app_path('Console/Commands'),
            ], 'commands');
...

Isso fará com que após a instalação deste pacote, ao publicar ele faça uma cópia do comando helloWorld da pasta do pacote para a respectiva pasta do aplicativo.

Sobre o Service Provider

Veja que o ServiceProvider é a peça principal de um package laravel. Em nosso caso, ao criar o pacote com um gerador, já recebemos com algum código comentado, onde no método boot() podemos copiar arquivos do pacote para o aplicativo. Basta descomentar o código comentado e adaptar, como eu fiz.

Publicando nosso pacote no Packagist.org

Enxugando o composer.json

Removi o require-dev e deixei assim:

...
    ],
    "require": {
        "php": "^7.4|^8.0"
    },
...

Hospedar no Github

Mudei o composer.json para que fique mais coerente:

    "name": "ribafs/hello-world-package-laravel",

E hospedei no Github em:

https://github.com/ribafs/hello-world-package-laravel

Acessei o Packagist.org

https://packagist.org

E publiquei e habilitei a atualização automática.

Agora irei criar o primeiro release do repositório para facilitar a instalação pelos users via composer.

Criei o release 1.0

Instalando o pacote localmente

Após criar um aplicativo com laravel acesso sua pasta e executo

composer require ribafs/hello-world-package-laravel

Publicar

php artisan vendor:publish --provider="Ribafs\HelloWorld\HelloWorldServiceProvider"

Veja as mensagens

Copying file [vendor/ribafs/hello-world-package-laravel/config/config.php] to [config/hello-world.php]
Copying directory [vendor/ribafs/hello-world-package-laravel/src/Commands] to [app/Console/Commands]

Veja que agora temos um novo comando

app/Console/Commands/HelloWorld.php

Que podemos executar com

php artisan hello:world

Observação

Claro que não terísmos todo este trabalho para mostrar apenas esta mensagem. O nosso objetivo foi o de criar um pequeno pacote/package e partindo dele podemos criar algo mais útil.

Criando forks de pacotes de terceiros e customizando

ACL para Laravel 9 - https://github.com/ribafs/laravel-acl

Gerador de CRUDs e APIs apra Laravel 9 - https://github.com/ribafs/crud-generator-appzcoder

Estes dois não foram criados por mim. São dois projetos dos quais gostei muito então criei fork deles e os customizei ao meu modo.

O primeiro implementa ACL em aplicativos laravel 9.

O segundo cria CRUDs de uma forma muito simples para aplicativos laravel 9. Também cria APIs.Como o original não detalha a criação de API eu elaborei um tutorial e coloquei no repositório.

Assim, tanto podemos criar nossos pacotes, quanto criar fork de bons projetos e os customizar, traduzindo, melhorando a documentação, corrigindo alguns erros, etc.

ribafs / hello-world-package-laravel

Maintainers

Details