Avoin lähdekoodiHyödyllisiä sivustojaKehittäjä

Säveltäjä WordPressille, osa 1

Viimeisin päivitys marras 9, 2022

Sisältö

Okei, kun olet käynyt läpi kaikki erilaiset kirjastot, jotka voivat auttaa parantamaan työsi koodin laatua, herättää silti kysymyksen:

Miten saamme nämä projektit toimimaan koodipohjaamme vastaan?

Lyhyesti sanottuna se vaatii säveltäjän. Jos et ole koskaan käyttänyt sitä, olen kirjoittanut siitä lyhyesti aiemmin, mutta aion tarjota perusasiat siitä, mitä tarvitset, jotta voit aloittaa sen käytön ja edellä mainitut kirjastot työssäsi.

Sekä tässä että seuraavassa viestissä kerron, kuinka kaikki määritetään paikallisesti alkeellisimmassa muodossa ja kuinka se sitten integroituu Gitiin, jotta voit alkaa käyttää sitä jokapäiväisessä elämässäsi.

Composerin määrittäminen WordPressille

Siellä on paljon tietoa, joka voi (ja väittäisin, että pitäisi mennä Composer-tiedostoon). Tämä sisältää asioita, kuten tekijän tiedot, PSR, tiedot jne. Mutta se ei todellakaan kuulu tämän viestin soveltamisalaan. Sen sijaan haluan jakaa vähimmäisvaatimukset näiden tietojen määrittämisestä ja määrittämisestä.

Esimerkkihakemisto

Oletetaan, että olet hetkeksi aloittamassa WordPressiin liittyvää laajennusta tai jotain, joka vaatii edellisessä sarjassa käsiteltyjä kirjastoja. Ja kun määrität hakemiston tätä varten, sinulla on hyvin vähän tiedostoja. Saattaa olla pari tyhjää PHP-tiedostoa, omaisuutta jne. Ehkä se näyttää tältä:

Yllä oleva esimerkki on tosin jo hieman edellä siitä, miltä työsi saattaa näyttää, koska:

Siellä on composer.lock tiedosto, joka osoittaa, että Composer on suoritettu,
Siinä on vendor hakemisto, josta näkyy, että kirjastot on asennettu Composerin kautta,
On grumphp.yml tiedosto, joka määrittelee, kuinka GrumPHP:n pitäisi toimia (ja käsittelen tämän myöhemmin) koodia haistaessa.

Mutta yllä olevan asian ydin on sama: sinulla on composer.jsonja se määrittelee ja sisältää kaiken, mitä tarvitsemme edellisen viestin perusteella. Joten miten asetamme sen?

Säveltäjän asettaminen

Ensinnäkin sinulla on oltava idea siitä, miten aiot jäsentää laajennuksen. Minulla on esimerkiksi tällainen laajennusasetus:

Kaikki PHP-tiedostot sijaitsevat src hakemistossa,
Kaikki CSS, JavaScript, kuvat jne., tiedostot ovat assets hakemistossa,
Hakemisto vendor on tarkoitettu Composerin kautta asennetuille asioille,
views on se, mitä käytetään projektin etupäässä.

Esimerkiksi:

Toiseksi haluat luoda kyseiseen hakemistoon tiedoston nimeltä composer.json. Tämä voidaan tehdä päätteen kautta antamalla touch komennon tai voit luoda sen IDE:ssäsi.

Tärkeä asia ottaa pois tästä on, että siellä on src hakemisto, koska se on hakemisto, joka sisältää PHP-tiedostomme ja se on hakemisto, jonka haluamme haistella.

Perussäveltäjätiedosto

Tässä on perustiedosto composer.json, jota voit käyttää projekteissasi edellisen sarjan ja alla jaetun perusteella :

{
  "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"
  }
}

Kun katsot yllä olevaa tiedostoa, voit jäsentää sen seuraavasti:

Rivit 2 ja 3 antavat hieman kuvausta laajennuksen sisällöstä. Nämä ovat myös muita tämän tiedoston alueita, jotka antavat lisätietoja siitä, mitä on tehtävä.
Rivit 4-8 ovat tärkeitä, koska ne selittävät, että käytämme PSR-4 :ää automaattiseen lataukseen ja että kaikki tiedostot kuuluvat ylätason nimiavaruuteen Presswareja että PHP-tiedostot ovat src hakemistossa.
Rivit 9–18 kattavat kaikki edellisessä sarjassa käsitellyt tiedostot.

Anna seuraavaksi seuraava komento terminaalissasi:

$ composer install

Ja se asentaa nämä paketit.

Entä sitoumukset?

Varmistaaksesi, että nukkaat ja käsittelet sitoumuksia oikein, on tärkeää, että määrität GrumPHP:n niin, että se tarkkailee tiedostoja. Mutta katson sitä seuraavassa postauksessa.

Sillä välin, ehkä tämä on hyvä tilaisuus asentaa demolaajennus ja harjoitella yllä olevan koodin kanssa. Sen määrittäminen oikein ensimmäisellä kerralla voi olla vaikeaa. Onneksi monet tulostusvirheet ovat todella helppoja ymmärtää, joten niiden ratkaiseminen on suhteellisen helppoa.

: tommcfarlin.com