https://github.com/ymcatwincities/vendor_stream_wrapper

Fork of vendor_stream_wrapper for Drupal 9 composer flow
https://github.com/ymcatwincities/vendor_stream_wrapper

Last synced: about 1 month ago
JSON representation

Fork of vendor_stream_wrapper for Drupal 9 composer flow

• Host: GitHub
• URL: https://github.com/ymcatwincities/vendor_stream_wrapper
• Owner: ymcatwincities
• Created: 2020-07-28T11:39:49.000Z (over 4 years ago)
• Default Branch: 8.x-1.x
• Last Pushed: 2020-07-28T11:40:33.000Z (over 4 years ago)
• Last Synced: 2024-04-13T00:48:44.014Z (9 months ago)
• Language: PHP
• Size: 14.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vendor Stream Wrapper module #

## 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 the[Drupal

Composer template](https://github.com/drupal-composer/drupal-project) 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';

```