cdtweb/pharven

Pharven bundles your vendor directory into a PHP Archive (PHAR)

0.1.2 2018-03-13 22:17 UTC

Requires

• php: >=7.1
• twig/twig: ^2.2

Requires (Dev)

• phpunit/phpunit: ~4.0
• squizlabs/php_codesniffer: 2.*

MIT

• Clint Tyler

• composer
• phar

README

If you have ever needed to commit your vendor/ directory into your project repository then Pharven was built for you.

Pharven bundles your vendor directory into a single PHP Archive (PHAR) and allows you to commit and deploy a single file instead of your entire vendor/ directory.

Installation

Add Pharven to your project using Composer:

composer require cdtweb/pharven

Usage

Add pharven.json to your project root with the following content:

{
    "mount_dirs": [
        "src"
    ]
}

mount_dirs are very important if you are using Composer to autoload your project classes. .phar files act as their own file system, so if your classes aren't mounted, they won't be visible to the Composer autoloader and you will run into problems.

Run Pharven to create/update your PHAR file:

php vendor/bin/pharven

A file named pharven.phar will be added to the working directory. Update your bootstrap to include ./pharven.phar instead of vendor/autoload.php and you're good to go.

<?php
require __DIR__ . '/pharven.phar';

At this point you can add vendor/ to your .gitignore file and commit your pharven.phar file instead.