VS Code: базовые возможности для работы с языком PHP
(Я работаю в операционной системе «Windows 10» и использую «VS Code» версии 1.72 [от сентября 2022 года]. Это следует учитывать при чтении данного поста.)
Текстовый редактор «Visual Studio Code» (сокращенно «VS Code») обладает базовой поддержкой языка программирования PHP, так сказать, «из коробки» (то есть эта возможность доступна пользователю сразу после установки редактора на компьютер, без дополнительных загрузок). Об этом рассказано в следующей статье на официальном сайте редактора:
«PHP in Visual Studio Code»
https://code.visualstudio.com/docs/languages/php
Я открыл в редакторе «VS Code» папку («Файл - Открыть папку...») с файлами и подпапками веб-приложения «WordPress», которая у меня на компьютере находится в следующем местоположении:
C:\inetpub\wwwroot\wp\
После этого дерево файлов и подпапок можно просмотреть в «Проводнике» («Вид - Проводник»). Вот как это выглядит у меня:
На иллюстрации выше видно, что всем файлам с расширением «.php» сопоставлена иконка с фиолетовым слоном (синий слон является официальным маскотом языка PHP, правда, в изображениях цвет не всегда используют синий).
Я щелкнул в «Проводнике» на имя одного из файлов с расширением «.php» и он открылся в окне справа от «Проводника»:
На иллюстрации выше видно, что автоматически сработала подсветка синтаксиса для языка PHP. В строке состояния редактора «VS Code» видно, что правильно определился языковой режим, так как там появилась отметка «PHP».
Перед дальнейшей работой с программами на языке PHP я бы рекомендовал заглянуть в «Параметры» (настройки редактора), относящиеся к настройке встроенных возможностей редактора для работы с языком PHP. Чтобы открыть окно настройки параметров, можно нажать комбинацию клавиш «Ctrl+,» (вторая клавиша в этой комбинации - запятая в латинской раскладке клавиатуры). После того, как окно параметров откроется, в строке поиска сверху можно набрать слово «php», чтобы отфильтровать только те параметры, которые содержат в своем названии это слово (регистр букв не имеет значения). Вот как это выглядит у меня:
На иллюстрации выше видно, что всего нашлось 5 подходящих настроек, в том числе 4 в разделе настроек, который называется «PHP». Эти четыре настройки нас сейчас и интересуют. На иллюстрации выше показано, как они настроены по умолчанию. Единственное, что сразу нужно сделать - настроить параметр с идентификатором «php.validate.executablePath» (он же - «PHP > Validate: Executable Path»). В этом параметре следует указать путь к исполняемому файлу «php.exe» в дистрибутиве интерпретатора PHP.
Чтобы настроить этот параметр, можно нажать на прилагающуюся ссылку «Изменить в settings.json». После этого в отдельном окне будет открыт файл настроек «settings.json», в который следует ввести нужную информацию. При этом следует отметить, что файлов настроек «settings.json» существует несколько на разных уровнях: на уровне пользователя, на уровне рабочей области (рабочей папки или папок), подробнее про это можно прочитать в статье «User and Workspace Settings» документации редактора.
Как видно на иллюстрации выше, у меня выбрана вкладка параметров «Пользователь», поэтому при нажатии на ссылку «Изменить в settings.json» будет открыт для редактирования файл настроек «settings.json» текущего пользователя компьютера. У меня этот файл хранится в следующем местоположении:
C:\Users\Илья\AppData\Roaming\Code\User\settings.json
По расширению файла должно быть понятно, что этот файл написан в формате JSON, для которого редактор «VS Code» тоже умеет делать подсветку синтаксиса и выдавать умные подсказки в ходе редактирования этого файла.
После открытия файла «settings.json» по вышеописанной ссылке «Изменить в settings.json» в файл автоматически будет добавлена нужная строка:
"php.validate.executablePath": ""
От нас требуется вписать путь к файлу «php.exe» внутрь кавычек, находящихся в конце этой строки. Тут есть одна важная тонкость с символом-разделителем папок при вводе пути к файлу «php.exe». В операционных системах «Windows» принято в качестве такого символа использовать символ обратной косой черты \ (backslash), но в данном случае использование этого символа в пути к файлу «php.exe» будет интерпретировано неверно. Вместо символа обратной косой черты \ здесь следует использовать символ косой черты / (slash). Вот как я ввел этот параметр у себя:
"php.validate.executablePath": "C:/Program Files/php-8.1.10-nts-Win32-vs16-x64/php.exe"
После ввода этого параметра файл «settings.json» следует сохранить, после чего его можно закрыть. После этого окно с параметрами тоже можно закрыть.
Настройка этого параметра нужна для автоматической проверки на правильность (linting) кода программ на языке PHP. Как видно из настроек выше, автоматическая проверка кода по умолчанию проводится при каждом сохранении («onSave») файла с расширением «.php».
* * *
Здесь описаны только некоторые встроенные возможности редактора «VS Code» по работе с программами на языке PHP. Но для редактора «VS Code» существует множество расширений для работы с языком PHP. Их очень легко можно найти, загрузить и установить с помощью магазина расширений («Вид - Расширения»).
Если вы загрузили и установили расширения, дублирующие встроенные возможности редактора «VS Code» по работе с языком PHP (то есть делающие то же самое, но лучше), то встроенные возможности можно отключить. См. настройки, описанные выше: для отключения нужно просто снять две первые галки.
Также я хочу еще изучить вопрос настройки работы с отладчиком для языка PHP. Но этот вопрос достоин отдельного поста.
Текстовый редактор «Visual Studio Code» (сокращенно «VS Code») обладает базовой поддержкой языка программирования PHP, так сказать, «из коробки» (то есть эта возможность доступна пользователю сразу после установки редактора на компьютер, без дополнительных загрузок). Об этом рассказано в следующей статье на официальном сайте редактора:
«PHP in Visual Studio Code»
https://code.visualstudio.com/docs/languages/php
Я открыл в редакторе «VS Code» папку («Файл - Открыть папку...») с файлами и подпапками веб-приложения «WordPress», которая у меня на компьютере находится в следующем местоположении:
C:\inetpub\wwwroot\wp\
После этого дерево файлов и подпапок можно просмотреть в «Проводнике» («Вид - Проводник»). Вот как это выглядит у меня:
На иллюстрации выше видно, что всем файлам с расширением «.php» сопоставлена иконка с фиолетовым слоном (синий слон является официальным маскотом языка PHP, правда, в изображениях цвет не всегда используют синий).
Я щелкнул в «Проводнике» на имя одного из файлов с расширением «.php» и он открылся в окне справа от «Проводника»:
На иллюстрации выше видно, что автоматически сработала подсветка синтаксиса для языка PHP. В строке состояния редактора «VS Code» видно, что правильно определился языковой режим, так как там появилась отметка «PHP».
Перед дальнейшей работой с программами на языке PHP я бы рекомендовал заглянуть в «Параметры» (настройки редактора), относящиеся к настройке встроенных возможностей редактора для работы с языком PHP. Чтобы открыть окно настройки параметров, можно нажать комбинацию клавиш «Ctrl+,» (вторая клавиша в этой комбинации - запятая в латинской раскладке клавиатуры). После того, как окно параметров откроется, в строке поиска сверху можно набрать слово «php», чтобы отфильтровать только те параметры, которые содержат в своем названии это слово (регистр букв не имеет значения). Вот как это выглядит у меня:
На иллюстрации выше видно, что всего нашлось 5 подходящих настроек, в том числе 4 в разделе настроек, который называется «PHP». Эти четыре настройки нас сейчас и интересуют. На иллюстрации выше показано, как они настроены по умолчанию. Единственное, что сразу нужно сделать - настроить параметр с идентификатором «php.validate.executablePath» (он же - «PHP > Validate: Executable Path»). В этом параметре следует указать путь к исполняемому файлу «php.exe» в дистрибутиве интерпретатора PHP.
Чтобы настроить этот параметр, можно нажать на прилагающуюся ссылку «Изменить в settings.json». После этого в отдельном окне будет открыт файл настроек «settings.json», в который следует ввести нужную информацию. При этом следует отметить, что файлов настроек «settings.json» существует несколько на разных уровнях: на уровне пользователя, на уровне рабочей области (рабочей папки или папок), подробнее про это можно прочитать в статье «User and Workspace Settings» документации редактора.
Как видно на иллюстрации выше, у меня выбрана вкладка параметров «Пользователь», поэтому при нажатии на ссылку «Изменить в settings.json» будет открыт для редактирования файл настроек «settings.json» текущего пользователя компьютера. У меня этот файл хранится в следующем местоположении:
C:\Users\Илья\AppData\Roaming\Code\User\settings.json
По расширению файла должно быть понятно, что этот файл написан в формате JSON, для которого редактор «VS Code» тоже умеет делать подсветку синтаксиса и выдавать умные подсказки в ходе редактирования этого файла.
После открытия файла «settings.json» по вышеописанной ссылке «Изменить в settings.json» в файл автоматически будет добавлена нужная строка:
"php.validate.executablePath": ""
От нас требуется вписать путь к файлу «php.exe» внутрь кавычек, находящихся в конце этой строки. Тут есть одна важная тонкость с символом-разделителем папок при вводе пути к файлу «php.exe». В операционных системах «Windows» принято в качестве такого символа использовать символ обратной косой черты \ (backslash), но в данном случае использование этого символа в пути к файлу «php.exe» будет интерпретировано неверно. Вместо символа обратной косой черты \ здесь следует использовать символ косой черты / (slash). Вот как я ввел этот параметр у себя:
"php.validate.executablePath": "C:/Program Files/php-8.1.10-nts-Win32-vs16-x64/php.exe"
После ввода этого параметра файл «settings.json» следует сохранить, после чего его можно закрыть. После этого окно с параметрами тоже можно закрыть.
Настройка этого параметра нужна для автоматической проверки на правильность (linting) кода программ на языке PHP. Как видно из настроек выше, автоматическая проверка кода по умолчанию проводится при каждом сохранении («onSave») файла с расширением «.php».
* * *
Здесь описаны только некоторые встроенные возможности редактора «VS Code» по работе с программами на языке PHP. Но для редактора «VS Code» существует множество расширений для работы с языком PHP. Их очень легко можно найти, загрузить и установить с помощью магазина расширений («Вид - Расширения»).
Если вы загрузили и установили расширения, дублирующие встроенные возможности редактора «VS Code» по работе с языком PHP (то есть делающие то же самое, но лучше), то встроенные возможности можно отключить. См. настройки, описанные выше: для отключения нужно просто снять две первые галки.
Также я хочу еще изучить вопрос настройки работы с отладчиком для языка PHP. Но этот вопрос достоин отдельного поста.