Compiling Assets (Mix)

Introduction

Laravel Mix provides a fluent API for defining Webpack build steps for your Laravel application using several common CSS and JavaScript pre-processors. Through simple method chaining, you can fluently define your asset pipeline. For example:

  1. mix.js('resources/js/app.js', 'public/js')
  2.     .sass('resources/sass/app.scss', 'public/css');

If you've ever been confused and overwhelmed about getting started with Webpack and asset compilation, you will love Laravel Mix. However, you are not required to use it while developing your application; you are free to use any asset pipeline tool you wish, or even none at all.

Installation & Setup

Installing Node

Before triggering Mix, you must first ensure that Node.js and NPM are installed on your machine.

  1. node -v
  2. npm -v

By default, Laravel Homestead includes everything you need; however, if you aren't using Vagrant, then you can easily install the latest version of Node and NPM using simple graphical installers from their download page.

Laravel Mix

The only remaining step is to install Laravel Mix. Within a fresh installation of Laravel, you'll find a package.json file in the root of your directory structure. The default package.json file includes everything you need to get started. Think of this like your composer.json file, except it defines Node dependencies instead of PHP. You may install the dependencies it references by running:

  1. npm install

Running Mix

Mix is a configuration layer on top of Webpack, so to run your Mix tasks you only need to execute one of the NPM scripts that is included with the default Laravel package.json file:

  1. // Run all Mix tasks...
  2. npm run dev
  4. // Run all Mix tasks and minify output...
  5. npm run production

Watching Assets For Changes

The npm run watch command will continue running in your terminal and watch all relevant files for changes. Webpack will then automatically recompile your assets when it detects a change:

  1. npm run watch

You may find that in certain environments Webpack isn't updating when your files change. If this is the case on your system, consider using the watch-poll command:

  1. npm run watch-poll

Working With Stylesheets

The webpack.mix.js file is your entry point for all asset compilation. Think of it as a light configuration wrapper around Webpack. Mix tasks can be chained together to define exactly how your assets should be compiled.

Less

The less method may be used to compile Less into CSS. Let's compile our primary app.less file to public/css/app.css.

  1. mix.less('resources/less/app.less', 'public/css');

Multiple calls to the less method may be used to compile multiple files:

  1. mix.less('resources/less/app.less', 'public/css')
  2.     .less('resources/less/admin.less', 'public/css');

If you wish to customize the file name of the compiled CSS, you may pass a full file path as the second argument to the less method:

  1. mix.less('resources/less/app.less', 'public/stylesheets/styles.css');

If you need to override the underlying Less plug-in options, you may pass an object as the third argument to mix.less():

  1. mix.less('resources/less/app.less', 'public/css', {
  2.     strictMath: true
  3. });

Sass

The sass method allows you to compile Sass into CSS. You may use the method like so:

  1. mix.sass('resources/sass/app.scss', 'public/css');

Again, like the less method, you may compile multiple Sass files into their own respective CSS files and even customize the output directory of the resulting CSS:

  1. mix.sass('resources/sass/app.sass', 'public/css')
  2.     .sass('resources/sass/admin.sass', 'public/css/admin');

Additional Node-Sass plug-in options may be provided as the third argument:

  1. mix.sass('resources/sass/app.sass', 'public/css', {
  2.     precision: 5
  3. });

Stylus

Similar to Less and Sass, the stylus method allows you to compile Stylus into CSS:

  1. mix.stylus('resources/stylus/app.styl', 'public/css');

You may also install additional Stylus plug-ins, such as Rupture. First, install the plug-in in question through NPM (npm install rupture) and then require it in your call to mix.stylus():

  1. mix.stylus('resources/stylus/app.styl', 'public/css', {
  2.     use: [
  3.         require('rupture')()
  4.     ]
  5. });

PostCSS

PostCSS, a powerful tool for transforming your CSS, is included with Laravel Mix out of the box. By default, Mix leverages the popular Autoprefixer plug-in to automatically apply all necessary CSS3 vendor prefixes. However, you're free to add any additional plug-ins that are appropriate for your application. First, install the desired plug-in through NPM and then reference it in your webpack.mix.js file:

  1. mix.sass('resources/sass/app.scss', 'public/css')
  2.     .options({
  3.         postCss: [
  4.             require('postcss-css-variables')()
  5.         ]
  6.     });

Plain CSS

