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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package easy-coding-standard-bridge

Easy Coding Standard Bridge by spaceonfire

Latest Version on Packagist Total Downloads

Установка

Установите зависимости для разработки:

Добавить скрипт в 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

License

The MIT License (MIT). Please see License File for more information.


All versions of easy-coding-standard-bridge with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2|^8.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package spaceonfire/easy-coding-standard-bridge contains the following files

Loading the files please wait ....