Merge pull request #5 from nicolas-grekas/deprec-annot

Replace runtime warning by docblock annotation
composer · Jul 10, 2020 · 7a8001f · 7a8001f
2 parents b980588 + 53232fc
commit 7a8001f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/src/PackageVersions/Installer.php b/src/PackageVersions/Installer.php
@@ -45,6 +45,8 @@ final class Installer implements PluginInterface, EventSubscriberInterface
  * @see \PackageVersions\Installer
  *
  * This file is overwritten at every run of `composer install` or `composer update`.
+ *
+ * @deprecated in favor of the Composer\InstalledVersions class provided by Composer 2. Require composer-runtime-api:^2 to ensure it is present.
  */
 %s
 {
@@ -160,10 +162,6 @@ private static function writeVersionClassToFile(string $versionClassSource, Comp
         rename($installPathTmp, $installPath);
 
         $io->write('<info>composer/package-versions-deprecated:</info> ...done generating version class');
-
-        if (version_compare(PluginInterface::PLUGIN_API_VERSION, '2.0.0', '>=')) {
-            $io->write('<info>composer/package-versions-deprecated:</info> <warning>You should rely on the Composer\InstalledVersions class instead of this package as you are using Composer 2. You can require composer-runtime-api:^2 to ensure it is present.</warning>');
-        }
     }
 
     /**

diff --git a/test/PackageVersionsTest/InstallerTest.php b/test/PackageVersionsTest/InstallerTest.php
@@ -216,6 +216,8 @@ public function testDumpVersionsClass()
  * @see \PackageVersions\Installer
  *
  * This file is overwritten at every run of `composer install` or `composer update`.
+ *
+ * @deprecated in favor of the Composer\InstalledVersions class provided by Composer 2. Require composer-runtime-api:^2 to ensure it is present.
  */
 final class Versions
 {
@@ -332,6 +334,8 @@ public function testDumpVersionsClassNoDev()
  * @see \PackageVersions\Installer
  *
  * This file is overwritten at every run of `composer install` or `composer update`.
+ *
+ * @deprecated in favor of the Composer\InstalledVersions class provided by Composer 2. Require composer-runtime-api:^2 to ensure it is present.
  */
 final class Versions
 {
@@ -451,6 +455,8 @@ public function testDumpVersionsWithoutPackageSourceDetails()
  * @see \PackageVersions\Installer
  *
  * This file is overwritten at every run of `composer install` or `composer update`.
+ *
+ * @deprecated in favor of the Composer\InstalledVersions class provided by Composer 2. Require composer-runtime-api:^2 to ensure it is present.
  */
 final class Versions
 {
@@ -863,6 +869,8 @@ public function testGetVersionsIsNotNormalizedForRootPackage()
  * @see \PackageVersions\Installer
  *
  * This file is overwritten at every run of `composer install` or `composer update`.
+ *
+ * @deprecated in favor of the Composer\InstalledVersions class provided by Composer 2. Require composer-runtime-api:^2 to ensure it is present.
  */
 final class Versions
 {