Skip to content
This repository has been archived by the owner on Oct 14, 2022. It is now read-only.

Latest commit

 

History

History
45 lines (33 loc) · 1.17 KB

README.md

File metadata and controls

45 lines (33 loc) · 1.17 KB

Unified Asset Installer

phpDocumentor relies on specific directory locations for templates and plugins. By default Composer is unable to install in a directory other than /vendor except when using a Custom Installer.

This Custom Installer for Composer will trigger on the following library types and provide custom behaviour for those.

  • phpdocumentor-template, install files into /data/template instead of /vendor

Usage

In order to tell a template to use this installer you need to add the following composer.json

{
    "name": "phpdocumentor/template-$NAME$",
    "type": "phpdocumentor-template",
    "license": "MIT"
    "require": {
        "phpdocumentor/unified-asset-installer":"*"
    }
}

The type element will instruct Composer to use this Custom Installer.

TODO

  • Add the phpdocumentor-plugin library type as well.

FAQ

What's up with the name?

Due to a bug in Composer at time of writing of this document, the name must be alphabetically LATER than the word template.