itk-dev/composer-virtualenv

A simple virtual environment for composer

Composer virtualenv

A simple virtual environment for composer., _(*1)

Inspired by Python's virtualenv, this package adds a script for prepending vendor/bin to the PATH variable to make it easier to run commands installed via composer., _(*2)

Background

Assume your composer.json contains, _(*3)

    "require-dev": {
        "phpunit/phpunit": "^6.5",
        "drush/drush": "^9.2"
    }

After running composer install you have to make sure to run vendor/bin/phpunit or vendor/bin/drush, respectively, to run the right command. If you just run phpunit you'll will run any globally installed version of phpunit (or get an error if phpunit is not installed)., _(*4)

Composer virtualenv, helps you run the right commands, i.e. the ones installed using composer, without having to (remember to) type vendor/bin/ every time., _(*5)

Installation

composer require itk-dev/composer-virtualenv "^1.0"

Activating the virtual environment

To deactivate the virtual environment, run, _(*6)

source vendor/bin/activate

Note: It is important to source the script – it will not work if it is run., _(*7)

This prepends the path vendor/bin to the PATH environment variable, and any command installed using composer will be run instead of any globally available command of the same name., _(*8)

Deactivating the virtual environment

To deactivate the virtual environment and restore the PATH variable to its original value, run, _(*9)

deactivate