Koodikvaliteedi keelepõhised sätted Visual Studio koodis

Viimati uuendatud nov. 9, 2022

Eelmistes postitustes olen rääkinud veidi Visual Studio Code’ist ja kuigi olen proovinud mitmeid teisi toimetajaid, tulen ma pidevalt selle konkreetse IDE juurde tagasi.

Aja jooksul on see üsna palju küpsenud, jätkab seda ja võimaldab palju kohandamist, eriti neile, kes töötavad PHP, Sassi, JavaScripti ja üldisemalt WordPressiga.

Kui kasutate linterit, näete, et üks asi, millest igaüks räägib, on tühikute arv, mis peaks enne antud koodirida olema.

Nii et kui kasutate Visual Studio koodi, siis soovitan neid laiendusi ja seadeid, et teie kood oleks sama mis tahes koodikvaliteedi tööriistadega, mida te kasutate.

Koodi kvaliteet keele järgi

Esiteks, laiendused, mida soovitan kõigil installida – vähemalt siis, kui töötate ülaltoodud keeltega – hõlmavad järgmist.

ESLint. Integreerib ESLinti VS-koodi. (Kui olete ESLinti uus kasutaja, kontrollige dokumentatsiooni .)
PHPCS, mis integreerib PHP kodeerimisstandardid (määratud eelistustes) IDE-sse.
WordPressi tööriistakast pakub väljavõtteid iga WordPressi funktsiooni, klassi ja konstandi kohta koos argumenditüübi vihjete ja lühikirjeldustega kuni WordPressi versioonini 4.9.4 (selle postituse ajal).

Kui need on installitud, saate oma IDE taaskäivitada või enne seda eelistuste faili lisada järgmise koodi. Saate seda teha globaalselt või projektipõhiselt. Kumbki on hea. Olen koodi kommenteerinud, et seda oleks võimalikult lihtne jälgida.

Lisan selle alla ka paar märkust.


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

See toimib järgmiselt.

Iga keeletüübi jaoks saate JSON-failis definitsiooni loomisega määratleda teatud sätted, näiteks tabSize ja automaatse taande tegemise või mitte .
Selleks tuleb definitsiooni ette lisada keele faililiide või mõnel juhul (nt JavaScript) keele nimi.

Faili allosas olev kood ja üldredaktori sätted on mõned lisad, mida võiksite lisada. Näiteks meeldib mulle kärpida kogu lõppruumi, soovitada põhilisi PHP definitsioone ja kodeerimisstandardite komplekti projekti kallal töötades.

Need on asjad, mis üldiselt selle projekti raamest välja jäävad (aga ma olen sellest teistes postitustes arutanud ). Kuid see on siiski piisav, et alustada iga keele puhul pakutavast kõrgema taseme koodikvaliteediga.

: tommcfarlin.com