forked from Ocramius/PackageVersions
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,5 @@ | ||
| # Package Versions | ||
|
|
||
| **`composer/package-versions-deprecated` is a fork of `ocramius/package-versions`** which provides compatibility with Composer 1 and 2 on PHP 7+. It replaces ocramius/package-versions so if you have a dependency requiring it and you want to use Composer v2 but can not upgrade to PHP 7.4 just yet, you can require this package instead. | ||
| **`composer/package-versions-deprecated` is a fully-compatible fork of `[ocramius/package-versions](https://github.com/Ocramius/PackageVersions)`** which provides compatibility with Composer 1 and 2 on PHP 7+. It replaces ocramius/package-versions so if you have a dependency requiring it and you want to use Composer v2 but can not upgrade to PHP 7.4 just yet, you can require this package instead. | ||
|
|
||
| If you have a direct dependency on ocramius/package-versions, we recommend instead that once you migrated to Composer 2 you also migrate to use the `Composer\Versions` class which offers the functionality present here out of the box. | ||
|
|
||
| # Original README below | ||
|
|
||
| This utility provides quick and easy access to version information of composer dependencies. | ||
|
|
||
| This information is derived from the ```composer.lock``` file which is (re)generated during ```composer install``` or ```composer update```. | ||
|
|
||
| ```php | ||
| $version = \PackageVersions\Versions::getVersion('ocramius/package-versions'); | ||
|
|
||
| var_dump($version); // 1.0.0@0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33 | ||
| ``` | ||
|
|
||
| [](https://travis-ci.org/Ocramius/PackageVersions) | ||
| [](https://scrutinizer-ci.com/g/Ocramius/PackageVersions/?branch=master) | ||
| [](https://scrutinizer-ci.com/g/Ocramius/PackageVersions/?branch=master) | ||
| [](https://packagist.org/packages/ocramius/package-versions) | ||
| [](https://packagist.org/packages/ocramius/package-versions) | ||
| [](https://tidelift.com/subscription/pkg/packagist-ocramius%2Fpackage-versions?utm_source=packagist-ocramius%2Fpackage-versions&utm_medium=readme) | ||
|
|
||
| ### Installation | ||
|
|
||
| ```sh | ||
| composer require ocramius/package-versions | ||
| ``` | ||
|
|
||
| It is suggested that you use [an optimized composer autoloader](https://getcomposer.org/doc/06-config.md#optimize-autoloader) (to prevent autoload I/O when accessing the `PackageVersions\Versions` API) in your composer.json: | ||
| ``` | ||
| ... | ||
| "config": { | ||
| "optimize-autoloader": true | ||
| }, | ||
| ... | ||
| ``` | ||
|
|
||
| In case you manually generate your autoloader via the CLI use the `--optimize` flag: | ||
|
|
||
| ```sh | ||
| composer dump-autoload --optimize | ||
| ``` | ||
|
|
||
| ### Use-cases | ||
|
|
||
| This repository implements `PackageVersions\Versions::getVersion()` in such a way that no IO | ||
| happens when calling it, because the list of package versions is compiled during composer | ||
| installation. | ||
|
|
||
| This is especially useful when you want to generate assets/code/artifacts that are computed from | ||
| the current version of a certain dependency. Doing so at runtime by checking the installed | ||
| version of a package would be too expensive, and this package mitigates that. | ||
|
|
||
| ## ocramius/package-versions for enterprise | ||
|
|
||
| Available as part of the Tidelift Subscription. | ||
|
|
||
| The maintainer of ocramius/package-versions and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/packagist-ocramius-package-versions?utm_source=packagist-ocramius-package-versions&utm_medium=referral&utm_campaign=enterprise&utm_term=repo). | ||
|
|
||
| You can also contact the maintainer at ocramius@gmail.com for looking into issues related to this package | ||
| in your private projects. |