Add migrate:neon2attributes command and extend attribute services

.gitattributes

@@ -2,5 +2,6 @@
 *.stub linguist-language=PHP
 
 tests/PHPStan/Command/ErrorFormatter/data/WindowsNewlines.php eol=crlf
+tests/PHPStan/Command/Neon2Attributes/data/** text eol=lf
 
 .github/workflows/*.lock.yml linguist-generated=true merge=ours

Makefile

@@ -41,6 +41,7 @@ lint:
 		--exclude tests/PHPStan/Rules/Functions/data/arrow-function-nullsafe-by-ref.php \
 		--exclude tests/PHPStan/Levels/data/namedArguments.php \
 		--exclude tests/PHPStan/DependencyInjection/AttributeServices/data \
+		--exclude tests/PHPStan/Command/Neon2Attributes/data \
 		--exclude tests/PHPStan/Reflection/BetterReflection/SourceLocator/data/symbol-finder/class-name-before-global-constant.php \
 		--exclude tests/PHPStan/Rules/Keywords/data/continue-break.php \
 		--exclude tests/PHPStan/Rules/Keywords/data/continue-break-property-hook.php \

bin/phpstan

@@ -7,6 +7,7 @@ use PHPStan\Command\ClearResultCacheCommand;
 use PHPStan\Command\DiagnoseCommand;
 use PHPStan\Command\DumpParametersCommand;
 use PHPStan\Command\FixerWorkerCommand;
+use PHPStan\Command\Neon2AttributesCommand;
 use PHPStan\Command\ResultCacheInfoCommand;
 use PHPStan\Command\WorkerCommand;
 use PHPStan\Internal\ComposerHelper;
@@ -144,5 +145,6 @@ use Symfony\Component\Console\Helper\ProgressBar;
 	$application->add(new FixerWorkerCommand($reversedComposerAutoloaderProjectPaths));
 	$application->add(new DumpParametersCommand($reversedComposerAutoloaderProjectPaths));
 	$application->add(new DiagnoseCommand($reversedComposerAutoloaderProjectPaths));
+	$application->add(new Neon2AttributesCommand($reversedComposerAutoloaderProjectPaths));
 	$application->run();
 })();

build/baseline-pre-8.0.neon

@@ -36,6 +36,42 @@ parameters:
 			count: 1
 			path: ../src/DependencyInjection/AttributeServices/AttributeServicesDiscoverer.php
 
+		-
+			rawMessage: 'Call to an undefined method ReflectionClass<object>::getAttributes().'
+			identifier: method.notFound
+			count: 2
+			path: ../src/Command/Neon2Attributes/Neon2AttributesMigrator.php
+
+		-
+			rawMessage: 'Call to an undefined method ReflectionParameter::getAttributes().'
+			identifier: method.notFound
+			count: 1
+			path: ../src/Command/Neon2Attributes/Neon2AttributesMigrator.php
+
+		-
+			rawMessage: 'Call to method is() of internal class Symfony\Polyfill\Php80\PhpToken from outside its root namespace Symfony.'
+			identifier: method.internalClass
+			count: 5
+			path: ../src/DependencyInjection/AttributeServices/AttributeServicesDiscoverer.php
+
+		-
+			rawMessage: 'Access to property $text of internal class Symfony\Polyfill\Php80\PhpToken from outside its root namespace Symfony.'
+			identifier: property.internalClass
+			count: 2
+			path: ../src/DependencyInjection/AttributeServices/AttributeServicesDiscoverer.php
+
+		-
+			rawMessage: 'Call to method getTokenName() of internal class Symfony\Polyfill\Php80\PhpToken from outside its root namespace Symfony.'
+			identifier: method.internalClass
+			count: 1
+			path: ../src/DependencyInjection/AttributeServices/AttributeServicesDiscoverer.php
+
+		-
+			rawMessage: 'Call to method isIgnorable() of internal class Symfony\Polyfill\Php80\PhpToken from outside its root namespace Symfony.'
+			identifier: method.internalClass
+			count: 1
+			path: ../src/DependencyInjection/AttributeServices/AttributeServicesDiscoverer.php
+
 		-
 			rawMessage: 'Class AttributeServicesFixtures\DiscoveredConditionalRuleNotMet not found.'
 			identifier: class.notFound

build/phpstan.neon

@@ -198,6 +198,7 @@ parameters:
 			paths:
 				- ../src/Neon/*
 				- ../src/Analyser/Ignore/IgnoreErrorsConfigFixer.php
+				- ../src/Command/Neon2Attributes/Neon2AttributesMigrator.php
 				- ../tests/PHPStan/Neon/*
 		-
 			rawMessage: 'Property PHPStan\Command\CommandHelper::$reservedMemory is never read' # intentional

conf/config.neon

@@ -271,6 +271,10 @@ parameters:
 autowiredAttributeServices:
 	level: null
 
+# vendor interfaces cannot carry the #[PHPStan\DependencyInjection\ExtensionInterface] attribute
+extensionInterfaces:
+	PhpParser\NodeVisitor: phpstan.parser.richParserNodeVisitor
+
 # autowired services are registered with the help of attributes
 # like #[PHPStan\DependencyInjection\AutowiredService] or #[PHPStan\DependencyInjection\GenerateFactory],
 # optionally wrapped in #[PHPStan\DependencyInjection\Conditional]

phpstan-baseline.neon

@@ -235,6 +235,18 @@ parameters:
 			count: 1
 			path: src/Command/ErrorsConsoleStyle.php
 
+		-
+			rawMessage: 'Call to method __construct() of internal class PhpParser\Internal\TokenStream from outside its root namespace PhpParser.'
+			identifier: method.internalClass
+			count: 1
+			path: src/Command/Neon2Attributes/PhpClassAttributesWriter.php
+
+		-
+			rawMessage: Instantiation of internal class PhpParser\Internal\TokenStream.
+			identifier: new.internalClass
+			count: 1
+			path: src/Command/Neon2Attributes/PhpClassAttributesWriter.php
+
 		-
 			rawMessage: 'Call to static method escape() of internal class Nette\DI\Helpers from outside its root namespace Nette.'
 			identifier: staticMethod.internalClass
@@ -244,7 +256,13 @@ parameters:
 		-
 			rawMessage: 'Call to static method expand() of internal class Nette\DI\Helpers from outside its root namespace Nette.'
 			identifier: staticMethod.internalClass
-			count: 1
+			count: 2
+			path: src/DependencyInjection/AttributeServices/AttributeServicesRegistrar.php
+
+		-
+			rawMessage: 'Call to static method filterArguments() of internal class Nette\DI\Helpers from outside its root namespace Nette.'
+			identifier: staticMethod.internalClass
+			count: 2
 			path: src/DependencyInjection/AttributeServices/AttributeServicesRegistrar.php
 
 		-

src/Command/CommandHelper.php

@@ -183,21 +183,9 @@ public static function begin(
 			})($autoloadFile);
 		}
 		if ($projectConfigFile === null) {
-			$discoverableConfigNames = [
-				'.phpstan.neon',
-				'phpstan.neon',
-				'.phpstan.neon.dist',
-				'phpstan.neon.dist',
-				'.phpstan.dist.neon',
-				'phpstan.dist.neon',
-			];
-			foreach ($discoverableConfigNames as $discoverableConfigName) {
-				$discoverableConfigFile = $currentWorkingDirectory . DIRECTORY_SEPARATOR . $discoverableConfigName;
-				if (is_file($discoverableConfigFile)) {
-					$projectConfigFile = $discoverableConfigFile;
-					$errorOutput->writeLineFormatted(sprintf('Note: Using configuration file %s.', $projectConfigFile));
-					break;
-				}
+			$projectConfigFile = self::findDiscoverableConfigFile($currentWorkingDirectory);
+			if ($projectConfigFile !== null) {
+				$errorOutput->writeLineFormatted(sprintf('Note: Using configuration file %s.', $projectConfigFile));
 			}
 		} else {
 			$projectConfigFile = $currentWorkingDirectoryFileHelper->normalizePath($currentWorkingDirectoryFileHelper->absolutizePath($projectConfigFile));
@@ -664,4 +652,24 @@ public static function executeBootstrapFile(
 		}
 	}
 
+	public static function findDiscoverableConfigFile(string $currentWorkingDirectory): ?string
+	{
+		$discoverableConfigNames = [
+			'.phpstan.neon',
+			'phpstan.neon',
+			'.phpstan.neon.dist',
+			'phpstan.neon.dist',
+			'.phpstan.dist.neon',
+			'phpstan.dist.neon',
+		];
+		foreach ($discoverableConfigNames as $discoverableConfigName) {
+			$discoverableConfigFile = $currentWorkingDirectory . DIRECTORY_SEPARATOR . $discoverableConfigName;
+			if (is_file($discoverableConfigFile)) {
+				return $discoverableConfigFile;
+			}
+		}
+
+		return null;
+	}
+
 }

src/Command/Neon2Attributes/AttributeSpec.php

@@ -0,0 +1,22 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Command\Neon2Attributes;
+
+/**
+ * An attribute from the PHPStan\DependencyInjection namespace to write into a PHP file.
+ */
+final class AttributeSpec
+{
+
+	/**
+	 * @param non-empty-string $name short name of the attribute class
+	 * @param array<non-empty-string, mixed> $arguments named arguments; the values are scalars, lists and maps of them, ClassReference and AttributeSpec for `new`
+	 */
+	public function __construct(
+		public string $name,
+		public array $arguments = [],
+	)
+	{
+	}
+
+}

