Параметры качества кода для каждого языка в Visual Studio Code

Последнее обновление Авг 9, 2022

В предыдущих сообщениях я немного рассказал о Visual Studio Code, и хотя я пробовал множество других редакторов, я постоянно возвращаюсь к этой конкретной IDE.

Со временем он немного повзрослел, продолжает это делать и позволяет множество настроек, особенно для тех из нас, кто работает с PHP, Sass, JavaScript и, в более общем плане, с WordPress.

Однако, если вы используете какие-либо линтеры, вы обнаружите, что одна из вещей, о которых будет говорить каждый, — это количество пробелов, которые должны существовать перед данной строкой кода.

Итак, если вы используете Visual Studio Code, я рекомендую эти расширения и настройки, чтобы убедиться, что ваш код соответствует номиналу любых инструментов качества кода, которые вы используете.

Качество кода на языке

Во-первых, расширения, которые я рекомендую установить каждому человеку — по крайней мере, если вы работаете с вышеуказанными языками — включают следующее:

ESLint. Интегрирует ESLint в VS Code. (Если вы новичок в ESLint, проверьте документацию .)
PHPCS, который интегрирует стандарты кодирования PHP (установленные в настройках) в IDE.
Панель инструментов WordPress предоставляет фрагменты для каждой функции, класса и константы 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