Merge remote-tracking branch 'origin/1.10.x' into 1.11.x

.github/workflows/e2e-tests.yml

@@ -175,6 +175,10 @@ jobs:
             extensions: ""
           - script: "bin/phpstan analyse -l 8 e2e/phpstan-phpunit-190/test.php -c e2e/phpstan-phpunit-190/test.neon"
             extensions: ""
+          - script: "bin/phpstan analyse e2e/only-files-not-analysed-trait/src -c e2e/only-files-not-analysed-trait/ignore.neon"
+            extensions: ""
+          - script: "bin/phpstan analyse e2e/only-files-not-analysed-trait/src/Foo.php e2e/only-files-not-analysed-trait/src/BarTrait.php -c e2e/only-files-not-analysed-trait/no-ignore.neon"
+            extensions: ""
 
     steps:
       - name: "Checkout"

composer.json

@@ -24,7 +24,7 @@
 		"nikic/php-parser": "^4.17.1",
 		"ondram/ci-detector": "^3.4.0",
 		"ondrejmirtes/better-reflection": "6.12.0.2",
-		"phpstan/php-8-stubs": "0.3.72",
+		"phpstan/php-8-stubs": "0.3.73",
 		"phpstan/phpdoc-parser": "1.23.1",
 		"react/async": "^3",
 		"react/child-process": "^0.6.4",

e2e/only-files-not-analysed-trait/ignore.neon

@@ -0,0 +1,10 @@
+includes:
+	- ../../conf/bleedingEdge.neon
+
+parameters:
+	level: 8
+	ignoreErrors:
+		-
+			message: "#^Trait OnlyFilesNotAnalysedTrait\\\\BarTrait is used zero times and is not analysed\\.$#"
+			count: 1
+			path: src/BarTrait.php

e2e/only-files-not-analysed-trait/no-ignore.neon

@@ -0,0 +1,5 @@
+includes:
+	- ../../conf/bleedingEdge.neon
+
+parameters:
+	level: 8

e2e/only-files-not-analysed-trait/src/BarTrait.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace OnlyFilesNotAnalysedTrait;
+
+trait BarTrait
+{
+
+}

e2e/only-files-not-analysed-trait/src/Foo.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace OnlyFilesNotAnalysedTrait;
+
+class Foo
+{
+
+}

issue-bot/playground.neon

@@ -1,4 +1,5 @@
 rules:
 	- PHPStan\Rules\Playground\FunctionNeverRule
 	- PHPStan\Rules\Playground\MethodNeverRule
+	- PHPStan\Rules\Playground\NotAnalysedTraitRule
 	- PHPStan\Rules\Playground\NoPhpCodeRule

src/Command/AnalyseApplication.php

