README

Asset Optimise is a powerful and lightweight Laravel package designed to enhance the performance of your web applications by optimizing front-end assets. This package automatically minifies HTML, CSS, and JavaScript code to reduce file sizes, improve page load times and save bandwidth.

Key Features:

Minifies HTML, CSS, and JavaScript for faster loading. Read More...
Configurable to skip minification for inline CSS, inline JavaScript and HTML comments.
Supports excluding specific sections of code from being minified using custom HTML comments. Read More...
Supports excluding specific routes urls paths from being minified. Read More...
Configurable to skip minification for specific application Environment. Read More...
Easy integration with Laravel's middleware system. Read More...
Supports Email (HTML, CSS, and JavaScript) minification. Read More...
Support multiple assets (CSS or JavaScript) merge and minify. Read More...
Support asset (CSS or JavaScript) minification. Read More...
Extensible for future updates, including image compression and CDN integration.

Installation

Asset Optimise for Laravel requires PHP 8.0 or higher. This particular version supports Laravel 9.x, 10.x, and 11.x.

To get the latest version, simply require the project using Composer:

composer require debjyotikar001/asset-optimise

Configuration

Asset Optimise for Laravel supports optional configuration. To get started, you'll need to publish all vendor assets:

php artisan vendor:publish --provider="Debjyotikar001\AssetOptimise\AssetOptimiseServiceProvider"

This will create a config/assetoptimise.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.

Register the Middleware

In order to add asset optimization functionality in Laravel, you need to add the Minifier middleware.

(Laravel 10 or older)

In app/Http/Kernel.php file:

protected $middleware = [
  // other middleware
  \Debjyotikar001\AssetOptimise\Middleware\Minifier::class,
];

protected $middleware = [
  // other middleware
  'assetOptimise',
];

You can use the middleware class or middleware alias assetOptimise in web middleware or route.

(Laravel 11 or newer)

In bootstrap/app.php file:

->withMiddleware(function (Middleware $middleware) {
  $middleware->web(append: [
    // other middleware
    \Debjyotikar001\AssetOptimise\Middleware\Minifier::class,
  ]);
})

->withMiddleware(function (Middleware $middleware) {
  $middleware->web(append: [
    // other middleware
    'assetOptimise',
  ]);
})

You can use the middleware class or middleware alias assetOptimise in web middleware or route.

Usage

This is how you can use AssetOptimise for Laravel in your project.

Enable

You must set true on enabled in the config/assetoptimise.php file enable asset optimization functionality. For example:

'enabled' => env('ASSETOPTIMISE_ENABLED', true),

Allowed Environments

If you want to disable it in specific environments such as during local development or testing to simplify debugging. Then set environments values in a comma (,) separated string in the config/assetoptimise.php file, default local,production,staging. For example:

'allowed_envs' => env('ASSETOPTIMISE_ALLOWED_ENVS', 'local,production,staging'),

Skip specific sections of code

If you want to skip specific sections of code from being minified using  ...  HTML comments. This sections supports HTML, CSS and JavaScript code. For example:

<!-- no-optimise -->
<style>
  /* Don't optimise this CSS code */
  h1 {
    color: black;
    font-size: 40px;
  }

  p {
    color: red;
    font-size: 24px;
  }
</style>

<h1>Asset Optimise</h1>
<p>Don't optimise this HTML code</p>

<script>
  // Don't optimise this JavaScript code
  alert("Asset Optimise: Don't optimise this JavaScript code");
</script>
<!-- /no-optimise -->

Skip Inline CSS

If you want to skip inline CSS (within <style> tags in your HTML) optimization. Then set true on skip_css in the config/assetoptimise.php file, default false. For example:

'skip_css' => env('ASSETOPTIMISE_SKIP_CSS', true),

Skip Inline JavaScript

If you want to skip inline JavaScript (within <script> tags in your HTML) optimization. Then set true on skip_js in the config/assetoptimise.php file, default false. For example:

'skip_js' => env('ASSETOPTIMISE_SKIP_JS', true),

Skip HTML Comments

If you want to skip all HTML comments from the output. Then set true on skip_comment in the config/assetoptimise.php file, default false. For example:

'skip_comment' => env('ASSETOPTIMISE_SKIP_COMMENT', true),

Skip or Ignore specific Routes Urls

