Laravel Compress HTML

https://github.com/akankov/laravel-compress-html
Admin
Laravel Compress HTML is a Laravel integration package that provides HTML minification through a...
Tokens:7,624
Snippets:97
Trust Score:5.4
License:MIT
Update:5 months ago
Show doc for...
Tokens:
Raw
### Configuration Options Example

Source: https://github.com/akankov/laravel-compress-html/blob/main/README.md

Examples of how configuration keys in config/htmlmin.php map to MinifierOptions properties.

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

--------------------------------

### Install Project Dependencies

Source: https://github.com/akankov/laravel-compress-html/blob/main/CONTRIBUTING.md

Run this command in the repository root to install all necessary Composer dependencies for development.

```bash
composer install
```

--------------------------------

### Composer Require and Vendor Publish Commands

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

Commands to install the package via Composer and publish its configuration file to a fresh Laravel application. This is a verification step for the package setup.

```bash
composer require
akankov/laravel-compress-html
```

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

--------------------------------

### Run Tests

Source: https://github.com/akankov/laravel-compress-html/blob/main/README.md

Commands to install dependencies, run unit tests, and execute the CI pipeline checks.

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

--------------------------------

### Install laravel-compress-html

Source: https://github.com/akankov/laravel-compress-html/blob/main/README.md

Use Composer to require the package. The service provider is auto-discovered.

```sh
composer require akankov/laravel-compress-html
```

--------------------------------

### Registering MinifyHtmlResponseMiddleware Globally

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

This example shows how to register the MinifyHtmlResponseMiddleware globally in your Laravel application by adding it to the protected $middleware property in app/Http/Kernel.php.

```php
// app/Http/Kernel.php — global
protected $middleware = [
    // ... existing ...
    \Akankov\LaravelCompressHtml\Http\MinifyHtmlResponseMiddleware::class,
];
```

--------------------------------

### HtmlMinCompiler::open() - Blade Directive Start

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

This method is used to start the output buffering for the @htmlmin Blade directive. It should be called at the beginning of the directive block.

```php
final class HtmlMinCompiler
{
    public static function open(): string
    {
        return '<?php ob_start(); ?>';
    }

    public static function close(): string
    {
        // app(HtmlMin::class) so the directive picks up the bound singleton
        return '<?php echo app(\Akankov\HtmlMin\HtmlMin::class)->minify(ob_get_clean()); ?>';
    }
}
```

--------------------------------

### Blade Directive Usage for HTML Minification

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

Example of using the custom Blade directive to wrap content that should be minified. Ensures that user input remains escaped while the surrounding HTML is compressed.

```blade
@htmlmin … @endhtmlmin
```

--------------------------------

### Publish Configuration File

Source: https://context7.com/akankov/laravel-compress-html/llms.txt

Optionally publish the configuration file to customize minifier toggles.

```bash
php artisan vendor:publish --tag=htmlmin-config
# → creates config/htmlmin.php in your application
```

--------------------------------

### Publish Configuration

Source: https://github.com/akankov/laravel-compress-html/blob/main/README.md

Optionally publish the configuration file to customize minifier settings.

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

--------------------------------

### Publish HtmlMin configuration file

Source: https://context7.com/akankov/laravel-compress-html/llms.txt

Publish the configuration file using the `vendor:publish` Artisan command to make all 29 minifier options editable in `config/htmlmin.php`.

```bash
// Publish the config so all 29 options are editable
// php artisan vendor:publish --tag=htmlmin-config
// → config/htmlmin.php
```

--------------------------------

### HtmlMin Configuration Options Reference

Source: https://context7.com/akankov/laravel-compress-html/llms.txt

Reference for all 29 minifier toggles available in `config/htmlmin.php`. These snake_case keys are mapped to `MinifierOptions`'s camelCase properties. Options not present fall back to engine defaults.

