Koodin laatu kielikohtaisesti Visual Studio Codessa

Viimeisin päivitys marras 9, 2022

Aiemmissa viesteissä olen puhunut hieman Visual Studio Codesta, ja vaikka olen kokeillut useita muita editoreja, palaan jatkuvasti tähän nimenomaiseen IDE:hen.

Ajan myötä se on kypsynyt melkoisesti, jatkaa sitä ja mahdollistaa runsaasti mukauttamista erityisesti meille, jotka työskentelevät PHP :n, Sassin, JavaScriptin ja yleisemmin WordPressin parissa .

Jos kuitenkin käytät linterejä, huomaat, että yksi niistä asioista, joista kukin puhuu, on välilyöntien määrä, jonka tulisi olla ennen tiettyä koodiriviä.

Joten jos käytät Visual Studio Codea, nämä ovat ne laajennukset ja asetukset, joita suosittelen varmistamaan, että koodisi vastaa kaikkia käyttämiäsi koodinlaatutyökaluja.

Koodin laatu kielikohtaisesti

Ensinnäkin laajennukset, jotka suosittelen jokaisen asentamaan – ainakin jos käytät yllä olevia kieliä – sisältävät seuraavat:

ESLint. Integroi ESLint VS-koodiin. (Jos olet uusi ESLint-käyttäjä, tarkista dokumentaatio .)
PHPCS, joka integroi PHP-koodausstandardit (asetettu asetuksissa) IDE:hen.
WordPress Toolbox tarjoaa katkelmia jokaisesta WordPress-funktiosta, luokasta ja vakiosta, argumenttityyppivinkkeineen ja lyhyinä kuvauksina WordPressin versioon 4.9.4 asti (tämän viestin ajankohtana).

Kun ne on asennettu, voit käynnistää IDE:n uudelleen tai lisätä seuraavan koodin asetustiedostoon ennen kuin teet niin. Voit tehdä tämän maailmanlaajuisesti tai projektikohtaisesti. Kumpikin on hyvä. Olen kommentoinut koodia, jotta sen seuraaminen olisi mahdollisimman helppoa.

Lisään sen alle myös muutaman huomautuksen.


{
    // Tab Spacing per language.
    "[php]": {
      "editor.tabSize": 4,
      "editor.autoIndent": true
    },

    "[scss]": {
      "editor.tabSize": 2,
      "editor.autoIndent": true
    },

    "[javascript]": {
      "editor.tabSize": 2,
      "editor.autoIndent": true
    },

    // General Editor Settings
    "files.trimTrailingWhitespace": true,
    "php.suggest.basic": true,
    "php.validate.executablePath": "/usr/local/bin/php",
    "php.validate.run": "onType",
    "phpcs.enable": true,
    "phpcs.executablePath": "/usr/local/bin/phpcs",
    "phpcs.standard": "PSR2"
}

Näin se toimii:

Voit määrittää kullekin kielityypille tietyt asetukset, kuten tabSize ja automaattisen indentin luomisen luomalla määritelmän JSON-tiedostoon.
Tätä varten edeltää määritelmää kielen tiedostopääte tai joissakin tapauksissa (kuten JavaScript) kielen nimi.

Tiedoston alareunassa oleva koodi, Yleiset editorin asetukset ovat lisätoimintoja, jotka saatat haluta sisällyttää. Haluan esimerkiksi leikata kaiken lopputilan, ehdottaa PHP-perusmääritelmiä ja joukko koodausstandardeja, kun työskentelen projektin parissa.

Nämä ovat asioita, jotka eivät yleensä kuulu tämän projektin piiriin (mutta olen keskustellut muissa viesteissä ). Mutta silti riittää, jotta pääset alkuun korkeamman tason koodinlaadulla kielikohtaisesti kuin mitä on tarjolla.

: tommcfarlin.com