tannhatcms/basset

Dead-simple way to load CSS or JS assets only once per page, when using Laravel 10+.

2.0.3 2025-03-27 01:12 UTC

Requires

• guzzlehttp/guzzle: ^7.5
• laravel/framework: ^10.15|^11|^12.0

Requires (Dev)

• nunomaduro/collision: ^6.0|^7.2|^8.0
• orchestra/testbench: ^7.22|^8.5|^9.0|^10.0
• pestphp/pest: ^1.22|^2.5|^3.7
• pestphp/pest-plugin-laravel: ^1.4|^2.0|^3.1
• phpstan/phpstan: ^1.10|^2.1
• phpunit/phpunit: ~9.0|~10.0|^11.5.3

Suggests

• ext-zip: Required to use @bassetArchive with .zip archives.

Replaces

• backpack/basset: ^1.3.7

MIT

• Cristian Tabacitu

• assets
• laravel
• basset
• Load CSS once
• Load JS once

README

Easily use your CSS/JS/etc assets from wherever they are, not just your public directory:

{{-- if you're used to Laravel's asset helper: --}}
<link href="{{ asset('path/to/public/file.css') }}">

{{-- just change asset() to basset() and you can point to non-public files too, for example: --}}
<script src="{{ basset(storage_path('file.js')) }}">
<script src="{{ basset(base_path('vendor/org/package/assets/file.js')) }}">
<script src="{{ basset('https://cdn.com/path/to/file.js') }}">

That's all you need to do. Basset will download the file to the predefined disk, then output that disk path to your asset.

Using Basset, you easily internalize and use:

• files from external URLs (like CDNs)
• files from internal, but non-public URLs (like the vendor directory)
• entire archives from external URLs (like GitHub)
• entire directories from local, non-public paths (like other local projects)

No more publishing package files. No more NPM bloat, just to download some files. It's a simple yet effective solution in the age of HTTP/2 and HTTP/3.

Installation

composer require backpack/basset
php artisan basset:install

To check that Basset is running correctly, please run:

# recommended - this will tell you if anything is wrong & what to do:
php artisan basset:check

Optionally, you can also publish the config file to make changes in how Basset works:

# optional
php artisan vendor:publish --provider="Backpack\Basset\BassetServiceProvider"

Storage Symlink

By default, Basset uses the storage directory to store cached assets in a directory that is publicly-accessible. So it needs you to run php artisan storage:link to create the symlink. The installation command will ask to run that, and to add that command to your composer.json. That will most likely make it work on your development/staging/production servers. If that's not the case, make sure you create the links manually wherever you need them, with the command php artisan storage:link.

Usage

The basset() Helper

You can just use the basset() helper instead of Laravel's asset() helper, and point to CDNs and non-public files too. Use Laravel's path helpers to construct the absolute path to your file, then Basset will take care of the rest.

For local from CDNs:

{{-- instead of --}}
<link href="{{ asset('path/to/public/file.css') }}">

{{-- you can do --}}
<link href="{{ basset('path/to/public/file.css') }}">
<link href="{{ basset('https://cdn.com/path/to/file.css') }}">
<link href="{{ basset(base_path('vendor/org/package/assets/file.css')) }}">
<link href="{{ basset(storage_path('file.css')) }}">

Basset will:

• copy that file from the vendor directory to the basset disk (if needed)
• use the internalized file on all requests

The @basset() Directive

For known asset types like CSS, JS, images and videos, among others, Basset makes it even shorter to load assets. No need to write the HTML for your <script>, <link> or <img>, just use the @basset() directive and all of the needed HTML will be output for you:

{{-- instead of --}}
<script src="{{ asset('path/to/public/file.js') }}">
<link href="{{ asset('path/to/public/file.css') }}">
<img src="{{ asset('path/to/public/file.jpg') }}">
<object data="{{ asset('path/to/public/file.pdf') }}"></object>

{{-- you can do --}}
@basset('https://cdn.com/path/to/file.js')
@basset('https://cdn.com/path/to/file.css')
@basset(resource_path('/path/to/file.jpg'))
@basset(resource_path('/path/to/file.pdf'))

These are the know file types;

File extension	HTML element
.js	<script>
.css	<style>
.jpg .jpeg .png .webp .gif .svg	<img>
.mp4 .webm .avi .mp3 .ogg .wav	<source>
.ico	<link>
.pdf	<object>
.vtt	<track>

Basset will:

• copy that file from the vendor directory to your basset directory (aka. internalize the file)
• use the internalized file on all requests
• make sure that file is only loaded once per pageload

