Compositore per WordPress, parte 1

Ok, quindi dopo aver parlato di tutte le varie librerie che possono aiutare a migliorare la qualità del codice del tuo lavoro, solleva ancora una domanda:

Come possiamo far funzionare questi progetti sulla nostra base di codice?

In breve, richiede Composer. Se non l’hai mai usato, ne ho già scritto brevemente prima, ma intendo fornire le basi di ciò che ti serve per iniziare a usarlo e le librerie di cui sopra nel tuo lavoro.

Sia in questo post che nel prossimo, condividerò come impostare tutto localmente nella forma più semplice e quindi come si integra con Git in modo che tu possa iniziare a usarlo nella tua quotidianità.

Configurazione del compositore per WordPress

Ci sono molte informazioni che possono (e direi che dovrebbero entrare in un file per Composer). Ciò include cose come informazioni sull’autore, PSR, informazioni, ecc. Ma questo va davvero oltre lo scopo di questo post. Invece, voglio condividere il minimo indispensabile su come ottenere e configurare queste informazioni.

Una directory di esempio

Supponiamo che per un momento stai per iniziare a lavorare su un plugin o qualcosa relativo a WordPress che richiederà le varie librerie discusse nella serie precedente. E quando imposti la directory per questo, avrai pochissimi file. Possano un paio di file PHP vuoti, risorse, ecc. Forse sarà simile a questo:

Certo, l’esempio sopra è già un po’ più avanti di come potrebbe essere il tuo lavoro perché:

• C’è un composer.lock file che mostra che Composer è stato eseguito,
• Ha una vendor directory che mostra che le librerie sono state installate tramite Composer,
• C’è un grumphp.yml file che definisce come GrumPHP dovrebbe funzionare (e lo tratterò più avanti) durante lo sniffing del codice.

Ma il succo di quanto sopra è lo stesso: hai composer.jsone definisce e include tutto ciò di cui abbiamo bisogno in base al post precedente. Allora come lo configuriamo?

Configurare il compositore

Innanzitutto, devi avere un’idea di come strutturare il tuo plug-in. Ad esempio, ho una configurazione di plug-in come questa:

• Tutti i file PHP risiedono nella src directory,
• Tutti i file CSS, JavaScript, immagini, ecc. si trovano nella assets directory,
• La vendor directory è per le cose che sono installate tramite Composer,
• views è ciò che viene utilizzato nel front-end del progetto.

Per esempio:

In secondo luogo, nella directory in questione, ti consigliamo di creare un file chiamato composer.json. Questo può essere fatto tramite Terminale semplicemente emettendo un touch comando, oppure puoi crearlo nel tuo IDE.

La cosa importante da togliere a questo è che c’è una src directory perché quella è la directory che include i nostri file PHP ed è la directory che vogliamo annusare.

Un file compositore di base

Detto questo, ecco un composer.jsonfile di base che puoi utilizzare nei tuoi progetti in base alle serie precedenti e in base a ciò che è condiviso di seguito:

{
  "name": "pressware/demo-wordpress-plugin",
  "description": "This file is used to show how to configure a WordPress plugin using Composer.",
  "autoload": {
    "psr-4": {
      "Pressware": "src/"
    }
  },
  "require-dev": {
    "phpro/grumphp": "^0.11.6",
    "phpmd/phpmd": "^2.6",
    "phpunit/phpunit": "5.7.21",
    "nikic/php-parser": "^3.0",
    "sebastian/phpcpd": "^3.0",
    "povils/phpmnd": "^1.1",
    "squizlabs/php_codesniffer": "^3.0",
    "jakub-onderka/php-parallel-lint": "^0.9.2",
    "sensiolabs/security-checker": "^4.0"
  }
}

Guardando il file sopra, ecco come analizzarlo:

1. Le righe 2 e 3 danno un po’ di descrizione di cosa tratta il plugin. Queste sono anche altre aree in questo file per fornire maggiori informazioni su ciò che deve essere fatto.
2. Le righe da 4 a 8 sono importanti perché spiegano che stiamo usando PSR-4 per il caricamento automatico e che tutti i file rientrano nello spazio dei nomi di primo livello Presswaree che i file PHP si trovano nella src directory.
3. Le righe 9 – 18 coprono tutti i fascicoli trattati nella serie precedente.

Quindi, immetti il ​​seguente comando nel tuo terminale:

$ composer install

E questo installerà questi pacchetti.

Che dire dei commit?

Per assicurarti di eseguire correttamente lo snuffing e la gestione dei commit, è importante configurare GrumPHP in modo che guardi i file. Ma ci darò un’occhiata nel prossimo post.

Nel frattempo, forse questa è una buona opportunità per configurare un plug-in demo ed esercitarsi con il codice sopra. Prepararlo correttamente la prima volta può essere difficile. Fortunatamente, molti degli errori di output sono davvero facili da capire, quindi è relativamente semplice risolverli.