Skip to content

Latest commit

 

History

History
157 lines (108 loc) · 4.34 KB

README.md

File metadata and controls

157 lines (108 loc) · 4.34 KB
Raw

HtmlMin: Laravel package for HTML minification

Very simple (and very fast) html compression.

Packagist Version Scrutinizer Quality Score GitHub Tests Status GitHub Code Style Status PHP Version Support License

Features:

  • Removing extra whitespaces
  • Removing html comments (works correctly with livewire/livewire comments)
  • Skip textarea, pre and script elements
  • Very fast. See benchmark

Requirements

  • PHP 7.4 - 8.3
  • Laravel 8.x - 11.x

Installation

You can install the package via composer:

composer require abordage/laravel-html-min

You can publish the config file with:

php artisan vendor:publish --tag="html-min-config"

Usage

To enable compression just register middleware:

// app/Http/Kernel.php

protected $middleware = [
    'web' => [
        // other middleware
        
        \Abordage\LaravelHtmlMin\Middleware\HtmlMinify::class,
    ],
    
    // ...
];

It's all. Optionally you can change the settings in config/html-min.php

Configuration

return [
    /*
    |--------------------------------------------------------------------------
    | Enable Html Min
    |--------------------------------------------------------------------------
    */
    'enable' => env('HTML_MINIFY', true),

    /*
    |--------------------------------------------------------------------------
    | Find DOCTYPE in document
    |--------------------------------------------------------------------------
    */
    'find_doctype_in_document' => true,

    /*
    |--------------------------------------------------------------------------
    | Remove whitespace between tags
    |--------------------------------------------------------------------------
    */
    'remove_whitespace_between_tags' => true,

    /*
    |--------------------------------------------------------------------------
    | Remove blank lines in script elements
    |--------------------------------------------------------------------------
    */
    'remove_blank_lines_in_script_elements' => false,
];

Benchmark

See abordage/html-min-benchmark

Testing

composer test:all

or

composer test:phpunit
composer test:phpstan
composer test:phpcsf

or see https://github.com/abordage/laravel-html-min/actions/workflows/tests.yml

Feedback

If you have any feedback, comments or suggestions, please feel free to open an issue within this repository.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.