```php
// config/htmlmin.php (published via `php artisan vendor:publish --tag=htmlmin-config`)
return [
    // DOM-based attribute and tag optimisation (recommended on)
    'optimize_via_html_dom_parser'                  => true,
    'optimize_attributes'                            => true,

    // Whitespace handling
    'sum_up_whitespace'                              => true,   // collapse runs of whitespace to one space
    'remove_whitespace_around_tags'                  => false,  // aggressive: remove ALL space around tags
    'remove_spaces_between_tags'                     => false,

    // Comment handling
    'remove_comments'                                => true,

    // Quote and tag omission
    'remove_omitted_quotes'                          => true,
    'remove_omitted_html_tags'                       => true,

    // Protocol stripping
    'remove_http_prefix_from_attributes'             => false,
    'remove_https_prefix_from_attributes'            => false,
    'keep_http_and_https_prefix_on_external_attributes' => false,

    // Deprecated / redundant attribute removal
    'remove_deprecated_script_charset_attribute'     => true,
    'remove_default_attributes'                      => false,
    'remove_deprecated_anchor_name'                  => true,
    'remove_deprecated_type_from_stylesheet_link'    => true,
    'remove_deprecated_type_from_style_and_link_tag' => true,
    'remove_default_media_type_from_style_and_link_tag' => true,
    'remove_default_type_from_button'                => false,
    'remove_deprecated_type_from_script_tag'         => true,

    // Input / attribute value normalisation
    'remove_value_from_empty_input'                  => true,
    'remove_empty_attributes'                        => true,

    // Attribute ordering (deterministic output for caching)
    'sort_css_class_names'                           => true,
    'sort_html_attributes'                           => true,

    // Error resilience and special-syntax pass-through
    'keep_broken_html'                               => false,
    'local_domains'                                  => [],
    'special_html_comments_starting_with'            => [],     // preserve matching HTML comments
    'special_html_comments_ending_with'              => [],
    'special_script_tags'                            => null,
    'template_logic_syntax_in_special_script_tags'  => null,
];
```

--------------------------------

### Run Full CI Pipeline

Source: https://github.com/akankov/laravel-compress-html/blob/main/CONTRIBUTING.md

This command executes the entire continuous integration pipeline locally, ensuring all checks pass before submitting changes.

```bash
make ci
```

--------------------------------

### Run Full PHPUnit Test Suite

Source: https://github.com/akankov/laravel-compress-html/blob/main/CLAUDE.md

Executes the complete suite of PHPUnit tests, including all assertions.

```bash
vendor/bin/phpunit                              # full suite (12 tests, 24 assertions)
```

--------------------------------

### Run Continuous Integration Pipeline

Source: https://github.com/akankov/laravel-compress-html/blob/main/CLAUDE.md

Executes the full CI pipeline, including code style checks, PHPStan analysis, Rector checks, and tests.

```bash
make ci                                         # cs-check + phpstan + rector-check + test
```

--------------------------------

### Project Structure for Laravel Compress HTML

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

Overview of the directory and file structure for the laravel-compress-html package.

```tree
laravel-compress-html/
├── composer.json
├── README.md
├── CHANGELOG.md
├── LICENSE
├── Makefile
├── phpunit.xml.dist
├── phpstan.neon
├── .php-cs-fixer.dist.php
├── .github/
│   └── workflows/
│       └── ci.yml
├── config/
│   └── htmlmin.php                     # publishable defaults
├── src/
│   ├── HtmlMinServiceProvider.php
│   ├── Blade/
│   │   └── HtmlMinCompiler.php         # the @htmlmin block compiler
│   ├── Http/
│   │   └── MinifyHtmlResponseMiddleware.php
│   └── Console/
│       └── HtmlMinCheckCommand.php     # stretch goal
└── tests/
    ├── TestCase.php                    # extends Orchestra\Testbench\TestCase
    ├── HtmlMinServiceProviderTest.php
    ├── Blade/
    │   └── HtmlMinDirectiveTest.php
    ├── Http/
    │   └── MinifyHtmlResponseMiddlewareTest.php
    └── Console/
        └── HtmlMinCheckCommandTest.php
```

--------------------------------

### Add Middleware to Global Stack

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

Demonstrates how to integrate the HTML minification middleware into the global HTTP request pipeline. This is verified by checking the byte-size reduction of HTML responses.

