Kodkvalitet per språkinställningar i Visual Studio Code

I tidigare inlägg har jag pratat lite om Visual Studio Code, och även om jag har provat en mängd andra redigerare, kommer jag hela tiden tillbaka till just denna IDE.

Med tiden har det mognat en hel del, fortsätter att göra det och tillåter massor av anpassningar, särskilt för de av oss som arbetar i PHP, Sass, JavaScript och mer allmänt sett WordPress.

Om du använder några linters, kommer du dock att upptäcka att en av sakerna var och en kommer att prata om är mängden blanksteg som ska finnas före en given kodrad.

Så om du använder Visual Studio Code är det här tilläggen och inställningarna jag rekommenderar för att se till att din kod är i nivå med vilka kodkvalitetsverktyg du än använder.

Kodkvalitet per språk

För det första inkluderar tilläggen som jag rekommenderar att varje person installerar – åtminstone om du arbetar med ovanstående språk – följande:

• ESLint. Integrerar ESLint i VS Code. (Om du är ny på ESLint kontrollera dokumentationen .)
• PHPCS som integrerar PHP-kodningsstandarderna (som anges i inställningarna) i IDE.
• WordPress Toolbox tillhandahåller utdrag för varje WordPress-funktion, klass och konstant, med argumenttyptips och korta beskrivningar upp till WordPress 4.9.4 (vid tidpunkten för detta inlägg).

När de är installerade kan du starta om din IDE eller lägga till följande kod till inställningsfilen innan du gör det. Du kan göra detta på global basis eller per projekt. Vilket som blir bra. Jag har kommenterat koden för att göra den så enkel som möjligt att följa.

Jag ska också lägga till några anteckningar nedanför.

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

Så här fungerar det:

• För varje typ av språk kan du definiera vissa inställningar som tabSize och om autoIndent ska ske eller inte genom att skapa en definition i JSON-filen.
• För att göra detta, föregå definitionen med filsuffixet för språket eller, i vissa fall (som JavaScript), namnet på språket.

Koden längst ner i filen, de allmänna redaktörsinställningarna tillhandahålls som några extrafunktioner som du kanske vill inkludera. Till exempel gillar jag att trimma allt efterföljande utrymme, föreslå grundläggande PHP-definitioner och en uppsättning kodningsstandarder för när jag arbetar med ett projekt.

Det här är saker som i allmänhet ligger utanför det här projektets ram (men jag har diskuterat i andra inlägg ). Men det räcker ändå för att komma igång med en högre kodkvalitet per språk än vad som erbjuds direkt.