@maize-tech/laravel-mix-static-cache-busting

Laravel Mix Static Cache Busting

This package allows you to simulate Laravel mix function, used for cache busting, without the need to use PHP in your project.

The plugin will grab your static index.html file, search for any asset and replace them with all occurrences specified within mix-manifest.json.

For example, if your index.html file includes this stylesheet reference:

<link rel="stylesheet" type="text/css" href="/app.css">

the plugin will automatically replace it during the compilation with:

<link rel="stylesheet" type="text/css" href="/app.css?id=fbd7c81ea490324c303c">

Installation

You can install this package via npm:

npm i @maize-tech/laravel-mix-static-cache-busting --save-dev

Usage

To use the package, all you need to do is update your webpack.mix.js file and add the staticCacheBusting method. The first parameter is the mix-manifest.json file path, while the second one is the index.html file path.

Here's an example implementation of the method:

let mix = require('laravel-mix');

require('laravel-mix-static-cache-busting');

mix
  // tasks that will generate a mix-manifest.json
  .staticCacheBusting('./dist/mix-manifest.json', './dist/index.html') // change paths at your discretion

Troubleshooting

The plugin isn't working? Check the entry attributes in your mix-manifest.json and make sure your html href attributes follow the same path.

For example, if your mix-manifest.json file has this attribute for the app.css file:

{
    "/app.css": "/app.css?id=fbd7c81ea490324c303c"
}

then your index.html should reference the file this way:

<!-- note the slash before app.css -->
<link rel="stylesheet" type="text/css" href="/app.css">

while this will not work:

<!-- initial slash missing! -->
<link rel="stylesheet" type="text/css" href="app.css">

Also, please note that this plugin will replace any entry as-is and anywhere it's placed within the targeted file (index.html).

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Francesco Zaniol
• All Contributors

License

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