@@ -108,7 +108,7 @@ public function analyse(
 			$memoryUsageBytes = $analyserResult->getPeakMemoryUsageBytes();
 
 			if (!$hasInternalErrors) {
-				foreach ($this->getCollectedDataErrors($analyserResult->getCollectedData()) as $error) {
+				foreach ($this->getCollectedDataErrors($analyserResult->getCollectedData(), $onlyFiles) as $error) {
 					$errors[] = $error;
 				}
 			}
@@ -149,10 +149,10 @@ public function analyse(
 	 * @param CollectedData[] $collectedData
 	 * @return Error[]
 	 */
-	private function getCollectedDataErrors(array $collectedData): array
+	private function getCollectedDataErrors(array $collectedData, bool $onlyFiles): array
 	{
 		$nodeType = CollectedDataNode::class;
-		$node = new CollectedDataNode($collectedData);
+		$node = new CollectedDataNode($collectedData, $onlyFiles);
 		$file = 'N/A';
 		$scope = $this->scopeFactory->create(ScopeContext::create($file));
 		$errors = [];

src/Command/FixerWorkerCommand.php

@@ -145,7 +145,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 			$hasInternalErrors,
 		);
 		if (!$hasInternalErrors) {
-			foreach ($this->getCollectedDataErrors($container, $result->getCollectedData()) as $error) {
+			foreach ($this->getCollectedDataErrors($container, $result->getCollectedData(), $isOnlyFiles) as $error) {
 				$intermediateErrors[] = $error;
 			}
 		}
@@ -173,10 +173,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 	 * @param CollectedData[] $collectedData
 	 * @return Error[]
 	 */
-	private function getCollectedDataErrors(Container $container, array $collectedData): array
+	private function getCollectedDataErrors(Container $container, array $collectedData, bool $onlyFiles): array
 	{
 		$nodeType = CollectedDataNode::class;
-		$node = new CollectedDataNode($collectedData);
+		$node = new CollectedDataNode($collectedData, $onlyFiles);
 		$file = 'N/A';
 		$scope = $container->getByType(ScopeFactory::class)->create(ScopeContext::create($file));
 		$ruleRegistry = $container->getByType(RuleRegistry::class);

src/Node/CollectedDataNode.php

@@ -15,7 +15,7 @@ class CollectedDataNode extends NodeAbstract
 	/**
 	 * @param CollectedData[] $collectedData
 	 */
-	public function __construct(private array $collectedData)
+	public function __construct(private array $collectedData, private bool $onlyFiles)
 	{
 		parent::__construct([]);
 	}
@@ -45,6 +45,16 @@ public function get(string $collectorType): array
 		return $result;
 	}
 
+	/**
+	 * Indicates that only files were passed to the analyser, not directory paths.
+	 *
+	 * True being returned strongly suggests that it's a partial analysis, not full project analysis.
+	 */
+	public function isOnlyFilesAnalysis(): bool
+	{
+		return $this->onlyFiles;
+	}
+
 	public function getType(): string
 	{
 		return 'PHPStan_Node_CollectedDataNode';

src/Rules/Playground/NotAnalysedTraitRule.php

@@ -0,0 +1,62 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Playground;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\CollectedDataNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Rules\Traits\TraitDeclarationCollector;
+use PHPStan\Rules\Traits\TraitUseCollector;
+use function sprintf;
+use function strtolower;
+
+/**
+ * @implements Rule<CollectedDataNode>
+ */
+class NotAnalysedTraitRule implements Rule
+{
+
+	public function getNodeType(): string
+	{
+		return CollectedDataNode::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$traitDeclarationData = $node->get(TraitDeclarationCollector::class);
+		$traitUseData = $node->get(TraitUseCollector::class);
+
+		$declaredTraits = [];
+		foreach ($traitDeclarationData as $file => $declaration) {
+			foreach ($declaration as [$name, $line]) {
+				$declaredTraits[strtolower($name)] = [$file, $name, $line];
+			}
+		}
+
+		foreach ($traitUseData as $usedNamesData) {
+			foreach ($usedNamesData as $usedNames) {
+				foreach ($usedNames as $usedName) {
+					unset($declaredTraits[strtolower($usedName)]);
+				}
+			}
+		}
+
+		$errors = [];
+		foreach ($declaredTraits as [$file, $name, $line]) {
+			$errors[] = RuleErrorBuilder::message(sprintf(
+				'Trait %s is used zero times and is not analysed.',
+				$name,
+			))
+				->identifier('phpstanPlayground.traitUnused')
+				->file($file)
+				->line($line)
+				->tip('See: https://phpstan.org/blog/how-phpstan-analyses-traits')
+				->build();
+		}
+
+		return $errors;
+	}
+
+}

src/Rules/Traits/NotAnalysedTraitRule.php

@@ -23,6 +23,10 @@ public function getNodeType(): string
 
 	public function processNode(Node $node, Scope $scope): array
 	{
+		if ($node->isOnlyFilesAnalysis()) {
+			return [];
+		}
+
 		$traitDeclarationData = $node->get(TraitDeclarationCollector::class);
 		$traitUseData = $node->get(TraitUseCollector::class);
 

src/Testing/RuleTestCase.php

@@ -181,7 +181,7 @@ public function gatherAnalyserErrors(array $files): array
 			]);
 
 			$nodeType = CollectedDataNode::class;
-			$node = new CollectedDataNode($analyserResult->getCollectedData());
+			$node = new CollectedDataNode($analyserResult->getCollectedData(), false);
 			$scopeFactory = $this->createScopeFactory($this->createReflectionProvider(), $this->getTypeSpecifier());
 			$scope = $scopeFactory->create(ScopeContext::create('irrelevant'));
 			foreach ($ruleRegistry->getRules($nodeType) as $rule) {