Якість коду за параметрами мови в коді Visual Studio

Останнє оновлення Лис 9, 2022

У попередніх публікаціях я трохи говорив про Visual Studio Code, і хоча я пробував багато інших редакторів, я постійно повертаюся до цієї конкретної IDE.

З часом він трохи зрілий, продовжує це робити, і дозволяє багато налаштовувати, особливо для тих із нас, хто працює з PHP, Sass, JavaScript і, загалом, WordPress.

Проте, якщо ви використовуєте будь-який лінтер, ви побачите, що одна з речей, про яку кожен буде говорити, це кількість пробілу, який має бути перед певним рядком коду.

Отже, якщо ви використовуєте Visual Studio Code, я рекомендую ці розширення та налаштування, щоб переконатися, що ваш код відповідає всім інструментам якості коду, які ви використовуєте.

Якість коду для кожної мови

По-перше, розширення, які я рекомендую встановити кожному – принаймні, якщо ви працюєте з вищезазначеними мовами – включають наступне:

ESLint. Інтегрує ESLint у код VS. (Якщо ви новачок у ESLint, перегляньте документацію .)
PHPCS, який інтегрує стандарти кодування PHP (встановлені в налаштуваннях) у IDE.
WordPress Toolbox містить фрагменти для кожної функції WordPress, класу та константи, з підказками щодо типу аргументів і короткими описами до WordPress 4.9.4 (на момент публікації).

Після їх встановлення ви можете перезапустити IDE або додати наступний код до файлу параметрів, перш ніж це зробити. Ви можете зробити це на глобальній основі або на основі кожного проекту. Будь-яке добре. Я прокоментував код, щоб зробити його якомога легшим для дотримання.

Я також додам кілька приміток під ним.


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

Ось як це працює:

Для кожного типу мови ви можете визначити певні параметри, як -от розмір вкладки та автоматичний відступ, створивши визначення у файлі JSON.
Для цього поставте перед визначенням суфікс файлу мови або, у деяких випадках (наприклад, JavaScript), назву мови.

Код у нижній частині файлу, Загальні налаштування редактора, надаються як деякі додаткові функції, які ви можете включити. Наприклад, я люблю обрізати весь кінцевий простір, пропонувати основні визначення PHP і набір стандартів кодування, коли я працюю над проектом.

Це речі, які, як правило, виходять за межі цього проекту (але я обговорював це в інших публікаціях ). Але цього все одно достатньо, щоб почати роботу з вищим рівнем якості коду для кожної мови, ніж те, що пропонується з коробки.

Джерело запису: tommcfarlin.com