src/Command/Neon2Attributes/AttributesPrinter.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Command\Neon2Attributes;
+
+use Override;
+use PhpParser\Node;
+use PhpParser\PrettyPrinter\Standard;
+
+/**
+ * Prints attributes of parameters in a one-line parameter list on the same line,
+ * other attributes go on their own line.
+ */
+final class AttributesPrinter extends Standard
+{
+
+	public const INLINE_ATTRIBUTES = 'neon2attributesInline';
+
+	#[Override]
+	protected function pParam(Node\Param $node): string
+	{
+		if ($node->getAttribute(self::INLINE_ATTRIBUTES) !== true) {
+			return parent::pParam($node);
+		}
+
+		$param = clone $node;
+		$param->attrGroups = [];
+
+		return $this->pAttrGroups($node->attrGroups, true) . parent::pParam($param);
+	}
+
+}

src/Command/Neon2Attributes/ClassAttributes.php

@@ -0,0 +1,22 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Command\Neon2Attributes;
+
+use ReflectionClass;
+
+final class ClassAttributes
+{
+
+	/**
+	 * @param ReflectionClass<object> $reflection
+	 * @param array<string, AttributeSpec> $parameterAttributes by constructor parameter name
+	 */
+	public function __construct(
+		public ReflectionClass $reflection,
+		public AttributeSpec $attribute,
+		public array $parameterAttributes,
+	)
+	{
+	}
+
+}

