konsulting/project-root

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

1.1 2019-04-16 07:29 UTC

This package is auto-updated.

Last update: 2021-11-16 14:13:35 UTC


README

A simple package to help with resolving paths when working in a composer package.

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.

Rather than keep repeating dirty logic from before, we can use this package.

Installation

composer require konsulting/package-root

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.

Please:

  • 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

Run tests using PHPUnit: vendor/bin/phpunit