qa: adds @todo annotations to mark items to change/remove when no l…

…onger supporting Composer 1.X Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
laminas-api-tools · Jul 13, 2020 · b7fb80f · b7fb80f
1 parent b4a7c0e
commit b7fb80f
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 6 deletions.
diff --git a/src/AssetInstaller.php b/src/AssetInstaller.php
@@ -59,6 +59,7 @@ public function setProjectPath($path)
     }
 
     /**
+     * @todo Add explicit typehint for version 2.0.
      * @param PackageInterface $package
      */
     public function __invoke(/*PackageInterface*/ $package)
@@ -191,10 +192,9 @@ private function updateGitignore($gitignoreFile, $path)
 
     /**
      * @param PackageInterface $package
-     *
      * @return PackageInterface
-     * @deprecated Can be removed with next major.
-     *             Migration guide should suggest upgrading to latest minor before upgrading major
+     * @deprecated Can be removed with next major. Migration guide should
+     *     suggest upgrading to latest minor before upgrading major.
      */
     private function package($package)
     {

diff --git a/src/AssetUninstaller.php b/src/AssetUninstaller.php
@@ -61,6 +61,7 @@ public function setProjectPath($path)
     }
 
     /**
+     * @todo Add explicit typehint for version 2.0.
      * @param PackageInterface $package
      */
     public function __invoke(/*PackageInterface*/ $package)
@@ -198,10 +199,9 @@ private function fetchIgnoreRules($file)
 
     /**
      * @param PackageInterface $package
-     *
      * @return PackageInterface
-     * @deprecated Can be removed with next major.
-     *             Migration guide should suggest upgrading to latest minor before upgrading major
+     * @deprecated Can be removed with next major. Migration guide should
+     *     suggest upgrading to latest minor before upgrading major.
      */
     private function package($package)
     {

diff --git a/test/AssetInstallerTest.php b/test/AssetInstallerTest.php
@@ -321,6 +321,9 @@ public function testInstallerAllowsConfigurationContainingClassPseudoConstant()
         }
     }
 
+    /**
+     * @todo Remove for version 2.0, when support for Composer 1.0 is removed.
+     */
     public function testInstallerCanHandlePackageEventWithInstallOperationDuringMigration()
     {
         if (version_compare(PluginInterface::PLUGIN_API_VERSION, '2.0', 'gte')) {
@@ -353,6 +356,9 @@ public function testInstallerCanHandlePackageEventWithInstallOperationDuringMigr
         $this->assertNull($installer($packageEvent->reveal()));
     }
 
+    /**
+     * @todo Remove for version 2.0, when support for Composer 1.0 is removed.
+     */
     public function testInstallerCanHandlePackageEventWithUpdateOperationDuringMigration()
     {
         if (version_compare(PluginInterface::PLUGIN_API_VERSION, '2.0', 'gte')) {
@@ -386,6 +392,7 @@ public function testInstallerCanHandlePackageEventWithUpdateOperationDuringMigra
     }
 
     /**
+     * @todo Remove for version 2.0, when support for Composer 1.0 is removed.
      * @return ObjectProphecy
      */
     private function createPackageEvent(OperationInterface $operation)

diff --git a/test/AssetUninstallerTest.php b/test/AssetUninstallerTest.php
@@ -386,6 +386,9 @@ public function testUninstallerSkipsConfigFilesThatDoNotContainAssetManagerStrin
         }
     }
 
+    /**
+     * @todo Remove for version 2.0, when support for Composer 1.0 is removed.
+     */
     public function testUninstallerCanHandlePackageEventDuringMigration()
     {
         if (version_compare(PluginInterface::PLUGIN_API_VERSION, '2.0', 'gte')) {
@@ -412,6 +415,7 @@ public function testUninstallerCanHandlePackageEventDuringMigration()
     }
 
     /**
+     * @todo Remove for version 2.0, when support for Composer 1.0 is removed.
      * @return ObjectProphecy
      */
     private function createPackageEvent(OperationInterface $operation)