If you would just like to concatenate some plain CSS stylesheets into a single file, you may use the styles method.

  1. mix.styles([
  2.     'public/css/vendor/normalize.css',
  3.     'public/css/vendor/videojs.css'
  4. ], 'public/css/all.css');

URL Processing

Because Laravel Mix is built on top of Webpack, it's important to understand a few Webpack concepts. For CSS compilation, Webpack will rewrite and optimize any url() calls within your stylesheets. While this might initially sound strange, it's an incredibly powerful piece of functionality. Imagine that we want to compile Sass that includes a relative URL to an image:

  1. .example {
  2.     background: url('../images/example.png');
  3. }

{note} Absolute paths for any given url() will be excluded from URL-rewriting. For example, url('/images/thing.png') or url('http://example.com/images/thing.png') won't be modified.

By default, Laravel Mix and Webpack will find example.png, copy it to your public/images folder, and then rewrite the url() within your generated stylesheet. As such, your compiled CSS will be:

  1. .example {
  2.     background: url(/images/example.png?d41d8cd98f00b204e9800998ecf8427e);
  3. }

As useful as this feature may be, it's possible that your existing folder structure is already configured in a way you like. If this is the case, you may disable url() rewriting like so:

  1. mix.sass('resources/app/app.scss', 'public/css')
  2.     .options({
  3.         processCssUrls: false
  4.     });

With this addition to your webpack.mix.js file, Mix will no longer match any url() or copy assets to your public directory. In other words, the compiled CSS will look just like how you originally typed it:

  1. .example {
  2.     background: url("../images/thing.png");
  3. }

Source Maps

Though disabled by default, source maps may be activated by calling the mix.sourceMaps() method in your webpack.mix.js file. Though it comes with a compile/performance cost, this will provide extra debugging information to your browser's developer tools when using compiled assets.

  1. mix.js('resources/js/app.js', 'public/js')
  2.     .sourceMaps();

Style Of Source Mapping

Webpack offers a variety of source mapping styles. By default, Mix's source mapping style is set to eval-source-map, which provides a fast rebuild time. If you want to change the mapping style, you may do so using the sourceMaps method:

  1. let productionSourceMaps = false;
  3. mix.js('resources/js/app.js', 'public/js')
  4.     .sourceMaps(productionSourceMaps, 'source-map');

Working With JavaScript

Mix provides several features to help you work with your JavaScript files, such as compiling ECMAScript 2015, module bundling, minification, and concatenating plain JavaScript files. Even better, this all works seamlessly, without requiring an ounce of custom configuration:

  1. mix.js('resources/js/app.js', 'public/js');

With this single line of code, you may now take advantage of:

  • ES2015 syntax.
  • Modules
  • Compilation of .vue files.
  • Minification for production environments.

Vendor Extraction

One potential downside to bundling all application-specific JavaScript with your vendor libraries is that it makes long-term caching more difficult. For example, a single update to your application code will force the browser to re-download all of your vendor libraries even if they haven't changed.

If you intend to make frequent updates to your application's JavaScript, you should consider extracting all of your vendor libraries into their own file. This way, a change to your application code will not affect the caching of your large vendor.js file. Mix's extract method makes this a breeze:

  1. mix.js('resources/js/app.js', 'public/js')
  2.     .extract(['vue'])

The extract method accepts an array of all libraries or modules that you wish to extract into a vendor.js file. Using the above snippet as an example, Mix will generate the following files:

  • public/js/manifest.js: The Webpack manifest runtime
  • public/js/vendor.js: Your vendor libraries
  • public/js/app.js: Your application code

To avoid JavaScript errors, be sure to load these files in the proper order:

  1. <script src="/js/manifest.js"></script>
  2. <script src="/js/vendor.js"></script>
  3. <script src="/js/app.js"></script>

React

Mix can automatically install the Babel plug-ins necessary for React support. To get started, replace your mix.js() call with mix.react():

  1. mix.react('resources/js/app.jsx', 'public/js');

Behind the scenes, Mix will download and include the appropriate babel-preset-react Babel plug-in.

Vanilla JS

Similar to combining stylesheets with mix.styles(), you may also combine and minify any number of JavaScript files with the scripts() method:

  1. mix.scripts([
  2.     'public/js/admin.js',
  3.     'public/js/dashboard.js'
  4. ], 'public/js/all.js');

This option is particularly useful for legacy projects where you don't require Webpack compilation for your JavaScript.

