zae / laravel-view-xray
深入了解您的 Laravel 视图。
Requires
- php: ^7.0
- illuminate/support: ^5.5|^5.6|^5.7
Requires (Dev)
- orchestra/testbench: ^3.5|^3.6
- phpunit/phpunit: ^6.0|^7.0
- spatie/phpunit-snapshot-assertions: ^1.3
This package is auto-updated.
Last update: 2024-09-10 09:37:08 UTC
README
当您的 Laravel 项目增长时,视图也会增长。有时可能很难确定输出 HTML 的哪个部分是由哪个模板渲染的。使用此包,您可以深入了解 Laravel 视图,并找出哪个模板负责输出 HTML 的哪个部分。
安装
您可以通过 composer 安装此包
composer require zae/laravel-view-xray --dev
默认情况下已启用此包 - 您只需在浏览器中访问您的应用程序并按 Xray 快捷键即可。
- Windows: CTRL + Shift + X
- OSX: CMD + Shift + X
这将切换 Xray 视图,您可以看到哪个视图(以及可选的分区)渲染了可视输出。
禁用 Xray
您可以通过将环境变量 XRAY_ENABLED
设置为 false
来禁用 Xray。
排除视图
如果您想排除某些视图被 Xray 处理,您可以通过将它们添加到配置文件中来实现。
使用以下命令发布配置文件:
php artisan vendor:publish --provider=BeyondCode\\ViewXray\\ViewXrayServiceProvider
这将发布一个名为 xray.php
的文件到您的 config
文件夹。
这是配置文件的内容
<?php return [ /* * Determines if the Xray package should be enabled. */ 'enabled' => env('XRAY_ENABLED', true), /* * If you want to exclude certain views from being processed by Xray, * you can list them here. Be aware that the check only applies to the * root views that you add here. If these views include other views * themselves, they need to be excluded manually. */ 'excluded' => [ // ], ];
只需将您要排除的视图名称放入 excluded
数组中。
常见问题解答
- 这个包也支持 VueJS 吗?
是的,这个包可以与 VueJS 结合使用,但您需要在 VueJS 应用中启用注释。此包通过在渲染的视图中添加特定的 HTML 注释来工作,并使用这些注释来查找渲染 HTML 的边界框。VueJS 默认在渲染之前删除 HTML 注释。
您可以通过将 comments
设置为 true
来在 VueJS 应用中启用 HTML 注释
let app = new Vue({ el: '#content', comments: true });
测试
composer test
更新日志
有关最近更改的更多信息,请参阅 更新日志。
贡献
有关详细信息,请参阅 贡献指南。
安全性
如果您发现任何安全问题,请通过电子邮件 ezra@tsdme.nl 而不是使用问题跟踪器。
鸣谢
本项目受到 xray-rails 的启发。
许可
MIT 许可证(MIT)。有关更多信息,请参阅 许可文件。