src/Command/Neon2Attributes/ClassReference.php

@@ -0,0 +1,15 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Command\Neon2Attributes;
+
+/**
+ * Written as `ClassName::class`.
+ */
+final class ClassReference
+{
+
+	public function __construct(public string $className)
+	{
+	}
+
+}

src/Command/Neon2Attributes/ComposerConfigIncludes.php

@@ -0,0 +1,70 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Command\Neon2Attributes;
+
+use Nette\FileNotFoundException;
+use Nette\InvalidStateException;
+use Nette\Utils\Json;
+use Nette\Utils\JsonException;
+use PHPStan\DependencyInjection\LoaderFactory;
+use PHPStan\File\CouldNotReadFileException;
+use PHPStan\File\FileHelper;
+use PHPStan\File\FileReader;
+use function array_map;
+use function dirname;
+use function in_array;
+use function is_array;
+use function is_file;
+use function is_string;
+
+/**
+ * Finds the config files of an extension that phpstan/extension-installer would include
+ * for the projects that install it, listed in `extra.phpstan.includes` of composer.json.
+ */
+final class ComposerConfigIncludes
+{
+
+	/**
+	 * @return list<string> the files not included by the project config file already
+	 */
+	public static function findMissing(string $directory, ?string $projectConfigFile): array
+	{
+		$fileHelper = new FileHelper($directory);
+		try {
+			$composer = Json::decode(FileReader::read($directory . '/composer.json'), Json::FORCE_ARRAY);
+		} catch (CouldNotReadFileException | JsonException) {
+			return [];
+		}
+		$includes = $composer['extra']['phpstan']['includes'] ?? null;
+		if (!is_array($includes)) {
+			return [];
+		}
+
+		$included = [];
+		if ($projectConfigFile !== null) {
+			$loader = (new LoaderFactory($fileHelper, dirname(__DIR__, 3), $directory, null, []))->createLoader();
+			try {
+				$loader->load($projectConfigFile, null);
+			} catch (InvalidStateException | FileNotFoundException) {
+				// reported when the container is created
+				return [];
+			}
+			$included = array_map(static fn (string $file): string => $fileHelper->normalizePath($file), $loader->getDependencies());
+		}
+
+		$missing = [];
+		foreach ($includes as $include) {
+			if (!is_string($include)) {
+				continue;
+			}
+			$file = $fileHelper->normalizePath($fileHelper->absolutizePath($include));
+			if (!is_file($file) || in_array($file, $included, true)) {
+				continue;
+			}
+			$missing[] = $file;
+		}
+
+		return $missing;
+	}
+
+}

src/Command/Neon2Attributes/ConvertedService.php

@@ -0,0 +1,22 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Command\Neon2Attributes;
+
+/**
+ * A service entry of a NEON config file replaced by attributes on its class.
+ */
+final class ConvertedService
+{
+
+	/**
+	 * @param list<string> $attributes short names of the added attributes
+	 */
+	public function __construct(
+		public string $className,
+		public array $attributes,
+		public string $configFile,
+	)
+	{
+	}
+
+}