konsulting/project-root

A simple package to determine the working root directory for a composer dependency

Project Root

A simple package to help with resolving paths when working in a composer package., _(*1)

Specifically, for some functionality you may need to refer to the packages root directory, but then need to use the project's root when the package is included as a dependency., _(*2)

Rather than keep repeating dirty logic from before, we can use this package., _(*3)

Installation

composer require konsulting/package-root, _(*4)

Usage

<?php

\Konsulting\ProjectRoot::forPackage('package-name')->resolve(__DIR__);

Contributing

Contributions are welcome and will be fully credited. We will accept contributions by Pull Request., _(*5)

Please:, _(*6)

• Use the PSR-2 Coding Standard
• Add tests, if you’re not sure how, please ask.
• Document changes in behaviour, including readme.md.

Testing

We use PHPUnit, _(*7)

Run tests using PHPUnit: vendor/bin/phpunit, _(*8)