В современной разработке программного обеспечения поддержание высокого качества кода имеет решающее значение для успеха проекта. Одним из популярных инструментов для обеспечения соблюдения стандартов кодирования является PHP CodeSniffer (PHPCS). Интеграция PHPCS в рабочий процесс разработки может помочь вам выявить и устранить проблемы с кодированием на раннем этапе. В этой статье мы рассмотрим различные методы запуска PHPCS из Visual Studio Code (VS Code), одного из самых популярных редакторов кода.

Метод 1: использование расширения PHPCS VS Code

1. Установите расширение PHPCS: запустите VS Code, перейдите к представлению «Расширения» (Ctrl+Shift+X) и найдите «PHPCS». Установите расширение, автором которого является Иоаннис Каппас.
2. Установите PHPCS: убедитесь, что PHPCS установлен глобально в вашей системе. Вы можете установить его с помощью Composer, запустив composer global require "squizlabs/php_codesniffer=*"на своем терминале.
3. Настройте PHPCS в VS Code: нажмите Ctrl+ (или выберите «Файл» >«Настройки» >«Настройки»), чтобы открыть представление «Настройки». Найдите «PHPCS: Путь к исполняемому файлу» и укажите путь, по которому установлен PHPCS (например, /usr/local/bin/phpcs).
4. Откройте файл PHP в VS Code и включите PHPCS: используйте палитру команд (Ctrl+Shift+P) и найдите «PHPCS: Включить». Выберите вариант, чтобы включить PHPCS для текущей рабочей области или глобально.

Метод 2: использование расширения PHP Intelephense

1. Установите расширение PHP Intelephense. Запустите VS Code, перейдите к представлению «Расширения» (Ctrl+Shift+X) и найдите «PHP Intelephense». Установите расширение, автором которого является Бен Мьюберн.
2. Настройте PHP Intelephense для использования PHPCS: нажмите Ctrl+ (или выберите «Файл» >«Настройки» >«Настройки»), чтобы открыть представление «Настройки». Найдите «php.suggest.basic» и добавьте "phpcs"в список.
3. Откройте файл PHP в VS Code и запустите анализ: по мере ввода PHP Intelephense будет запускать PHPCS в фоновом режиме и выявлять любые проблемы с кодированием.

Метод 3: использование пользовательской задачи VS Code

1. Откройте палитру команд VS Code (Ctrl+Shift+P) и найдите «Задачи: настроить задачу».
2. Выберите «Создать файл Tasks.json на основе шаблона» и выберите «Другие» в качестве типа задачи.
3. Замените сгенерированное содержимое файла Tasks.json следующим кодом:

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Run PHPCS",
            "type": "shell",
            "command": "phpcs",
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "presentation": {
                "reveal": "silent"
            },
            "problemMatcher": {
                "owner": "php",
                "fileLocation": [
                    "relative",
                    "${workspaceFolder}"
                ],
                "pattern": {
                    "regexp": "^(.*):(\\d+):(\\d+):\\s+(.*)$",
                    "file": 1,
                    "line": 2,
                    "column": 3,
                    "message": 4
                }
            }
        }
    ]
}

1. Сохраните файл Tasks.json, откройте файл PHP в VS Code и запустите задачу, нажав Ctrl+Shift+B. PHPCS будет запущен, и любые проблемы с кодированием будут отображаться на панели «Проблемы».

Интегрируя PHPCS в VS Code, вы можете легко обеспечить соблюдение стандартов кодирования и улучшить качество вашего PHP-кода. В этой статье мы рассмотрели три метода запуска PHPCS из VS Code: использование расширения PHPCS, использование расширения PHP Intelephense и создание пользовательской задачи VS Code. Выберите метод, который лучше всего подходит для вашего рабочего процесса, и начните пользоваться преимуществами упрощенной проверки качества кода.