```php
Adding the middleware to the global stack reduces the byte-size of HTML responses end-to-end via a real Http::get() call.
```

--------------------------------

### Run HTML Minifier Check Artisan Command

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

Use this command to minify a specific HTML file and view the compression savings. It's useful for quick checks and in CI environments. This command is part of Phase 4.

```bash
php artisan html-min:check path/to/file.html
```

--------------------------------

### Run Local Development Checks

Source: https://github.com/akankov/laravel-compress-html/blob/main/CONTRIBUTING.md

Execute these commands to perform various local checks, including running tests, static analysis, and code formatting.

```bash
vendor/bin/phpunit
```

```bash
vendor/bin/phpstan analyse
```

```bash
vendor/bin/php-cs-fixer fix --dry-run --diff
```

```bash
vendor/bin/rector process --dry-run
```

--------------------------------

### Artisan Command for HTML Minification Check

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

Verifies the functionality of the `html-min:check` Artisan command by reporting the percentage reduction in file size. This check is performed on a sample HTML file.

```bash
php artisan html-min:check fixtures/big.html reports a percentage reduction (if Phase 4 ships).
```

--------------------------------

### Register MinifyHtmlResponseMiddleware Globally (Laravel 11+)

Source: https://context7.com/akankov/laravel-compress-html/llms.txt

Register the middleware globally in bootstrap/app.php to automatically minify HTML responses. It's appended last to compress the fully-rendered output.

```php
use Akankov\LaravelCompressHtml\Http\MinifyHtmlResponseMiddleware;
use Illuminate\Foundation\Application;
use Illuminate\Foundation\Configuration\Middleware;

return Application::configure(basePath: dirname(__DIR__))
    ->withRouting(web: __DIR__ . '/../routes/web.php')
    ->withMiddleware(function (Middleware $middleware): void {
        // Appended last so it compresses the fully-rendered response.
        $middleware->append(MinifyHtmlResponseMiddleware::class);
    })
    ->create();
```

--------------------------------

### Composer Manifest for Laravel Compress HTML

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

Defines the package name, description, type, license, required PHP and Laravel versions, development dependencies, autoloading configuration, and Laravel service provider.

```json
{
  "name": "akankov/laravel-compress-html",
  "description": "Laravel integration for the akankov/html-min HTML minifier (Blade directive, response middleware, service provider).",
  "type": "library",
  "license": "MIT",
  "require": {
    "php": "8.3.* || 8.4.* || 8.5.*",
    "akankov/html-min": "^2.5",
    "illuminate/support": "^11.0 || ^12.0",
    "illuminate/contracts": "^11.0 || ^12.0",
    "illuminate/http": "^11.0 || ^12.0",
    "illuminate/view": "^11.0 || ^12.0"
  },
  "require-dev": {
    "orchestra/testbench": "^9.0 || ^10.0",
    "phpunit/phpunit": "^11.0 || ^12.0",
    "phpstan/phpstan": "^2.1",
    "friendsofphp/php-cs-fixer": "^3.65",
    "rector/rector": "^2.0"
  },
  "autoload": {
    "psr-4": {
      "Akankov\LaravelCompressHtml\": "src/"
    }
  },
  "autoload-dev": {
    "psr-4": {
      "Akankov\LaravelCompressHtml\Tests\": "tests/"
    }
  },
  "extra": {
    "laravel": {
      "providers": [
        "Akankov\LaravelCompressHtml\HtmlMinServiceProvider"
      ]
    }
  },
  "config": {
    "platform": { "php": "8.3" },
    "sort-packages": true
  }
}
```

--------------------------------

### Resolve and use HtmlMin instance

Source: https://context7.com/akankov/laravel-compress-html/llms.txt

Resolve the pre-configured `HtmlMin` instance from the container anywhere in the application. This instance is configured based on `config/htmlmin.php`.

```php
// Resolve the pre-configured HtmlMin instance anywhere in the application
use Akankov\HtmlMin\HtmlMin;

$minifier = app(HtmlMin::class);
$minified  = $minifier->minify('<div>  <p>hello</p>  </div>');
// → '<div><p>hello</p></div>'
```

