From 5d6f9b25284024aa128a207963d7cb5cc4528855 Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Wed, 10 Mar 2021 10:52:16 +0100 Subject: [PATCH] Prefer @phpstan- annotations as that is what we run against --- .../DependencyResolver/PoolBuilder.php | 24 +++++++++---------- src/Composer/Downloader/GitDownloader.php | 6 ++--- src/Composer/Package/BasePackage.php | 2 +- src/Composer/Package/Link.php | 2 +- src/Composer/Package/PackageInterface.php | 8 +++---- .../Package/Version/StabilityFilter.php | 4 ++-- src/Composer/Plugin/PrePoolCreateEvent.php | 2 +- .../Repository/RepositoryInterface.php | 4 ++-- src/Composer/Repository/RepositorySet.php | 14 +++++------ src/Composer/Util/ProcessExecutor.php | 2 +- src/Composer/Util/StreamContextFactory.php | 4 ++-- 11 files changed, 36 insertions(+), 36 deletions(-) diff --git a/src/Composer/DependencyResolver/PoolBuilder.php b/src/Composer/DependencyResolver/PoolBuilder.php index e4a4afc49..f765d45e4 100644 --- a/src/Composer/DependencyResolver/PoolBuilder.php +++ b/src/Composer/DependencyResolver/PoolBuilder.php @@ -46,12 +46,12 @@ class PoolBuilder private $stabilityFlags; /** * @var array[] - * @psalm-var array> + * @phpstan-var array> */ private $rootAliases; /** * @var string[] - * @psalm-var array + * @phpstan-var array */ private $rootReferences; /** @@ -64,22 +64,22 @@ class PoolBuilder private $io; /** * @var array[] - * @psalm-var array + * @phpstan-var array */ private $aliasMap = array(); /** * @var ConstraintInterface[] - * @psalm-var array + * @phpstan-var array */ private $packagesToLoad = array(); /** * @var ConstraintInterface[] - * @psalm-var array + * @phpstan-var array */ private $loadedPackages = array(); /** * @var array[] - * @psalm-var array>> + * @phpstan-var array>> */ private $loadedPerRepo = array(); /** @@ -88,7 +88,7 @@ class PoolBuilder private $packages = array(); /** * @var PackageInterface[] - * @psalm-var list + * @phpstan-var list */ private $unacceptableFixedOrLockedPackages = array(); private $updateAllowList = array(); @@ -105,7 +105,7 @@ class PoolBuilder private $maxExtendedReqs = array(); /** * @var array - * @psalm-var array + * @phpstan-var array */ private $updateAllowWarned = array(); @@ -113,13 +113,13 @@ class PoolBuilder /** * @param int[] $acceptableStabilities array of stability => BasePackage::STABILITY_* value - * @psalm-param array $acceptableStabilities + * @phpstan-param array $acceptableStabilities * @param int[] $stabilityFlags an array of package name => BasePackage::STABILITY_* value - * @psalm-param array $stabilityFlags + * @phpstan-param array $stabilityFlags * @param array[] $rootAliases - * @psalm-param array> $rootAliases + * @phpstan-param array> $rootAliases * @param string[] $rootReferences an array of package name => source reference - * @psalm-param array $rootReferences + * @phpstan-param array $rootReferences */ public function __construct(array $acceptableStabilities, array $stabilityFlags, array $rootAliases, array $rootReferences, IOInterface $io, EventDispatcher $eventDispatcher = null) { diff --git a/src/Composer/Downloader/GitDownloader.php b/src/Composer/Downloader/GitDownloader.php index 3a8d60fa5..d083826bf 100644 --- a/src/Composer/Downloader/GitDownloader.php +++ b/src/Composer/Downloader/GitDownloader.php @@ -29,12 +29,12 @@ class GitDownloader extends VcsDownloader implements DvcsDownloaderInterface { /** * @var bool[] - * @psalm-var array + * @phpstan-var array */ private $hasStashedChanges = array(); /** * @var bool[] - * @psalm-var array + * @phpstan-var array */ private $hasDiscardedChanges = array(); /** @@ -43,7 +43,7 @@ class GitDownloader extends VcsDownloader implements DvcsDownloaderInterface private $gitUtil; /** * @var array - * @psalm-var array> + * @phpstan-var array> */ private $cachedPackages = array(); diff --git a/src/Composer/Package/BasePackage.php b/src/Composer/Package/BasePackage.php index f90f20d91..a7a075099 100644 --- a/src/Composer/Package/BasePackage.php +++ b/src/Composer/Package/BasePackage.php @@ -23,7 +23,7 @@ use Composer\Repository\PlatformRepository; abstract class BasePackage implements PackageInterface { /** - * @psalm-var array + * @phpstan-var array */ public static $supportedLinkTypes = array( 'require' => array('description' => 'requires', 'method' => Link::TYPE_REQUIRE), diff --git a/src/Composer/Package/Link.php b/src/Composer/Package/Link.php index 052181187..8b0eab07f 100644 --- a/src/Composer/Package/Link.php +++ b/src/Composer/Package/Link.php @@ -63,7 +63,7 @@ class Link /** * @var string - * @psalm-var self::TYPE_* $description + * @phpstan-var self::TYPE_* $description */ protected $description; diff --git a/src/Composer/Package/PackageInterface.php b/src/Composer/Package/PackageInterface.php index 0c2ac8ec3..7f0fb1023 100644 --- a/src/Composer/Package/PackageInterface.php +++ b/src/Composer/Package/PackageInterface.php @@ -219,7 +219,7 @@ interface PackageInterface * @param int $displayMode One of the DISPLAY_ constants on this interface determining display of references * @return string version * - * @psalm-param self::DISPLAY_SOURCE_REF_IF_DEV|self::DISPLAY_SOURCE_REF|self::DISPLAY_DIST_REF $displayMode + * @phpstan-param self::DISPLAY_SOURCE_REF_IF_DEV|self::DISPLAY_SOURCE_REF|self::DISPLAY_DIST_REF $displayMode */ public function getFullPrettyVersion($truncate = true, $displayMode = self::DISPLAY_SOURCE_REF_IF_DEV); @@ -282,7 +282,7 @@ interface PackageInterface * combination with this package. * * @return array An array of package suggestions with descriptions - * @psalm-return array + * @phpstan-return array */ public function getSuggests(); @@ -295,7 +295,7 @@ interface PackageInterface * directories for autoloading using the type specified. * * @return array Mapping of autoloading rules - * @psalm-return array{psr-0?: array, psr-4?: array, classmap?: list, files?: list} + * @phpstan-return array{psr-0?: array, psr-4?: array, classmap?: list, files?: list} */ public function getAutoload(); @@ -308,7 +308,7 @@ interface PackageInterface * directories for autoloading using the type specified. * * @return array Mapping of dev autoloading rules - * @psalm-return array{psr-0?: array, psr-4?: array, classmap?: list, files?: list} + * @phpstan-return array{psr-0?: array, psr-4?: array, classmap?: list, files?: list} */ public function getDevAutoload(); diff --git a/src/Composer/Package/Version/StabilityFilter.php b/src/Composer/Package/Version/StabilityFilter.php index 9ea44cdda..d502da257 100644 --- a/src/Composer/Package/Version/StabilityFilter.php +++ b/src/Composer/Package/Version/StabilityFilter.php @@ -23,9 +23,9 @@ class StabilityFilter * Checks if any of the provided package names in the given stability match the configured acceptable stability and flags * * @param int[] $acceptableStabilities array of stability => BasePackage::STABILITY_* value - * @psalm-param array $acceptableStabilities + * @phpstan-param array $acceptableStabilities * @param int[] $stabilityFlags an array of package name => BasePackage::STABILITY_* value - * @psalm-param array $stabilityFlags + * @phpstan-param array $stabilityFlags * @param string[] $names The package name(s) to check for stability flags * @param string $stability one of 'stable', 'RC', 'beta', 'alpha' or 'dev' * @return bool true if any package name is acceptable diff --git a/src/Composer/Plugin/PrePoolCreateEvent.php b/src/Composer/Plugin/PrePoolCreateEvent.php index b3d3079d6..e5e46e708 100644 --- a/src/Composer/Plugin/PrePoolCreateEvent.php +++ b/src/Composer/Plugin/PrePoolCreateEvent.php @@ -109,7 +109,7 @@ class PrePoolCreateEvent extends Event /** * @return array[] of package => version => [alias, alias_normalized] - * @psalm-return array> + * @phpstan-return array> */ public function getRootAliases() { diff --git a/src/Composer/Repository/RepositoryInterface.php b/src/Composer/Repository/RepositoryInterface.php index 60d73c992..698a8d1a9 100644 --- a/src/Composer/Repository/RepositoryInterface.php +++ b/src/Composer/Repository/RepositoryInterface.php @@ -87,7 +87,7 @@ interface RepositoryInterface extends \Countable * @param string $type The type of package to search for. Defaults to all types of packages * * @return array[] an array of array('name' => '...', 'description' => '...') - * @psalm-return list + * @phpstan-return list */ public function search($query, $mode = 0, $type = null); @@ -99,7 +99,7 @@ interface RepositoryInterface extends \Countable * @param string $packageName package name which must be provided * * @return array[] an array with the provider name as key and value of array('name' => '...', 'description' => '...', 'type' => '...') - * @psalm-return array + * @phpstan-return array */ public function getProviders($packageName); diff --git a/src/Composer/Repository/RepositorySet.php b/src/Composer/Repository/RepositorySet.php index 71ddba393..66db56833 100644 --- a/src/Composer/Repository/RepositorySet.php +++ b/src/Composer/Repository/RepositorySet.php @@ -41,13 +41,13 @@ class RepositorySet /** * @var array[] - * @psalm-var array> + * @phpstan-var array> */ private $rootAliases; /** * @var string[] - * @psalm-var array + * @phpstan-var array */ private $rootReferences; @@ -56,13 +56,13 @@ class RepositorySet /** * @var int[] array of stability => BasePackage::STABILITY_* value - * @psalm-var array + * @phpstan-var array */ private $acceptableStabilities; /** * @var int[] array of package name => BasePackage::STABILITY_* value - * @psalm-var array + * @phpstan-var array */ private $stabilityFlags; @@ -80,11 +80,11 @@ class RepositorySet * * @param string $minimumStability * @param int[] $stabilityFlags an array of package name => BasePackage::STABILITY_* value - * @psalm-param array $stabilityFlags + * @phpstan-param array $stabilityFlags * @param array[] $rootAliases - * @psalm-param list $rootAliases + * @phpstan-param list $rootAliases * @param string[] $rootReferences an array of package name => source reference - * @psalm-param array $rootReferences + * @phpstan-param array $rootReferences */ public function __construct($minimumStability = 'stable', array $stabilityFlags = array(), array $rootAliases = array(), array $rootReferences = array(), array $rootRequires = array()) { diff --git a/src/Composer/Util/ProcessExecutor.php b/src/Composer/Util/ProcessExecutor.php index 88dd5ae84..36a75cbff 100644 --- a/src/Composer/Util/ProcessExecutor.php +++ b/src/Composer/Util/ProcessExecutor.php @@ -38,7 +38,7 @@ class ProcessExecutor protected $io; /** - * @psalm-var array> + * @phpstan-var array> */ private $jobs = array(); private $runningJobs = 0; diff --git a/src/Composer/Util/StreamContextFactory.php b/src/Composer/Util/StreamContextFactory.php index 82e1e9ec3..ed402a624 100644 --- a/src/Composer/Util/StreamContextFactory.php +++ b/src/Composer/Util/StreamContextFactory.php @@ -30,7 +30,7 @@ final class StreamContextFactory * Creates a context supporting HTTP proxies * * @param string $url URL the context is to be used for - * @psalm-param array{http?: array{follow_location?: int, max_redirects?: int, header?: string|array}} $defaultOptions + * @phpstan-param array{http?: array{follow_location?: int, max_redirects?: int, header?: string|array}} $defaultOptions * @param array $defaultOptions Options to merge with the default * @param array $defaultParams Parameters to specify on the context * @throws \RuntimeException if https proxy required and OpenSSL uninstalled @@ -59,7 +59,7 @@ final class StreamContextFactory * @param string $url * @param array $options * @param bool $forCurl When true, will not add proxy values as these are handled separately - * @psalm-return array{http:{header: string[], proxy?: string, request_fulluri: bool}, ssl: array} + * @phpstan-return array{http:{header: string[], proxy?: string, request_fulluri: bool}, ssl: array} * @return array formatted as a stream context array */ public static function initOptions($url, array $options, $forCurl = false)