Настройка стандартов кодирования для вашего проекта – это всегда хорошая идея. Хотя идеально начинать с одного с самого начала, иногда вам приходится делать это после того, как вы уже написали довольно много кода (смотрите Zuari 👀 ). Вот краткое руководство по настройке Стандартов кодирования PHP WordPress для вашей темы или плагина:
Для целей этого руководства вам потребуется локально установить PHP и Composer, даже если вы используете docker для локальной разработки . Мы начинаем с запуска инициализации композитора . Это настроит файл composer.json и добавит его в .гитигноре . Далее, чтобы получить phpcs и стандарты кодирования WordPress , мы запускаем:
composer require squizlabs/php_codesniffer --dev composer require wp-coding-standards/wpcs --dev composer require dealerdirect/phpcodesniffer-composer-installer --dev composer require phpcompatibility/php-compatibility --dev
Как, чтобы убедиться, что все настроено правильно при новой установке, мы создадим сценарии, которые будут автоматически запускаться после установки. Вы можете прочитать больше об этом в документации по плагину PHP_CodeSniffer standards composer installer . Мы также добавим скрипт для фактического запуска phpcs изнутри ./поставщика/bin , это послужит сокращением, когда нам это понадобится позже. Так что в composer.json мы добавим новый ключ под названием скрипты:
"scripts": {
"lint": "phpcs",
"install-codestandards": ["Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\Plugin::run"],
"post-install-cmd": [
"@install-codestandards"
]
}
Если мы попытаемся запустить composer run-script lint сейчас, он начнет показывать нам тонну ошибок компоновки. Однако это может быть немного больше, чем нам на самом деле нужно решить, и это потому, что мы еще не определили, какому стандарту кодирования мы будем следовать. Для этого мы создадим файл phpcs.xml.dist и скопируем содержимое из файла пример конфигурации , который предоставляют стандарты кодирования WordPress:
A custom set of rules to check for a WPized WordPress project /docroot/wp-admin/* /docroot/wp-includes/* /docroot/wp-*.php /docroot/index.php /docroot/xmlrpc.php /docroot/wp-content/plugins/* /vendor/* /node_modules/* *.min.js
Теперь нам просто нужно внести некоторые коррективы в этот файл, основываясь на нашей теме и предпочтениях. Посмотрите на исключающие шаблоны , есть ли что-нибудь еще, что мы должны исключить? Далее давайте убедимся, что minimum_supported_wp_version установлен правильно. Наконец, мы исправим префиксы и text_domain для использования имени вашей темы. Убедитесь, что вы используете ” - ” для текстового домена и ” _ ” для префиксов .
И это все 🎉 Вы должны быть готовы идти! Запуск composer lint покажет вам все места, где вы не следуете стандартам кодирования WordPress. Потратьте некоторое время на устранение всех ошибок и предупреждений и игнорируйте те, которые, по вашему мнению, не подходят. Полюбуйтесь вашим чистым и красивым кодом 😍
Единственное, что осталось сделать, – это убедиться, что со временем все останется красивым и чистым. У Atom есть пакет для просмотра проблем с линтингом в самом редакторе, и вы можете найти и настроить его для редактора по вашему выбору. Я бы тоже хотел настроить это на CI, убедившись, что кто-то смотрит на эти ошибки, даже если я этого не делаю.
((Фото Анаса Ашанти на Снимке )
Оригинал: “https://dev.to/prtksxna/setting-up-wordpress-s-php-coding-standards-for-your-theme-442o”