--------------------------------

### Check HTML File Minification with Artisan

Source: https://context7.com/akankov/laravel-compress-html/llms.txt

Use the `html-min:check` Artisan command to minify an HTML file in memory and view the byte count difference. This is useful for CI checks or quick developer verification.

```bash
# Basic usage
php artisan html-min:check resources/views/pages/home.html
#  INFO  Reduced from 12.4 KB to 9.1 KB (-26.6%)
```

--------------------------------

### Check HTML file in CI pipeline

Source: https://context7.com/akankov/laravel-compress-html/llms.txt

Use the `html-min:check` Artisan command in a CI pipeline. An exit code of 0 indicates success, while 1 indicates failure.

```bash
php artisan html-min:check public/cached/index.html && echo "OK" || echo "FAILED"
```

```bash
# Missing or unreadable file returns exit code 1
php artisan html-min:check /does/not/exist.html
#  ERROR  Cannot read input file: /does/not/exist.html
# exit code: 1
```

--------------------------------

### Register Response Middleware Globally (Laravel 11+)

Source: https://github.com/akankov/laravel-compress-html/blob/main/README.md

Add the MinifyHtmlResponseMiddleware to the global middleware stack in bootstrap/app.php to minify all HTML responses.

```php
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();
```

--------------------------------

### Artisan Command for Checking File Minification

Source: https://github.com/akankov/laravel-compress-html/blob/main/CLAUDE.md

This Artisan command reads a specified file, minifies its content in memory, and prints the byte savings. It does not modify the original file.

```bash
php artisan html-min:check FILE
```

--------------------------------

### Programmatically check HTML file

Source: https://context7.com/akankov/laravel-compress-html/llms.txt

Equivalent programmatic invocation using `Artisan::call` for use in tests or custom commands. The output and exit code can be inspected.

```php
// Equivalent programmatic invocation (e.g., in a test or custom command)
use Illuminate\Support\Facades\Artisan;

$exitCode = Artisan::call('html-min:check', ['file' => public_path('index.html')]);
$output   = Artisan::output();
// $output: " INFO  Reduced from 8.2 KB to 6.0 KB (-26.8%)\n"
// $exitCode: 0
```

--------------------------------

### Register Response Middleware Per-Route/Group

Source: https://github.com/akankov/laravel-compress-html/blob/main/README.md

Apply the MinifyHtmlResponseMiddleware to specific routes or route groups to minify only their responses.

```php
use Akankov\LaravelCompressHtml\Http\MinifyHtmlResponseMiddleware;

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

--------------------------------

### Inspect or override MinifierOptions at runtime

Source: https://context7.com/akankov/laravel-compress-html/llms.txt

Inspect or override `MinifierOptions` at runtime, which is particularly useful in tests. Remember to bust the singleton cache if you change configuration values.

```php
// Inspect or override options at runtime (useful in tests)
use Akankov\HtmlMin\Config\MinifierOptions;

config(['htmlmin.remove_comments' => false]);
app()->forgetInstance(MinifierOptions::class); // bust singleton cache

$options = app(MinifierOptions::class);
var_dump($options->removeComments); // bool(false)
```

--------------------------------

### Register MinifyHtmlResponseMiddleware Per Route Group

Source: https://context7.com/akankov/laravel-compress-html/llms.txt

Apply the middleware to specific route groups in routes/web.php to control which HTML responses are minified. Non-HTML or streamed responses are unaffected.

```php
use Akankov\LaravelCompressHtml\Http\MinifyHtmlResponseMiddleware;
use Illuminate\Support\Facades\Route;

// Only apply to public-facing HTML pages, not the API or admin panel.
Route::middleware(MinifyHtmlResponseMiddleware::class)
    ->group(function (): void {
        Route::get('/', [HomeController::class, 'index']);
        Route::get('/about', [PageController::class, 'about']);
    });

// Responses with Content-Type: application/json pass through untouched.
Route::prefix('api')->group(function (): void {
    Route::get('/users', [UserController::class, 'index']); // NOT minified
});

