akankov/laravel-compress-html

Laravel integration for the akankov/html-min HTML minifier: Blade @htmlmin directive, response middleware, and a publishable config-driven service provider.

Maintainers

Package info

github.com/akankov/laravel-compress-html

pkg:composer/akankov/laravel-compress-html

Fund package maintenance!

Ko Fi

Statistics

Installs: 76

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v0.2.0 2026-05-07 20:03 UTC

This package is auto-updated.

Last update: 2026-05-07 20:04:19 UTC


README

CI Latest Stable Version Monthly Downloads Dependents License

laravel-compress-html

Laravel integration for akankov/html-min — adds a Blade @htmlmin block directive, an opt-in HTML response middleware, and a publishable config-driven service provider.

Requirements

  • PHP 8.3.* || 8.4.* || 8.5.*
  • Laravel 11.x, 12.x, or 13.x
  • akankov/html-min ^2.5

Install

composer require akankov/laravel-compress-html

The service provider is registered automatically via Laravel's package auto-discovery (extra.laravel.providers in composer.json); no manual config/app.php edit is needed.

Optionally publish the config file to tune the 29 minifier toggles:

php artisan vendor:publish --tag=htmlmin-config

This drops config/htmlmin.php into your application — every key defaults to the engine's default, so you only need to edit the ones you want to flip.

Blade directive

@htmlmin
<div>
    <p>{{ $user->name }}</p>
</div>
@endhtmlmin

The block captures rendered output, then minifies it. Variables interpolated via {{ $expr }} are escaped by Blade before the buffer reaches the minifier, so it's safe to interpolate user data inside.

Response middleware

Opt-in: the service provider does not push the middleware onto the global stack — register it explicitly where you want it.

Globally, in bootstrap/app.php (Laravel 11+):

use Akankov\LaravelCompressHtml\Http\MinifyHtmlResponseMiddleware;
use Illuminate\Foundation\Configuration\Middleware;

return Application::configure(basePath: dirname(__DIR__))
    // …
    ->withMiddleware(function (Middleware $middleware): void {
        $middleware->append(MinifyHtmlResponseMiddleware::class);
    })
    // …
    ->create();

Or per-route / per-group:

use Akankov\LaravelCompressHtml\Http\MinifyHtmlResponseMiddleware;

Route::middleware(MinifyHtmlResponseMiddleware::class)
    ->group(function (): void {
        // routes whose responses should be minified
    });

The middleware only touches Illuminate\Http\Response instances whose Content-Type first segment is text/html. JSON, streamed, and binary responses pass through unchanged.

Configuration

Every key in config/htmlmin.php is a snake_case mirror of a property on Akankov\HtmlMin\Config\MinifierOptions. The provider converts them with Str::camel() when constructing the options object, so:

'remove_comments'    => true,    // → MinifierOptions::$removeComments
'sum_up_whitespace'  => true,    // → MinifierOptions::$sumUpWhitespace
'optimize_attributes' => true,   // → MinifierOptions::$optimizeAttributes

See the published config file for the full list of 29 keys with their defaults.

Tests

composer install
vendor/bin/phpunit
make ci   # cs-check + phpstan + rector-check + test

License

MIT