The @bassetBlock() Directive

Easily move code blocks to files, so they're cached

+   @bassetBlock('path/or/name-i-choose-to-give-this')
    <script>
      alert('Do stuff!');
    </script>
+   @endBassetBlock()

Basset will:

• create a file with that JS code in your basset directory (aka. internalize the code)
• on all requests, use the local file (using <script src="">) instead of having the JS inline
• make sure that file is only loaded once per pageload

The @bassetArchive() Directive

Easily use archived assets (.zip & .tar.gz):

+    @bassetArchive('https://github.com/author/package-dist/archive/refs/tags/1.0.0.zip', 'package-1.0.0')
+    @basset('package-1.0.0/plugin.min.js')

Basset will:

• download the archive to your basset directory (aka. internalize the code)
• unarchive it
• on all requests, use the local file (using <script src="">)
• make sure that file is only loaded once per pageload

Note: when referencing .zip archives, the PHP zip extension is required.

The @bassetDirectory() Directive

Easily internalize and use entire non-public directories:

+    @bassetDirectory(resource_path('package-1.0.0/'), 'package-1.0.0')
+    @basset('package-1.0.0/plugin.min.js')

Basset will:

• copy the directory to your basset directory (aka. internalize the code)
• on all requests, use the internalized file (using <script src="">)
• make sure that file is only loaded once per pageload

The basset Commands

Copying an asset from CDNs to your server could take a bit of time, depending on the asset size. For large pages, that could even take entire seconds. You can easily prevent that from happening, by internalizing all assets in one go. You can use php artisan basset:cache to go through all your blade files, and internalize everything that's possible. If you ever need it, basset:clear will delete all the files.

php artisan basset:cache         # internalizes all @bassets
php artisan basset:clear         # clears the basset directory

In order to speed up the first page load on production, we recommend you to add php artisan basset:cache command to your deploy script.

Configuration

Take a look at the config file for all configuration options. Notice some of those configs also have ENV variables, so you can:

• enable/disable dev mode using BASSET_DEV_MODE=false - when enabled Basset will check for changes in your url/files and update the cached assets
• change the disk where assets get internalized using BASSET_DISK=yourdiskname
• disable the cache map using BASSET_CACHE_MAP=false (needed on serverless like Laravel Vapor)

Deployment

There are a lot of deployment options for Laravel apps, but we'll try to cover the gotchas of the most popular ones here:

VPS / SSH / Composer available

• it is mandatory to run php artisan storage:link in production, for Basset to work; so it's recommended you add that to your composer.json's scripts section, either under post-composer-install or post-composer-update;
• it is recommended to run php artisan basset:fresh after each deployment; so it's recommended you add that to your composer.json's scripts section, either under post-composer-update;

Laravel Forge

It's just a managed VPS, so please see the above.

Laravel Vapor

Step 1. In your vapor.yml include storage: yourbucketname

Step 2. In your Vapor .ENV file make sure you have

BASSET_DISK=s3
BASSET_CACHE_MAP=false

(optional) Before you deploy to Vapor, you might want to set up S3 on localhost to test that it's working. If you do, the steps here might help. If you encounter problems with deployment on Vapor (particularly through GitHub actions) there are some tips here.

FTP / SFTP / ZIP

If you deploy your project by uploading it from localhost (either manually or automatically), you should:

• make sure the alias exists that would have been created by php artisan storage:link; otherwise your alias might point to an inexisting localhost path; alternatively you can change the disk that Basset is using, in its config;
• before each deployment, make sure to disable dev mode (do BASSET_DEV_MODE=false in your .ENV file) then run php artisan basset:fresh; that will make sure your localhost downloads all assets, then you upload them in your zip;

Why does this package exist?

1. Keep a copy of the CDN dependencies on your side.

For many reasons you may want to avoid CDNs, CDNs may fail sometimes, the uptime is not 100%, or your app may need to work offline.

1. Forget about compiling your assets.

Most of the times backend developers end up messing around with npm and compiling dependencies. Backpack has been there, at some point we had almost 100Mb of assets on our main repo. Basset will keep all that mess away from backend developers.

1. Avoid multiple loads of the same assets.

In Laravel, if your CSS or JS assets are loaded inside a blade file:

// card.blade.php

<div class="card">
  Lorem ipsum
</div>

<script src="path/to/script.js"></script>

