Guida a Composer gestore di dipendenze standard per l'ecosistema: Biblioteche
Questo capitolo ti spiegherà come rendere la tua libreria installabile tramite Composer.
Ogni progetto è un pacchetto#
Non appena si crea un file composer.jsonin una directory, quella directory diventa un pacchetto. Quando si aggiunge un file requirea un progetto, si crea un pacchetto che dipende da altri pacchetti. L'unica differenza tra il progetto e una libreria è che il progetto è un pacchetto senza nome.
Per rendere installabile quel pacchetto è necessario assegnargli un nome. Lo si fa aggiungendo la nameproprietà in composer.json:
{
"name": "acme/hello-world",
"require": {
"monolog/monolog": "1.0.*"
}
}
In questo caso il nome del progetto è acme/hello-world, dove acmeè il nome del fornitore. Fornire il nome del fornitore è obbligatorio.
Nota: se non sai quale nome utilizzare come fornitore, il tuo nome utente di GitHub è solitamente una buona opzione. I nomi dei pacchetti devono essere in minuscolo e la convenzione prevede l'uso di trattini per separare le parole.
Versioni della biblioteca#
Nella stragrande maggioranza dei casi, gestirai la tua libreria utilizzando un sistema di controllo di versione come git, svn, hg o fossil. In questi casi, Composer deduce le versioni dal tuo sistema di controllo di versione e non dovresti specificarne una nel tuo composer.jsonfile. (Consulta l' articolo sulle versioni per scoprire come Composer utilizza i branch e i tag del sistema di controllo di versione per risolvere i vincoli di versione.)
Se gestisci i pacchetti manualmente (ovvero senza un sistema di controllo versione), dovrai specificare esplicitamente la versione aggiungendo un versionvalore nel tuo composer.jsonfile:
{
"version": "1.0.0"
}
Nota: quando si aggiunge una versione codificata in modo statico a un sistema di controllo versione, la versione entrerà in conflitto con i nomi dei tag. Composer non sarà in grado di determinare il numero di versione.
Versioning VCS#
Composer utilizza le funzionalità di branch e tag del tuo sistema di controllo versione per risolvere i vincoli di versione specificati nel requirecampo e associarli a specifici set di file. Per determinare le versioni valide disponibili, Composer analizza tutti i tag e i branch e ne traduce i nomi in un elenco interno di opzioni, che poi confronta con il vincolo di versione fornito.
Per maggiori informazioni su come Composer gestisce i tag e i branch e su come risolve i vincoli di versione dei pacchetti, consulta l' articolo sulle versioni .
File di blocco#
Per la tua libreria, puoi includere il composer.lockfile nel commit, se lo desideri. Questo può aiutare il tuo team a testare sempre con le stesse versioni delle dipendenze. Tuttavia, questo file di blocco non avrà alcun effetto sugli altri progetti che dipendono da esso. Ha effetto solo sul progetto principale.
Se non vuoi confermare il file di blocco e stai usando git, aggiungilo al .gitignore.
Pubblicazione su un VCS#
Una volta che hai un repository VCS (sistema di controllo versione, ad esempio git) contenente un composer.jsonfile, la tua libreria è già installabile tramite Composer. In questo esempio pubblicheremo la acme/hello-worldlibreria su GitHub sotto github.com/username/hello-world.
Ora, per testare l'installazione del acme/hello-worldpacchetto, creiamo un nuovo progetto in locale. Lo chiameremo acme/blog. Questo blog dipenderà da acme/hello-world, che a sua volta dipende da monolog/monolog. Possiamo farlo creando una nuova blogdirectory da qualche parte, contenente un composer.json:
{
"name": "acme/blog",
"require": {
"acme/hello-world": "dev-master"
}
}
Il nome non è necessario in questo caso, poiché non vogliamo pubblicare il blog come una libreria. Viene aggiunto qui per chiarire di cosa composer.jsonsi sta parlando.
Ora dobbiamo dire all'app del blog dove trovare la hello-worlddipendenza. Lo facciamo aggiungendo una specifica del repository del pacchetto al blog composer.json:
{
"name": "acme/blog",
"repositories": [
{
"type": "vcs",
"url": "https://github.com/username/hello-world"
}
],
"require": {
"acme/hello-world": "dev-master"
}
}
Per maggiori dettagli sul funzionamento dei repository di pacchetti e sugli altri tipi disponibili, consultare la sezione Repository .
Questo è tutto. Ora puoi installare le dipendenze eseguendo installil comando di Composer!
Riepilogo: qualsiasi repository git/svn/hg/fossil contenente un composer.jsonpuò essere aggiunto al tuo progetto specificando il repository del pacchetto e dichiarando la dipendenza nel requirecampo.
Pubblicazione per il confezionamento#
Bene, ora puoi pubblicare i pacchetti. Tuttavia, specificare il repository VCS ogni volta è macchinoso. Non vorrai certo obbligare tutti i tuoi utenti a farlo.
Un'altra cosa che potresti aver notato è che non abbiamo specificato un repository di pacchetti per monolog/monolog. Come è stato possibile? La risposta è Packagist.
Packagist è il repository principale di pacchetti per Composer ed è abilitato di default. Tutto ciò che viene pubblicato su Packagist è automaticamente disponibile tramite Composer. Poiché Monolog si trova su Packagist , possiamo dipendere da esso senza dover specificare repository aggiuntivi.
Se volessimo condividerlo hello-worldcon il mondo, lo pubblicheremmo anche su Packagist.
Visita Packagist e clicca sul pulsante "Invia". Ti verrà chiesto di registrarti, se non l'hai già fatto, e potrai quindi inviare l'URL del tuo repository VCS. A quel punto, Packagist inizierà a scansionarlo. Una volta completata la scansione, il tuo pacchetto sarà disponibile a tutti!
Pacchetti di distribuzione leggeri#
Alcune informazioni superflue, come la .githubdirectory, esempi di grandi dimensioni, dati di test, ecc., in genere non dovrebbero essere incluse nei pacchetti distribuiti.
Il .gitattributesfile è un file specifico di Git, come .gitignorequello presente nella directory principale della libreria. Sovrascrive la configurazione locale e globale ( rispettivamente .git/confige ~/.gitconfig) quando presente e tracciato da Git.
Da utilizzare .gitattributesper impedire che file indesiderati appesantiscano i pacchetti di distribuzione zip.
// .gitattributes
/demo export-ignore
phpunit.xml.dist export-ignore
/.github/ export-ignore
Eseguite una prova controllando manualmente il file zip generato:
git archive branchName --format zip -o file.zip
Nota: i file saranno comunque tracciati da Git, ma non saranno inclusi nella distribuzione zip. Questo funziona solo per i pacchetti installati da dist (ovvero le release con tag) provenienti da GitHub, GitLab o Bitbucket.

Commenti
Posta un commento