If you want to skip or ignore specific routes urls, then you have to set paths in the config/assetoptimise.php file. You can use '*' as wildcard. For example:

'skip_urls' => [
    '/',
    'about',
    'user/*',
    '*_dashboard',
    '*/download/*',
  ],

Example URLs:

/: Home URL will be excluded from minification.
about: This exact URL will be excluded from minification.
user/*: Any URL starting with user/ (like user/profile, user/settings) will be excluded.
*_dashboard: Any URL ending with _dashboard (like admin_dashboard, user_dashboard) will be excluded.
*/download/*: Any URL has download (like pdf/download/001, image/download/debjyotikar001) will be excluded.

Enable Email Optimise

You must set true on email_enabled in the config/assetoptimise.php file to enable asset optimization functionality for emails. For example:

'email_enabled' => env('ASSETOPTIMISE_EMAIL_ENABLED', true),

Merge and Minify multiple assets (CSS or JavaScript)

You can use mergeAssets() helper function that allows you to merge and minify your multiple CSS or JavaScript files. This function will handle both public and resources directories, storing the final output file in your storage folder for optimized use. It reduces the number of HTTP requests and speeds up the loading of assets.

How It Works

The mergeAssets() helper function accepts four parameters:

Array of file paths: An array of CSS or JavaScript files that you want to merge and minify. The paths can be from both the public and resources directories.
Output filename: The name of the final output file (without extension) that will be generated and stored.
File type: Either css or js, specifying the type of files being merged.
Cache time (Optional): Time (in minutes) after which the merged file will be refreshed. Default is 1440 minutes (24 hours or 1 day).

Example (CSS)

<link rel="stylesheet" href="{{ mergeAssets(
  [
    'assets/css/custom.css',
    'core.css',
  ],
  'merged-css',
  'css',
  60
) }}"/>

The file paths can be from both the public and resources/css directories. It returns merged-css.min.css file url.

Example (JS)

<script src="{{ mergeAssets(
  [
    'assets/js/custom.js',
    'core.js',
  ],
  'merged-js',
  'js'
) }}"></script>

The file paths can be from both the public and resources/js directories. It returns merged-js.min.js file url.

Minify asset (CSS or JavaScript)

You can use minifyAsset() helper function that allows you to minify your CSS or JavaScript file. This function will handle both public and resources directories, storing the final output file in your storage folder for optimized use. It helps you to reduce file size, improve page load times and save bandwidth.

How It Works

The minifyAsset() helper function accepts four parameters:

File path: Path of the CSS or JavaScript file that you want to minify. The path can be from both the public and resources directories.
File type: Either css or js, specifying the type of file being minified.
Cache time (Optional): Time (in minutes) after which the minified file will be refreshed. Default is 1440 minutes (24 hours or 1 day).
Output filename (Optional): The name of the final output file (without extension) that will be generated and stored. Default was the given file name.

Example (CSS)

<link rel="stylesheet" href="{{ minifyAsset('app.css', 'css', 120, 'app-minify') }}"/>

The file paths can be from both the public and resources/css directories. It returns app-minify.min.css file url.

Example (JS)

<script src="{{ minifyAsset('assets/js/custom.js', 'js') }}"></script>

The file paths can be from both the public and resources/js directories. It returns custom.min.js file url.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Contributions are welcome! Please see CONTRIBUTING for details on how to get started.

License

Asset Optimise is licensed under the MIT license.

Credits

This package uses the hexydec/htmldoc library for HTML, CSS and JavaScript minification.

Support

If you are having general issues with this package, feel free to contact us on debjyotikar001@gmail.com

debjyotikar001 / asset-optimise

Maintainers

Details

README

Key Features:

Installation

Configuration

Register the Middleware

(Laravel 10 or older)

(Laravel 11 or newer)

Usage

Enable

Allowed Environments

Skip specific sections of code

Skip Inline CSS

Skip Inline JavaScript

Skip HTML Comments

Skip or Ignore specific Routes Urls

Example URLs:

Enable Email Optimise

Merge and Minify multiple assets (CSS or JavaScript)

How It Works

Example (CSS)

Example (JS)

Minify asset (CSS or JavaScript)

How It Works

Example (CSS)

Example (JS)

Changelog

Contributing

License

Credits

Support