/*
  text/html response  → minified   (comments stripped, whitespace collapsed)
  application/json    → unchanged
  StreamedResponse    → unchanged  (setContent() is not available)
  no Content-Type     → unchanged
*/
```

--------------------------------

### CI Workflow Matrix Configuration

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

Defines the matrix for Continuous Integration jobs, specifying combinations of PHP and Laravel versions to test against. Ensures compatibility across different environments.

```yaml
matrix:
  php:
    - "8.3"
    - "8.4"
    - "8.5"
  laravel:
    - "11.x"
    - "12.x"
```

--------------------------------

### Dry Run PHP-CS-Fixer

Source: https://github.com/akankov/laravel-compress-html/blob/main/CLAUDE.md

Checks code style compliance with PSR-12 and risky rules, showing a diff without applying changes.

```bash
vendor/bin/php-cs-fixer fix --dry-run --diff    # PSR-12 + risky + 8.x migration
```

--------------------------------

### Analyze Code with PHPStan

Source: https://github.com/akankov/laravel-compress-html/blob/main/CLAUDE.md

Performs static analysis on the code using PHPStan at the maximum level, including Larastan.

```bash
vendor/bin/phpstan analyse                      # level max + Larastan
```

--------------------------------

### Run Specific PHPUnit Test

Source: https://github.com/akankov/laravel-compress-html/blob/main/CLAUDE.md

Executes a specific PHPUnit test case identified by its name.

```bash
vendor/bin/phpunit --filter testBladeInterpolationStaysEscaped
```

--------------------------------

### MinifyHtmlResponseMiddleware Implementation

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

This middleware intercepts HTTP responses and minifies their content if the Content-Type is 'text/html'. It ensures that streamed or non-HTML responses are not modified.

```php
final class MinifyHtmlResponseMiddleware
{
    public function __construct(private HtmlMin $minifier) {}

    public function handle(Request $request, Closure $next): Response
    {
        $response = $next($request);

        if (!$this->shouldMinify($response)) {
            return $response;
        }

        $response->setContent(
            $this->minifier->minify((string) $response->getContent()),
        );

        return $response;
    }

    private function shouldMinify(SymfonyResponse $response): bool
    {
        if (!$response instanceof Response) {
            return false; // streamed/binary responses pass through
        }
        $type = strtolower(trim(explode(';', $response->headers->get('Content-Type', ''), 2)[0]));
        return $type === 'text/html';
    }
}
```

--------------------------------

### Use Blade @htmlmin Directive

Source: https://github.com/akankov/laravel-compress-html/blob/main/README.md

Wrap content within the @htmlmin directive to minify it. Blade interpolations are safe as they are escaped before minification.

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

--------------------------------

### Blade Directive for HTML Minification

Source: https://github.com/akankov/laravel-compress-html/blob/main/CLAUDE.md

This Blade directive buffers and minifies rendered Blade output after interpolations are escaped. Ensure the `HtmlMinServiceProvider` is registered.

```php
<?php ob_start(); ?>
// ... Blade content ...
<?php echo app(HtmlMin::class)->minify(ob_get_clean()); ?>
```

--------------------------------

### Registering @htmlmin Blade Directives

Source: https://github.com/akankov/laravel-compress-html/blob/main/PLAN.md

This code registers the 'htmlmin' and 'endhtmlmin' directives with Laravel's Blade engine. It uses the HtmlMinCompiler class to provide the opening and closing logic for the directive.

```php
Blade::directive('htmlmin', static fn (): string => HtmlMinCompiler::open());
Blade::directive('endhtmlmin', static fn (): string => HtmlMinCompiler::close());
```

--------------------------------

### Dry Run Rector

Source: https://github.com/akankov/laravel-compress-html/blob/main/CLAUDE.md

Applies Rector rules for PHP 8.3, type declarations, and dead code detection, showing changes without applying them.

```bash
vendor/bin/rector process --dry-run             # UP_TO_PHP_83 + TYPE_DECLARATION + DEAD_CODE
```
Tokens:
Raw