{"id":28724413,"url":"https://github.com/voral/bitrix-module-skeleton","last_synced_at":"2025-06-26T05:06:24.168Z","repository":{"id":298047511,"uuid":"998678691","full_name":"Voral/bitrix-module-skeleton","owner":"Voral","description":"Скелетон разработки модуля для Битрикс маркетплейс","archived":false,"fork":false,"pushed_at":"2025-06-09T04:49:50.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-09T05:28:14.298Z","etag":null,"topics":["bitrix","bitrix-marketplace","bitrix-module"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Voral.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-09T04:36:15.000Z","updated_at":"2025-06-09T04:49:52.000Z","dependencies_parsed_at":"2025-06-09T05:39:40.925Z","dependency_job_id":null,"html_url":"https://github.com/Voral/bitrix-module-skeleton","commit_stats":null,"previous_names":["voral/bitrix-module-skeleton"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Voral/bitrix-module-skeleton","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Voral%2Fbitrix-module-skeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Voral%2Fbitrix-module-skeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Voral%2Fbitrix-module-skeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Voral%2Fbitrix-module-skeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Voral","download_url":"https://codeload.github.com/Voral/bitrix-module-skeleton/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Voral%2Fbitrix-module-skeleton/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259960860,"owners_count":22938143,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitrix","bitrix-marketplace","bitrix-module"],"created_at":"2025-06-15T10:39:14.934Z","updated_at":"2025-06-15T10:39:36.493Z","avatar_url":"https://github.com/Voral.png","language":"PHP","readme":"# Скелетон для разработки модуля Битрикс\n\nСкелетон содержит шаблон модуля Битрикс, а так же преднастроенные пакеты для тестирования и формирования пакетов\nобновлений модуля для Битрикс маркетплейс.\n\n## Вспомогательные пакеты\n\nСкелетон включает в себя набор готовых зависимостей для упрощения разработки, тестирования и поддержания качества кода.\nНиже приведён список основных пакетов и их назначение.\n\n### Инструменты разработки\n\n| Пакет                                                                     | Назначение                                                                    |\n|---------------------------------------------------------------------------|-------------------------------------------------------------------------------|\n| [friendsofphp/php-cs-fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer) | Форматирование кода согласно стандартам PER-CS2.0.                            |\n| [phpstan/phpstan](https://github.com/phpstan/phpstan)                     | Статический анализатор кода, помогает находить ошибки без запуска приложения. |\n| [phpstan/phpstan-phpunit](https://github.com/phpstan/phpstan-phpunit)     | Расширение PHPStan для поддержки проверок в тестах PHPUnit.                   |\n\n### Тестирование\n\n| Пакет                                                                     | Назначение                                                                   |\n|---------------------------------------------------------------------------|------------------------------------------------------------------------------|\n| [phpunit/phpunit](https://github.com/sebastianbergmann/phpunit)           | Основной фреймворк для написания юнит-тестов.                                |\n| [php-mock/php-mock-phpunit](https://github.com/php-mock/php-mock-phpunit) | Поддержка мокирования функций и методов в тестах PHPUnit.                    |\n| [voral/mock-builder-bitrix](https://github.com/Voral/mock-builder-bitrix) | Генератор моков для классов Битрикс, облегчает создание тестового окружения. |\n\n### Вспомогательные утилиты\n\n| Пакет                                                                      | Назначение                                                                                                                 |\n|----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| [voral/version-increment](https://github.com/Voral/vs-version-incrementor) | Простая CLI-утилита для автоматического увеличения версии модуля в файле `version.php`.                                    |\n| [voral/bitrix-module-tool](https://github.com/Voral/bitrix-module-tool)    | Расширение для работы с модулями Битрикс для создание пакетов обновления и автоматического изменения версии в version.php. |\n\n## Скрипты зарегистрированные в composer.json\n\n| Команда                | Назначение                                                                                                      |\n|------------------------|-----------------------------------------------------------------------------------------------------------------|\n| **composer mock:bx**   | Генерация моков для классов Битрикс                                                                             |\n| **composer vi**        | Автоматическое обновление версии модуля и подготовка файлов для пакета обновлений                               |\n| **composer vi:debug**  | Просмотр изменений, которые могут войти в релиз. А так же версии модуля, которая будет присвоена автоматически. |\n| **composer test**      | Запуск тестирования модуля                                                                                      |\n| **composer stan**      | Запуск статического анализа кода                                                                                |\n| **composer fixer**     | Форматирование кода согласно настройкам                                                                         |\n| **composer checkit**   | Выполнение команд stan и fixer                                                                                  |\n| **composer pack:last** | Создание полного архива актуальной версии для маркетплейс                                                       |\n| **composer pack:ver**  | Создание архива обновления для маркетплейс                                                                      |\n| **composer pack**      | Создание архива обновления и полного архива для маркетплейс                                                     |\n\n## Подготовка к работе\n\n1. Клонируйте репозиторий\n\n   Для простого модуля:\n   ```\n   git clone https://github.com/Voral/bitrix-module-skeleton\n   ```\n\n   Для модуля, использующего vasoft.core:\n   ```\n   git clone -b core https://github.com/Voral/bitrix-module-skeleton\n   ```\n\n2. Разрешите запуск и запустите скрипт init.sh. Он запросит ИД вендора и название модуля и произведёт замены в файлах с\n   учётом этого, заменит текст README.md, инициализирует новый git-репозиторий, добавляет в `.gitignore` файл\n   `.vs-mock-builder.local.php`\n\n   ```\n   chmod +x init.sh\n   ./init.sh\n   ```\n\n3. Выполните настройки в конфигурационных файлах\n    * `.vs-mock-builder.local.php` — укажите реальный путь к актуальному ядру битрикс. Это необходимо для создания моков\n      ядра. Этот файл на втором этапе добавляется в `.gitignore`\n    * `.vs-mock-builder.php` — при необходимости, внесите необходимые правки в конфигурацию генератора моков и\n      расширения\n      для генерации моков классов Битрикс\n    * `.php-cs-fixer.php` — настройки php CS Fixer. По умолчанию установлен PER-CS2.0\n    * `.phpstan.neon.dist` — настройки PHP Stan\n    * `.vs-version-increment.php` — Настройки пакета инкремента версии, а так же автоматической генерации пакетов\n      обновления модуля\n    * `phpunit.xml` — Настройки PHP Unit\n    * `phpstan-bootstrap.php` — Подключает автозагрузку моков битрикс для работы PHP Stan, при необходимости можно\n      добавить дополнительную логику\n    * `tests/bootstrap.php` — Подключает автозагрузку моков битрикс для работы PHP Unit, при необходимости можно\n      добавить\n      дополнительную логику\n\n4. Сгенерируйте моки классов битрикс\n   ```\n   composer mock:bx\n   ```\n\n5. Если в скрипте обновления пакета необходимо постоянно выполнять некоторую логику добавьте ее в файл\n   updates/update_include.php\n\n## Выпуск новой версии модуля\n\nПо окончанию работ над новой версией, включая тестирование, необходимо запустить генерацию CHANGELOG и пакета\nобновления, а так же инкремент версии.\n\n```\ncomposer vi\n```\n\nЭта команда, по умолчанию, выполнится без окончательного коммита внесенный ею изменений.\n\nВнесите при необходимости правки в CHANGELOG.md, который генерируется на основании сообщений коммитов добавленных с\nпрошлой версии. Версии определяются тегами git в формате v2.3.0\n\nДалее внесите при необходимости изменения в пакет обновления, который будет размещен в каталоге updtaes/\u003cВерсия_пакета\u003e.\nОбратите внимание на файлы description.*, а так же скрипт обновления update.php.\n\nПосле внесения необходимых правок можно упаковать пакеты обновления командой\n\n```\ncomposer pack\n```\n\nКогда все выполнено, можно выполнять коммит, например для версии 4.1.9\n\n```\ngit commit -am 'chore(release): v4.1.9'\ngit tag v4.1.9\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoral%2Fbitrix-module-skeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoral%2Fbitrix-module-skeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoral%2Fbitrix-module-skeleton/lists"}