And you load that blade file multiple times per page (eg. include card.blade.php multiple times per page), you'll end up with that script tag being loaded multiple times, on the same page. To avoid that, Larvel 8 provides the @once directive, which will echo the thing only once, no matter how many times that blade file loaded:

// card.blade.php

<div class="card">
  Lorem ipsum
</div>

@once
<script src="path/to/script.js"></script>
@endonce

But what if your script.js file is not only loaded by card.blade.php, but also by other blade templates (eg. hero.blade.php, loaded on the same page? If you're using the @once directive, you will have the same problem all over again - that same script loaded multiple times.

That's where this package comes to the rescue. It will load the asset just ONCE, even if it's loaded from multiple blade files.

FAQ

Basset is not working, what may be wrong?

Before making any changes, you can run the command php artisan basset:check. It will perform a basic test to initialize, write, and read an asset, giving you better insights into any errors.

The most common reasons for Basset to fail are:

1. Incorrect APP_URL in the .env file.
   Ensure that APP_URL in your .env matches your server configuration, including the hostname, protocol, and port number. Incorrect settings can lead to asset loading issues.

2. Improperly configured disk.
   By default, Basset uses the Laravel public disk. For new Laravel projects, the configuration is usually correct. If you're upgrading a project and/or changed the public disk configuration, it's advised that you change the basset disk in config/backpack/basset.php to basset. The basset disk is a copy of the original Laravel public with working configurations.

3. Missing or broken storage symlink.
   If you use the default public disk, Basset requires that the symlink between the storage and the public accessible folder to be created with php artisan storage:link command. During installation, Basset attempts to create the symlink. If it fails, you will need to manually create it with php artisan storage:link. If you encounter issues (e.g., after moving the project), recreating the symlink should resolve them.

Note for Homestead users: the symlink can't be created inside the virtual machine. You should stop your instance with: vagrant down, create the symlink in your local application folder and then vagrant up to bring the system back up.

Where are cached assets stored?

Basset provides a few options out-of-the-box:

• basset disk - inside the storage directory (eg. storage/app/basset) [DEFAULT]
  • PROs: the Git history is clean - because your cached assets will NOT be tracked by Git;
  • CONs: you have to run php artisan basset:cache in your deploy script, which adds seconds to your deploy time; plus, it opens up a corner case on deployment - because assets are being re-cached upon deployment, if a CDN is down during deployment, the system will not be able to internalize it; if will however internalize it when the CDN is back on, and the page that loads the file gets accessed; we consider the tradeoffs minor and unlikely, which is why this is the DEFAULT;
  • How to enable: do nothing, or do BASSET_DISK=basset in your .env file;
• public_basset disk - inside the public directory (eg. public/basset)
  • PROs: you are certain the same assets you have on localhost will be in production, because the assets are commited to Git;
  • CONs: your Git history will be dirtier, because it will contain changes to libraries of CSS/JS files;
  • How to enable: do BASSET_DISK=public_basset in your .env file or config/backpack/basset.php config file;
• custom - you can completely customize what disk is used to store the assets - just change it in the config file; most common customizations:
  • store assets on a S3 bucket (using a custom disk);
  • store assets in public_basset disk, but add public/basset to .gitignore;

Can I track the assets in git, just like my source code? (aka NOT gitignore CSS and JS assets)

Yes, you can track the assets in your application repository and avoid downloading them on each deployment (aka. have them in git). The easiest way to do that is to set the BASSET_DISK=public_basset in your .ENV, or in the basset config file. This will store the assets in the public/basset directory by default and they will now be committed to git alongside the rest of your application code. But note that this has both PROs and CONs:

• PROs: This is advantageous as you know what assets are in your application right when you deploy, avoiding issues like a CDN being down at the deployment time and breaking your application production.
• CONs: As a downside, you must be 100% sure all assets are internalized on localhost, and commited to git. Otherwise, when a page is accessed in production, Basset will internalize that file in production alone (it always prioritizes having production in a working state), which means you'll have uncommitted changes in your production code. You will then have to fix merge conflicts in production, or do a git reset before each deployment.

To summarize - if you're 100% sure that php artisan basset:cache is pulling all assets your application needs, you can safely commit your assets to git. If not, you are exposing yourself to conflicts in production (which can be managed as well).

Events

If you require customized behavior after each asset is cached, you can set up a listener for the BassetCachedEvent in your EventServiceProvider. This event will be triggered each time an asset is cached.

Change log

Please see the releases tab for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Antonio Almeida
• Pedro Martins
• Cristian Tabacitu
• All Contributors

License

MIT. Please see the license file for more information.