Download the PHP package spaceonfire/easy-coding-standard-bridge without Composer
On this page you can find all versions of the php package spaceonfire/easy-coding-standard-bridge. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spaceonfire/easy-coding-standard-bridge
More information about spaceonfire/easy-coding-standard-bridge
Files in spaceonfire/easy-coding-standard-bridge
Package easy-coding-standard-bridge
Short Description Easy Coding Standard Bridge by spaceonfire
License MIT
Homepage https://github.com/spaceonfire/easy-coding-standard-bridge
Informations about the package easy-coding-standard-bridge
Easy Coding Standard Bridge by spaceonfire
Установка
Установите зависимости для разработки:
Добавить скрипт в composer.json
Использование
Чтобы скопировать базовые конфиги для Easy Coding Standard и EditorConfig, выполните команду из директории репозитория.
После этого у вас появятся файлы .editorconfig
и ecs.php
. Доработайте конфиг ecs.php
под нужды проекта, укажите
директории с кодом для анализа.
Внедрение на действующий проект
После инициализации конфига на действующем проекте ecs
найдет массу ошибок в кодовой базе, не все из которых он может
решить автоматически при использовании ключа --fix
. В этом случае можно просто принять все эти ошибки как "baseline"
и игнорировать их при анализе. Это позволяет упростить процесс внедрения инструмента и начать писать новый код применяя
стандарты.
Для создания "baseline" конфига необходимо сначала собрать ошибки в формате JSON:
После этого запустить команду для генерации "baseline" конфига на основе полученного JSON файла:
Эта команда создаст файл ecs-baseline.php
в рабочей директории. Его необходимо подключить в файле ecs.php
(по-умолчанию он уже подключен в шаблоне). После чего можно проверить что ошибки игнорируются.
Если после этого ecs
снова найдет ошибки, повторите сбор ошибок в новый файл (например, ecs-baseline-errors.2.json
)
и повторите генерацию "baseline" конфига с указанием всех файлов ошибок. Повторите эти шаги, пока ecs
не перестанет
выводить ошибки.
После внедрения "baseline" конфига не забывайте при редактировании legacy кода убирать файлы из "baseline" конфига и исправлять ошибки, тем самым постепенно приводя кодовую базу проекта в соответствие стандартам.
Запуск в CI/CD
Пример задания для запуска проверки кода в GitLab CI/CD:
При указании docker образа, в котором будет выполняться задание, вместо spaceonfire/nginx-php-fpm:latest-7.4
можно
указать тег с версией php для проекта (доступны 7.2
, 7.3
, 7.4
) либо другой образ с php
и composer
.
Change log
Please see CHANGELOG for more information on what has changed recently.
Contributing
Report issues and send Pull Requests in the main spaceonfire repository. Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
Credits
- Constantine Karnaukhov
- All Contributors
License
The MIT License (MIT). Please see License File for more information.