Säveltäjä WordPressille, osa 2

Viimeisin päivitys marras 13, 2022

Sisältö

Tässä viestissä päätän sen, mitä aloin jakaa eilen: Käytän Composerin kanssa jakamiani työkaluja ja kirjastoja haistamaan sitoumuksiasi kehityksen aikana ennen kuin koodi osuu arkistoon.

Ihannetapauksessa haluat aina nähdä jotain tällaista terminaalissasi aina, kun sitoudut koodiin:

Mutta näin ei aina ole. Kuten useimmissa asioissa, mitä enemmän harjoittelet, sitä enemmän totut kirjoittamaan koodia, joka välittää automaattisesti eri sääntöjen (ja niiden mukautusten) kautta asetetut haisut.

Ennen kuin teet sen, sinun on kuitenkin määritettävä GrumPHP arkistossasi.

WordPressin säveltäjä: Sniffing Commits

Eilen annoin näytteen, composer.json joten tänään tarkastelemme mallia GrumPHP-määritystiedostosta ja katsomme, mitä kukin osa tekee.

Tärkeää on huomata, että vaikka jotkut näkemäsi sisällöstä eivät ole epätyypillisiä projektille, voit hienosäätää tätä niin paljon kuin haluat jokaisessa käyttämässäsi projektissa. Joskus saatat haluta sen olevan keskittyneempi kuin nyt; toisinaan et ehkä välitä joistakin sen tarjoamista nuuskimista.

Alkukokoonpano

Kuitenkin, kun GrumPHP on asennettu, se luo lähes tyhjän grumphp.ymltiedoston, joka on valmis määritettäväksi. Esimerkiksi tämä sinun pitäisi nähdä :


parameters:
    git_dir:. bin_dir: vendor/bin
    tasks:

Huomaa, että siinä ei ole muuta kuin täsmentäminen:

arkiston sijainti,
Composerin kautta asennettujen binaarien sijainti,
suoritettavat tehtävät.

Huomaa, että olen aina käyttänyt "." arkiston sijaintiin, koska en ole koskaan asentanut sitä työskentelemääni arkistoon.

Sama koskee Composer-binääriä. Eli kun olen asentanut kaiken Composerin kautta, jätän ne alkuperäisille paikoilleen.

Ja lopuksi, alkuperäinen tasksohje on tyhjä, koska mitään ei ole vielä suoritettavaa. Sitä tarkastelen seuraavassa vaiheessa.

GrumPHP:n asetukset

Kun olet asentanut kirjastosi ja olet valmis tekemään asetuksia, voit ehkä tehdä jotain tämän kaltaista :


parameters:
    git_dir:. bin_dir: vendor/bin
    tasks:
      securitychecker:
      composer:
      jsonlint:
      xmllint:
      yamllint:
      phpstan:
      phplint:
      phpunit:
      phpcs:
      phpcpd:
      phpmnd:
      phpparser:
        visitors:
          no_exit_statements: ~
          never_use_else: ~
          forbidden_function_calls:
            blacklist:
              - "die"
              - "var_dump"
              - "exit"
      phpversion:
        project: '7.0'
       phpmd:
         ruleset: ['phpmd.xml.dist']

En hahmottele kaikkea yllä (koska siinä ei ole paljon hahmoteltavaa), mutta muutamia asioita on silti huomautettava:

Huomaa, että tehtävistä on paljon pidempi luettelo kuin alkuperäisessä hakemistossa määritetty. Se on normaalia, ja se tarkoittaa, että haluamme käyttää näitä työkaluja käyttämällä kunkin työkalun oletusasetuksia.
Muutamista säännöistä on ~vierekkäin. Tämä riippuu kyseessä olevasta tehtävästä, mutta tämä tarkoittaa yleensä sitä, että haluamme käyttää oletuskokoonpanoa.
On tehtäviä, kuten phpparseralitehtäviä. Jotkut niistä, kuten yllä näet, käyttävät oletuskäyttäytymistä. Toiset valitsevat mustalle listalle termit, kuten die, var_dump, exit, ja muut. Tämä tarkoittaa, että ikään kuin ohje ei olisi tarpeeksi selkeä, saamme GrumPHP:n epäonnistumaan, jos jokin näistä lauseista havaitaan.
Katso samalla tavalla phpmd. Tämä viittaa sääntöihin, joita käytämme etsiessämme erilaisia sotkuja koodista. Tässä tapauksessa se osoittaa dist tiedostoon, mutta voi osoittaa mitä tahansa määrittämääsi mukautettua sääntöjoukkoa.

Tämä on vain esimerkki siitä, mitä voit tehdä GrumPHP:llä. Eli voit asentaa joitain kirjastoja Composerin kautta, asentaa ne ja sitten räätälöidä GrumPHP:tä niin, että hyödynnät sen tarjoamia toimintoja.

Kuten muissakin vastaavissa projekteissa, suosittelen lukemaan dokumentaation, joka on olemassa eri tehtävistä, jotka integroidaan GrumPHP:hen.

Onko tämä Composer for WordPress?

Kyllä ja ei. Composer on yleiskäyttöinen paketinhallinta PHP-projekteille; Emme kuitenkaan näytä näkevän sitä juurikaan WordPressin maailmassa. Tämä ei tarkoita sitä, ettei sitä käytetä (on), mutta pelkkä Composerin tunteminen ja sen käyttö ei riitä.

Sen sijaan mielestäni on tärkeää osata käyttää Composeria WordPressille, jotta voimme kirjoittaa mahdollisimman korkealaatuista koodia ja samalla varmistaa, että noudatamme kaikkia koodausstandardeja, joita olemme myös valinneet. .

: tommcfarlin.com