cdtweb / pharven

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

Pharven

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.

pharven's Issues

Look into compressing the phar

http://php.net/manual/en/phar.compress.php

Command line flags & options

Turn pharven into a command line app with flags & options

• --quite no output
• create-json create pharven.json

Add PHPUnit testing

Need to add unit testing

Look into using league/climate and/or Symfony Console component

Add information about the mount_dirs setting to README.md

The mount_dirs setting is important if you are autoloading your project classes through the composer autoloader. Because PHAR files act as their own file system, any classes that you are autoloading through composer need to be "mounted" to the PHAR file, or they won't be found.

CLI script needs better output

• --verbose, --quiet flags
• Colored output

Set up on packagist

Auto-include the vendor directory

Right now the vendor directory is mapped using the include_dirs setting in pharven.json, but it should be automatically included because the primary function of this project is to bundle the vendor/ directory, so it shouldn't be optional.