Repository files navigation

Laravel HTMLMin is currently maintained byRaza Mehdi, and is a simple HTML minifier forLaravel 5. It utilises Mr Clay'sMinify package to minify entire responses, but can also minify blade at compile time. Feel free to check out thechange log,releases,license, andcontribution guidelines.

Laravel HTMLMin requiresPHP 5.5+. This particular version supports Laravel 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8 and 6.0 only.

To get the latest version, simply require the project usingComposer:

$ composer require htmlmin/htmlmin

Once installed, you need to register theHTMLMin\HTMLMin\HTMLMinServiceProvider service provider in yourconfig/app.php, and optionally alias our facade:

'HTMLMin' =>HTMLMin\HTMLMin\Facades\HTMLMin::class,

Laravel HTMLMin supports optional configuration.

To get started, you'll need to publish all vendor assets:

$ php artisan vendor:publish

This will create aconfig/htmlmin.php file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.

There are three config options:

This option ('blade') enables minification of the blade views as they are compiled. These optimizations have little impact on php processing time as the optimizations are only applied once and are cached. This package will do nothing by default to allow it to be used without minifying pages automatically. The default value for this setting isfalse.

This option ('force') forces blade minification on views where there such minification may be dangerous. This should only be used if you are fully aware of the potential issues this may cause. Obviously, this setting is dependent on blade minification actually being enabled. The default value for this setting isfalse.

This option ('ignore') is where you can specify paths, which you don't want to minify. A sensible default for this setting is provided.

This is the class of most interest. It is bound to the ioc container as'htmlmin' and can be accessed using theFacades\HTMLMin facade. There are four public methods of interest.

The'blade' method will parse a string as blade and minify it as quickly as possible. This is method the compiler class uses when blade minification is enabled.

The'css' and'js' methods will parse a string as css/js and will minify it using Mr Clay'sMinify package.

The'html' method will parse a string as html and will minify it as best as possible using Mr Clay'sMinify package. It will also be able to minify inline css and js. This is the method that is used by the minification middleware.

This facade will dynamically pass static method calls to the'htmlmin' object in the ioc container which by default is theHTMLMin class.

This interface defines the public method a minifier class must implement. Such a class must only provide a'render' method which takes one parameter as a string, and should return a string. This package ships with 4 implementations of this interface, but these classes are not intended for public use, so have no been documented here. You can see the sourcehere.

You may put theHTMLMin\HTMLMin\Http\Middleware\MinifyMiddleware middleware in front of your routes to live minify them. Note that this middleware allows you to achieve maximal results, though at a performance cost because of it running on each request instead of once like the built in blade minification. It may be useful for you to take a look at thesource for this, read thetests, or check out Laravel'sdocumentation if you need to.

As well as being able to skip folders using the ('ignore') config, there are occasions where you will want to 'skip' single files.

Just add the following comment to each file you want to skip:

<!-- skip.minification -->

Please note that if you use ('force') option in the config it will not work.

This class contains no public methods of interest. This class should be added to the providers array inconfig/app.php. This class will setup ioc bindings and register automatic blade minification based on the config.

There are other classes in this package that are not documented here (such as the compiler class). This is because they are not intended for public use and are used internally by this package.

Please note to clear view cache to see changes.

php artisan view:clear

If you discover a security vulnerability within this package, please send an e-mail to Raza Mehdi atsrmk@outlook.com. All security vulnerabilities will be promptly addressed.

Laravel HTMLMin is licensed underThe MIT License (MIT).