包简介

Generate readme badges during your pre-push

README 文档

README

Generate badges as part of your pre-push hooks!

Installation

Add networkrailbusinesssystems/badges to your Composer dev dependencies

composer require --dev networkrailbusinesssystems/badges

Ensure that PHPUnit outputs logs and coverage with the following settings:

<coverage>
    <report>
        <html outputDirectory=".phpunit.cache/html" />
        <text outputFile=".phpunit.cache/coverage.txt" showUncoveredFiles="false" showOnlySummary="true" />
    </report>
</coverage>
<logging>
    <junit outputFile=".phpunit.cache/tests.xml" />
</logging>

Add the following commands to the pre-push hook:

php vendor/networkrailbusinesssystems/badges/badges.php
git add .github/*.svg
git diff-index --quiet --cached HEAD || git commit -m "Updated badges" --no-verify

Add the following lines to readme.md, excluding badges as required:

![Composer status](.github/composer.svg)
![Coverage status](.github/coverage.svg)
![Frontend version](.github/frontend.svg)
![Laravel version](.github/laravel.svg)
![NPM status](.github/npm.svg)
![PHP version](.github/php.svg)
![Tests status](.github/tests.svg)
![Views status](.github/views.svg)

Debug driver

You must have either xdebug or PCOV installed to run coverage checks, and enable the coverage mode.

PCOV is generally newer and faster than XDebug, however it may not be as accurate.

XDebug

sudo apt install php-xdebug
Add the following to the end of your php.ini:

[xdebug]
xdebug.mode=coverage

PCOV

sudo apt install php8.2-dev
sudo apt install php-pear
sudo pecl install pcov
Add the following to the end of your php.ini:

[pcov]
extension=pcov.so

Usage

Run git push as normal
The pre-push hooks will fire, running your tests and coverage
The badges will automatically generate, update, and be added to the commit

Views status

Use the AssertsViewsRender trait and extension in the LaravelTestingTraits library to enable tracking the status of rendered views.

networkrailbusinesssystems/badges 适用场景与选型建议

networkrailbusinesssystems/badges 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 9.27k 次下载、GitHub Stars 达 0，最近一次更新时间为 2024 年 01 月 09 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 networkrailbusinesssystems/badges 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 networkrailbusinesssystems/badges 我们能提供哪些服务？

定制开发 / 二次开发

基于 networkrailbusinesssystems/badges 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

networkrailbusinesssystems/badges

包简介