PHP в Visual Studio Code: конфигурация среды разработки

Расширенные примеры конфигурации и автоматизации

Пример 1. Множественные конфигурации отладки для веба и CLI

В файле launch.json можно создать несколько профилей, чтобы отлаживать веб-запросы и консольные скрипты отдельно:

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Listen for Xdebug (Web)",
      "type": "php",
      "request": "launch",
      "port": 9003,
      "pathMappings": { "/var/www/html": "${workspaceFolder}" }
    },
    {
      "name": "Launch CLI script",
      "type": "php",
      "request": "launch",
      "program": "${workspaceFolder}/bin/console",
      "args": ["some:command"],
      "cwd": "${workspaceFolder}"
    }
  ]
}

Для запуска CLI скрипта выбрать конфигурацию Launch CLI script и нажать F5.

Пример 2. Настройка Intelephense для фреймворка Laravel

Laravel использует фасады, трейты и динамические методы. Чтобы Intelephense корректно их распознавал, нужно указать корневую папку и добавить настройки:

{
  "intelephense.files.maxSize": 5000000,
  "intelephense.environment.includePaths": [
    "vendor/laravel/framework/src"
  ],
  "intelephense.compatibility.correctForBasePaths": true,
  "intelephense.completion.triggerParameterHints": true
}

После этого автодополнение будет работать для \DB::table(), \Auth::user() и других фасадов.

Пример 3. Интеграция статического анализатора PHPStan

Установить расширение PHPStan или настроить пользовательскую задачу tasks.json:

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "PHPStan analyze",
      "type": "shell",
      "command": "vendor/bin/phpstan analyse src --level=max",
      "group": "test",
      "presentation": {
        "reveal": "always",
        "panel": "new"
      },
      "problemMatcher": {
        "base": "$phpstan",
        "owner": "phpstan",
        "fileLocation": ["relative", "${workspaceFolder}"]
      }
    }
  ]
}

После запуска задачи в панели проблем будут отображаться ошибки. Пример вывода:

 1/1 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
 ------ ----------------------------------------------------------------- 
  Line   src/Example.php
 ------ ----------------------------------------------------------------- 
  15     Parameter $value of method Example::process() has no type specified.
 ------ -----------------------------------------------------------------

Пример 4. Настройка PHP CS Fixer с правилами PSR-12 и проектом Symfony

Создать файл .php-cs-fixer.php в корне проекта:

<?
return (new PhpCsFixer\Config())
    ->setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'no_unused_imports' => true,
        'ordered_imports' => ['sort_algorithm' => 'alpha'],
    ])
    ->setCacheFile(__DIR__.'/.php-cs-fixer.cache')
    ->setFinder(PhpCsFixer\Finder::create()
        ->in(__DIR__.'/src')
        ->in(__DIR__.'/tests')
    );

Расширение PHP CS Fixer для VS Code автоматически подхватит этот конфиг. Запуск форматирования через команду PHP CS Fixer: Fix.

Пример 5. Автоматический запуск PHPUnit при сохранении файла

Добавить в settings.json:

{
  "phpunit.runOnSave": {
    "enabled": true,
    "pattern": ".php"
  }
}

При сохранении любого PHP-файла будет запускаться весь набор тестов. Результат появится в панели вывода:

PHPUnit 9.6.19 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.2.12
Configuration: /home/user/project/phpunit.xml

................................................... 61 / 61 (100%)

Time: 00:00.352, Memory: 20.00 MB

OK (61 tests, 100 assertions)