ymcatwincities/vendor_stream_wrapper

Creates the vendor:// stream wrapper, allowing for linking/embedding of CSS and JS files in the vendor directory.

dev-8.x-1.x 2020-07-28 11:40 UTC

GPL-2.0-or-later

• Jay Friendly (Jaypan)

README

Overview

Drupal and Composer working together is great for management of external libraries that can be integrated into Drupal sites. It is a good practice to have the /vendor directory outside the webroot, and this is what theDrupal Composer template does. The problem with moving the vendor out of the webroot however comes when trying to provide public URLs to files in the /vendor directory, such as CSS or JS files that are part of an external library.

This module provides a new stream wrapper, vendor://, that allows for referencing of files in the vendor directory. It works much the same as the private:// file wrapper provided by Drupal core. Along with this stream wrapper, this module sets up *.libraries.yml files to be parsed for vendor:// references, as can be seen in the example below:

example.libraries.yml:

some_library:
  js:
    vendor://vendor-name/package-name/js/some_file.js: {}
  css:
    theme:
      vendor://vendor-name/package-name/css/some_file.css: {}

The module also provides a helper function, vendor_stream_wrapper_create_url() for resolving vendor files to public facing URLs:

$public_url = vendor_stream_wrapper_create_url(
  'vendor://vendor/package/file.css'
);

Configuration

This module will look first for the vendor first at ../vendor then at ./vendor. If no vendor folder is found an exception is thrown. If your vendor folder is located somewhere than either of these two locations, then you can tell the system were to find it by adding the following to settings.php:

$settings['vendor_file_path'] = 'path/to/vendor/folder';