thatobabusi/laravel-route-browser

Laravel的基于Web的路由列表GUI。

1.1.1 2020-02-26 22:38 UTC

This package is auto-updated.

Last update: 2024-09-27 20:07:06 UTC


README

**截至2020年7月27日,我将其分支出来接管,并单独使用,因为Dave不再支持主仓库。同时,我也厌倦了在执行composer install/update/dumpautoload等操作时收到“包不再支持”的通知。

Thato

截至2020年4月18日,Laravel Route Browser不再维护。

它最初是一个实验性项目,旨在了解Laravel的路由系统,并在artisan route:list之上创建一个改进的UI,但随着维护它所需的工作量(尤其是在Laravel路由内部发生变化时)超过了其带来的好处。

以下列出了几个替代方案,但如果您想创建自己的分支,修复错误或添加新功能,请参阅以下说明。MIT许可证要求您保留版权声明和许可证信息,但除此之外,您可以随心所欲地使用代码和文档。

Dave

Laravel Route Browser

Latest Stable Version Total Downloads Monthly Downloads License Latest Unstable Version Build Status Coverage Status

Laravel的基于Web的路由列表GUI。

(类似于Pretty RoutesLaravel Routes ExplorerLaravel Route Summary,但具有更多细节和更好的搜索功能。)

目录

兼容性图表

安装

composer require --dev thatobabusi/laravel-route-browser

可选:发布和编辑配置文件(config/route-browser.php

php artisan vendor:publish --tag=route-browser-config

然后访问/routes(或配置文件中设置的路径)。

出于安全考虑,默认情况下,仅在APP_ENV=localAPP_DEBUG=true的情况下,Route Browser才处于活动状态,或者您在.env中设置ROUTE_BROWSER_ENABLED=true。您不应在生产或任何公开可访问的环境中启用它。

贡献

文档:如果您认为文档可以以任何方式改进,请编辑此文件并提交一个拉取请求。

错误修复:请修复它并提交一个拉取请求。(见下文以获取更详细的说明。)如果您添加了一个单元测试来确保它不会再次发生,则可以得到额外的加分!

新功能:请构建它并提交一个拉取请求。如果您在开始大量工作之前想要讨论它,请创建一个概念证明(可以是代码或文档)并提交一个草稿PR来讨论细节。

创建拉取请求

在Laravel Route Browser上工作的最简单方法是告诉Composer使用--prefer-source标志从源(Git)安装它

rm -rf vendor/thatobabusi/laravel-route-browser
composer install --prefer-source

然后检出主分支,创建自己的本地分支进行工作

cd vendor/thatobabusi/laravel-route-browser
git checkout -t origin/master
git checkout -b YOUR_BRANCH

现在进行修改,包括单元测试和文档(如果适用)。运行单元测试以确保一切正常工作

scripts/test.sh

然后提交更改。如果您还没有,请先在GitHub上Fork仓库,然后将您的更改推送到它

git remote add YOUR_USERNAME git@github.com:YOUR_USERNAME/laravel-route-browser.git
git push -u YOUR_USERNAME YOUR_BRANCH

最后,浏览到GitHub上的仓库并创建一个pull request。

(或者,您可以使用测试应用。)

在项目中使用您的Fork

要在项目中使用您的Fork,请按以下方式更新主项目的composer.json

{
    // ADD THIS:
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/YOUR_USERNAME/laravel-route-browser.git"
        }
    ],
    "require": {
        // UPDATE THIS:
        "thatobabusi/laravel-route-browser": "dev-YOUR_BRANCH"
    }
}

YOUR_USERNAME替换为您的GitHub用户名,将YOUR_BRANCH替换为分支名称(例如develop)。这会告诉Composer使用您的仓库而不是默认仓库。

单元测试

要运行单元测试

scripts/test.sh

要检查代码覆盖率

scripts/test-coverage.sh

然后打开test-coverage/index.html来查看结果。请注意,PHPUnit中可能导致结果不够准确的边缘情况

Laravel的新版本

composer.json中没有指定最大版本,因此不需要每6个月发布一个新的Laravel Route Browser版本。但是,需要更新此文件以运行对新版本进行测试

  • .travis.yml
    • matrix (Laravel版本)
    • php (PHP版本)
    • exclude (不受支持的组合)

如果需要,也更新

如果向后不兼容的更改导致Laravel或PHP的最低支持版本发生变化,请更新

发布新版本

本节仅适用于维护者。

  • 确保单元测试已更新并且覆盖率100%(最终)
  • 如果适用,更新测试应用,并手动测试它
  • 确保README是最新的,包括
  • 将更改合并到master分支(如果需要)
  • 将代码更改推送到GitHub(git push
  • 确保所有测试都通过
  • 标记发布(git tag 1.2.3
  • 推送标签(git push --tag

无技术支持

很抱歉,我无法提供任何技术支持,GitHub问题已禁用。这意味着我不会找出为什么它对您不起作用,我不会为您修复错误,也不会根据您的要求编写新功能——毕竟这是免费软件。

但是开源之美在于您可以随心所欲地使用它!您可以将其Fork、修复、改进和扩展。如果您不想维护自己的Fork,并且认为其他人会从您的更改中受益,您可以提交一个pull request,以便您的更改包含在下一个版本中。

如果您真的遇到了难题,我建议您

  1. 阅读并重新阅读此文件以及Laravel文档,看看是否错过了什么。
  2. 深入研究源代码,花些时间弄清楚它应该如何工作以及实际发生了什么。
  3. 尝试在全新的Laravel项目中重现问题,以防这是与其他包或您其他代码不兼容的问题。
  4. 如果您在一个团队中工作,请让您的同事帮忙调试。
  5. 请付给更有经验的人帮助您(或者如果您在公司工作,请让您的老板支付他们)。
  6. 尝试在Stack OverflowLaravel.io 论坛Laracasts 论坛上发布帖子(但我不能保证有人会回答 - 他们也没有报酬)。
  7. 尝试使用不同的包。
  8. 自己编写。

变更日志

Laravel路由浏览器使用语义化版本控制

v1.1.1(2020年2月26日星期三)

  • 修复Laravel 7中的过滤问题

v1.1.0(2020年1月17日星期五)

v1.0.1(2020年1月2日星期四)

  • 修复显示闭包中间件的问题
  • 修复显示在控制器中添加而不是在路由中添加的中间件问题

v1.0.0(2019年12月31日星期二)

  • 首次发布

许可证

MIT许可证

版权所有 © 2019-2020 Dave James Miller

本软件的副本和相关的文档文件(“软件”)的任何个人,免费授予不受限制地处理软件的权利,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本,并允许向提供软件的个人授予上述权利,但受以下条件约束

上述版权声明和本许可声明应包含在软件的副本或实质部分中。

软件按“原样”提供,不提供任何明示或暗示的保证,包括但不限于适销性、特定用途适用性和非侵权性保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任承担责任,无论这些责任是基于合同、侵权或其他方式引起的,是否与软件或其使用或其他方式有关。