{tip} A slight variation of mix.scripts() is mix.babel(). Its method signature is identical to scripts; however, the concatenated file will receive Babel compilation, which translates any ES2015 code to vanilla JavaScript that all browsers will understand.

Custom Webpack Configuration

Behind the scenes, Laravel Mix references a pre-configured webpack.config.js file to get you up and running as quickly as possible. Occasionally, you may need to manually modify this file. You might have a special loader or plug-in that needs to be referenced, or maybe you prefer to use Stylus instead of Sass. In such instances, you have two choices:

Merging Custom Configuration

Mix provides a useful webpackConfig method that allows you to merge any short Webpack configuration overrides. This is a particularly appealing choice, as it doesn't require you to copy and maintain your own copy of the webpack.config.js file. The webpackConfig method accepts an object, which should contain any Webpack-specific configuration that you wish to apply.

  1. mix.webpackConfig({
  2.     resolve: {
  3.         modules: [
  4.             path.resolve(__dirname, 'vendor/laravel/spark/resources/assets/js')
  5.         ]
  6.     }
  7. });

Custom Configuration Files

If you would like to completely customize your Webpack configuration, copy the node_modules/laravel-mix/setup/webpack.config.js file to your project's root directory. Next, point all of the —config references in your package.json file to the newly copied configuration file. If you choose to take this approach to customization, any future upstream updates to Mix's webpack.config.js must be manually merged into your customized file.

Copying Files & Directories

The copy method may be used to copy files and directories to new locations. This can be useful when a particular asset within your node_modules directory needs to be relocated to your public folder.

  1. mix.copy('node_modules/foo/bar.css', 'public/css/bar.css');

When copying a directory, the copy method will flatten the directory's structure. To maintain the directory's original structure, you should use the copyDirectory method instead:

  1. mix.copyDirectory('resources/img', 'public/img');

Versioning / Cache Busting

Many developers suffix their compiled assets with a timestamp or unique token to force browsers to load the fresh assets instead of serving stale copies of the code. Mix can handle this for you using the version method.

The version method will automatically append a unique hash to the filenames of all compiled files, allowing for more convenient cache busting:

  1. mix.js('resources/js/app.js', 'public/js')
  2.     .version();

After generating the versioned file, you won't know the exact file name. So, you should use Laravel's global mix function within your views to load the appropriately hashed asset. The mix function will automatically determine the current name of the hashed file:

  1. <script src="{{ mix('/js/app.js') }}"></script>

Because versioned files are usually unnecessary in development, you may instruct the versioning process to only run during npm run production:

  1. mix.js('resources/js/app.js', 'public/js');
  3. if (mix.inProduction()) {
  4.     mix.version();
  5. }

Custom Mix Base URLs

If your Mix compiled assets are deployed to a CDN separate from your application, you will need to change the base URL generated by the mix function. You may do so by adding a mix_url configuration option to your config/app.php configuration file:

  1. 'mix_url' => env('MIX_ASSET_URL', null)

After configuring the Mix URL, The mix function will prefix the configured URL when generating URLs to assets:

  1. https://cdn.example.com/js/app.js?id=1964becbdd96414518cd

Browsersync Reloading

BrowserSync can automatically monitor your files for changes, and inject your changes into the browser without requiring a manual refresh. You may enable support by calling the mix.browserSync() method:

  1. mix.browserSync('my-domain.test');
  3. // Or...
  5. // https://browsersync.io/docs/options
  6. mix.browserSync({
  7.     proxy: 'my-domain.test'
  8. });

You may pass either a string (proxy) or object (BrowserSync settings) to this method. Next, start Webpack's dev server using the npm run watch command. Now, when you modify a script or PHP file, watch as the browser instantly refreshes the page to reflect your changes.

Environment Variables

You may inject environment variables into Mix by prefixing a key in your .env file with MIX_:

  1. MIX_SENTRY_DSN_PUBLIC=http://example.com

After the variable has been defined in your .env file, you may access via the process.env object. If the value changes while you are running a watch task, you will need to restart the task:

  1. process.env.MIX_SENTRY_DSN_PUBLIC

Notifications

When available, Mix will automatically display OS notifications for each bundle. This will give you instant feedback, as to whether the compilation was successful or not. However, there may be instances when you'd prefer to disable these notifications. One such example might be triggering Mix on your production server. Notifications may be deactivated, via the disableNotifications method.

  1. mix.disableNotifications();