Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/laravel-blade-comments
Add debug comments to your rendered output
https://github.com/spatie/laravel-blade-comments
blade development laravel
Last synced: 4 days ago
JSON representation
Add debug comments to your rendered output
- Host: GitHub
- URL: https://github.com/spatie/laravel-blade-comments
- Owner: spatie
- License: mit
- Created: 2023-04-28T12:32:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-29T12:22:37.000Z (7 months ago)
- Last Synced: 2024-05-01T11:45:37.657Z (7 months ago)
- Topics: blade, development, laravel
- Language: PHP
- Homepage: https://freek.dev/2500-a-laravel-package-to-quickly-see-which-html-is-rendered-by-which-blade-view
- Size: 757 KB
- Stars: 147
- Watchers: 4
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Add debug comments to your rendered output
[](https://packagist.org/packages/spatie/laravel-blade-comments)
[](https://github.com/spatie/laravel-blade-comments/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/spatie/laravel-blade-comments/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/spatie/laravel-blade-comments)
When looking at the HTML of a rendered page, it might not be obvious to you anymore which Blade view is responsible for which HTML. This package will add HTML before and after each rendered view, so you immediately know to which Blade view / component to go to change the output.
When you inspect a part of the page using your favourite browser's dev tools, you'll immediately see which Blade view rendered that particular piece of content. Here's a demo where we inspected the breadcrumbs on [our own company site](https://spatie.be). It is immediately clear that the breadcrumbs are rendered by the `front.pages.docs.partials.breadcrumbs` Blade view.
At the top of the HTML document, we'll also add some extra information about the topmost Blade view and the request.
## Support us
[
](https://spatie.be/github-ad-click/laravel-blade-comments)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require spatie/laravel-blade-comments --dev
```
You can optionally publish the config file with:
```bash
php artisan vendor:publish --tag="blade-comments-config"
```
This is the content of the published config file:
```php
return [
'enable' => env('APP_DEBUG'),
/*
* These classes provide regex for adding comments for
* various Blade directives.
*/
'blade_commenters' => [
Spatie\BladeComments\Commenters\BladeCommenters\BladeComponentCommenter::class,
Spatie\BladeComments\Commenters\BladeCommenters\AnonymousBladeComponentCommenter::class,
Spatie\BladeComments\Commenters\BladeCommenters\ExtendsCommenter::class,
Spatie\BladeComments\Commenters\BladeCommenters\IncludeCommenter::class,
Spatie\BladeComments\Commenters\BladeCommenters\IncludeIfCommenter::class,
Spatie\BladeComments\Commenters\BladeCommenters\IncludeWhenCommenter::class,
Spatie\BladeComments\Commenters\BladeCommenters\LivewireComponentCommenter::class,
Spatie\BladeComments\Commenters\BladeCommenters\LivewireDirectiveCommenter::class,
Spatie\BladeComments\Commenters\BladeCommenters\SectionCommenter::class,
],
/*
* These classes will add comments at the top of the response.
*/
'request_commenters' => [
Spatie\BladeComments\Commenters\RequestCommenters\ViewCommenter::class,
Spatie\BladeComments\Commenters\RequestCommenters\RouteCommenter::class,
],
/*
* This middleware will add extra information about the request
* to the start of a rendered HTML page.
*/
'middleware' => [
Spatie\BladeComments\Http\Middleware\AddRequestComments::class,
],
/*
* This class is responsible for calling the registered Blade commenters.
* In most case, you don't need to modify this class.
*/
'precompiler' => Spatie\BladeComments\BladeCommentsPrecompiler::class,
'excludes' => [
/**
* Add includes you don't want to be affected by the package here.
* For example:
* 'styles.theme',
* 'partials.sidebar',
*/
'includes' => [
]
]
];
```
## Usage
After the package is installed, you'll immediately see that HTML comments are injected at the start and end of every Blade view.
## Excluding views
Sometimes you might not want to have an HTML comment being wrapped around an include. For example when you use a partial to add some CSS to a page.
In these cases you can add views to the `excludes.includes` array in the config file.
### Using your own Blade Commenters
You can easily extend the package to add more comments. In the `blade_commenters` key of the `blade_commenters` config file, you can add your own `BladeCommenter`. A `BladeCommenter` is any class that implements the following interface:
```php
namespace Spatie\BladeComments\Commenters\BladeCommenters;
interface BladeCommenter
{
/*
* Should return a regex pattern that will be used
* in preg_replace.
*/
public function pattern(): string;
/*
* Should return a replacement string that will be
* used in preg_replace.
*/
public function replacement(): string;
}
```
Take a look at the `BladeCommenters` that ship with the package for an example.
### Using your own request commenters
The package adds useful information about the request at the top of the HTML page. This is done by the so called request commenters . You'll find the default request commenters in the `request_commenters` key of the `blade-comments` config file.
You can add your own request commenters there. A `RequestCommentor` is any class that implements the following interface:
```php
namespace Spatie\BladeComments\Commenters\RequestCommenters;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
interface RequestCommenter
{
public function comment(Request $request, Response $response): ?string;
}
```
If the `comment` function returns a string, it will be injected at the top of the HTML document. Take a look at the request commenters that ship with the package for an example.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Tim Van Dijck](https://github.com/timvandijck)
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.