[BE] No implicit wildcard in FileExcluder

Author: ondrejmirtes

UPGRADING.md

@@ -32,6 +32,27 @@ Don't forget to update [3rd party PHPStan extensions](https://phpstan.org/user-g
 
 After changing your `composer.json`, run `composer update 'phpstan/*' -W`.
 
+### Paths in `excludePaths` and `ignoreErrors` have to be a valid file path or a fnmatch pattern
+
+If you are excluding a file path that might not exist but you still want to have it in `excludePaths`, append `(?)`:
+
+```neon
+parameters:
+	excludePaths:
+		- tests/*/data/*
+		- src/broken
+		- node_modules (?) # optional path, might not exist
+```
+
+If you have the same situation in `ignoreErrors` (ignoring an error in a path that might not exist), use `reportUnmatchedIgnoredErrors: false`.
+
+```neon
+parameters:
+	reportUnmatchedIgnoredErrors: false
+```
+
+Appending `(?)` in `ignoreErrors` is not supported.
+
 ## Upgrading guide for extension developers
 
 ### PHPStan now uses nikic/php-parser v5

changelog-2.0.md

@@ -120,9 +120,7 @@ Bleeding edge (TODO move to other sections)
 * Check types in `@property` tags (https://github.com/phpstan/phpstan-src/commit/55ea2ae516df22a071ab873fdd6f748a3af0520e), #10752, #9356
 * Check types in `@method` tags (https://github.com/phpstan/phpstan-src/commit/5b7e474680eaf33874b7ed6a227677adcbed9ca5)
 * Check `@extends`, `@implements`, `@use` for unresolvable types (https://github.com/phpstan/phpstan-src/commit/2bb528233edb75312614166e282776f279cf2018), #11552
-* Report invalid exclude paths in PHP config (https://github.com/phpstan/phpstan-src/commit/9718c14f1ffac81ba3d2bf331b4e8b4041a4d004)
 * RegularExpressionPatternRule: validate preg_quote'd patterns ([#3270](https://github.com/phpstan/phpstan-src/pull/3270)), thanks @staabm!
-* No implicit wildcard in FileExcluder (https://github.com/phpstan/phpstan-src/commit/e19e6e5f8cfa706cc30e44a17276a6bc269f995c), #10299
 * Report useless return values of function calls like `var_export` without `$return=true` ([#3225](https://github.com/phpstan/phpstan-src/pull/3225)), #11320, thanks @staabm!
 * Check mixed in binary operator ([#3231](https://github.com/phpstan/phpstan-src/pull/3231)), #7538, #10440, thanks @schlndh!
 * Check vprintf/vsprintf arguments against placeholder count ([#3126](https://github.com/phpstan/phpstan-src/pull/3126)), thanks @staabm!
@@ -140,6 +138,8 @@ Improvements 🔧
 * Unescape strings in PHPDoc parser (https://github.com/phpstan/phpstan-src/commit/97786ed8376b478ec541ea9df1c450c1fbfe7461)
 * PHPDoc parser: add config for lines in its AST & enable ignoring errors within PHPDocs ([#2807](https://github.com/phpstan/phpstan-src/pull/2807)), thanks @janedbal!
 * InvalidPhpDocTagValueRule: include PHPDoc line number in the error message (https://github.com/phpstan/phpstan-src/commit/a04e0be832900749b5b4ba22e2de21db8bfa09a0)
+* No implicit wildcard in FileExcluder (https://github.com/phpstan/phpstan-src/commit/e19e6e5f8cfa706cc30e44a17276a6bc269f995c), #10299
+* Report invalid exclude paths in PHP config (https://github.com/phpstan/phpstan-src/commit/9718c14f1ffac81ba3d2bf331b4e8b4041a4d004)
 
 Bugfixes 🐛
 =====================

conf/bleedingEdge.neon

@@ -53,7 +53,6 @@ parameters:
 		printfArrayParameters: true
 		preciseMissingReturn: true
 		validatePregQuote: true
-		noImplicitWildcard: true
 		tooWidePropertyType: true
 		explicitThrow: true
 		absentTypeChecks: true

conf/config.neon

@@ -89,7 +89,6 @@ parameters:
 		printfArrayParameters: false
 		preciseMissingReturn: false
 		validatePregQuote: false
-		noImplicitWildcard: false
 		requireFileExists: false
 		narrowPregMatches: true
 		tooWidePropertyType: false
@@ -682,8 +681,6 @@ services:
 
 	-
 		implement: PHPStan\File\FileExcluderRawFactory
-		arguments:
-			noImplicitWildcard: %featureToggles.noImplicitWildcard%
 
 	fileExcluderAnalyse:
 		class: PHPStan\File\FileExcluder

conf/parametersSchema.neon

@@ -83,7 +83,6 @@ parametersSchema:
 		printfArrayParameters: bool()
 		preciseMissingReturn: bool()
 		validatePregQuote: bool()
-		noImplicitWildcard: bool()
 		narrowPregMatches: bool()
 		tooWidePropertyType: bool()
 		explicitThrow: bool()

src/Analyser/Ignore/IgnoredError.php

@@ -4,7 +4,6 @@
 
 use Nette\Utils\Strings;
 use PHPStan\Analyser\Error;
-use PHPStan\DependencyInjection\BleedingEdgeToggle;
 use PHPStan\File\FileExcluder;
 use PHPStan\File\FileHelper;
 use PHPStan\ShouldNotHappenException;
@@ -86,7 +85,7 @@ public static function shouldIgnore(
 		}
 
 		if ($path !== null) {
-			$fileExcluder = new FileExcluder($fileHelper, [$path], BleedingEdgeToggle::isBleedingEdge());
+			$fileExcluder = new FileExcluder($fileHelper, [$path]);
 			$isExcluded = $fileExcluder->isExcludedFromAnalysing($error->getFilePath());
 			if (!$isExcluded && $error->getTraitFilePath() !== null) {
 				return $fileExcluder->isExcludedFromAnalysing($error->getTraitFilePath());

src/Command/CommandHelper.php

@@ -609,7 +609,7 @@ public static function begin(
 
 			$pathRoutingParser->setAnalysedFiles($files);
 
-			$stubFilesExcluder = new FileExcluder($currentWorkingDirectoryFileHelper, $stubFilesProvider->getProjectStubFiles(), true);
+			$stubFilesExcluder = new FileExcluder($currentWorkingDirectoryFileHelper, $stubFilesProvider->getProjectStubFiles());
 
 			$files = array_values(array_filter($files, static fn (string $file) => !$stubFilesExcluder->isExcludedFromAnalysing($file)));
 

src/DependencyInjection/ValidateExcludePathsExtension.php

@@ -28,8 +28,7 @@ public function loadConfiguration(): void
 		}
 
 		$errors = [];
-		$noImplicitWildcard = $builder->parameters['featureToggles']['noImplicitWildcard'];
-		if ($builder->parameters['__validate'] && $noImplicitWildcard) {
+		if ($builder->parameters['__validate']) {
 			$paths = [];
 			if (array_key_exists('analyse', $excludePaths)) {
 				$paths = $excludePaths['analyse'];

src/DependencyInjection/ValidateIgnoredErrorsExtension.php

@@ -59,8 +59,6 @@ public function loadConfiguration(): void
 			return;
 		}
 
-		$noImplicitWildcard = $builder->parameters['featureToggles']['noImplicitWildcard'];
-
 		/** @throws void */
 		$parser = Llk::load(new Read(__DIR__ . '/../../resources/RegexGrammar.pp'));
 		$reflectionProvider = new DummyReflectionProvider();
@@ -141,7 +139,7 @@ public function getRegistry(): OperatorTypeSpecifyingExtensionRegistry
 
 		$reportUnmatched = (bool) $builder->parameters['reportUnmatchedIgnoredErrors'];
 
-		if ($noImplicitWildcard && $reportUnmatched) {
+		if ($reportUnmatched) {
 			foreach ($ignoreErrors as $ignoreError) {
 				if (!is_array($ignoreError)) {
 					continue;

src/File/FileExcluder.php

@@ -52,7 +52,6 @@ final class FileExcluder
 	public function __construct(
 		FileHelper $fileHelper,
 		array $analyseExcludes,
-		private bool $noImplicitWildcard,
 	)
 	{
 		foreach ($analyseExcludes as $exclude) {
@@ -68,18 +67,14 @@ public function __construct(
 			if (self::isFnmatchPattern($normalized)) {
 				$this->fnmatchAnalyseExcludes[] = $normalized;
 			} else {
-				if ($this->noImplicitWildcard) {
-					if (is_file($normalized)) {
-						$this->literalAnalyseFilesExcludes[] = $normalized;
-					} elseif (is_dir($normalized)) {
-						if (!$trailingDirSeparator) {
-							$normalized .= DIRECTORY_SEPARATOR;
-						}
-
-						$this->literalAnalyseDirectoryExcludes[] = $normalized;
+				if (is_file($normalized)) {
+					$this->literalAnalyseFilesExcludes[] = $normalized;
+				} elseif (is_dir($normalized)) {
+					if (!$trailingDirSeparator) {
+						$normalized .= DIRECTORY_SEPARATOR;
 					}
-				} else {
-					$this->literalAnalyseExcludes[] = $fileHelper->absolutizePath($normalized);
+
+					$this->literalAnalyseDirectoryExcludes[] = $normalized;
 				}
 			}
 		}
@@ -99,16 +94,14 @@ public function isExcludedFromAnalysing(string $file): bool
 				return true;
 			}
 		}
-		if ($this->noImplicitWildcard) {
-			foreach ($this->literalAnalyseDirectoryExcludes as $exclude) {
-				if (str_starts_with($file, $exclude)) {
-					return true;
-				}
+		foreach ($this->literalAnalyseDirectoryExcludes as $exclude) {
+			if (str_starts_with($file, $exclude)) {
+				return true;
 			}
-			foreach ($this->literalAnalyseFilesExcludes as $exclude) {
-				if ($file === $exclude) {
-					return true;
-				}
+		}
+		foreach ($this->literalAnalyseFilesExcludes as $exclude) {
+			if ($file === $exclude) {
+				return true;
 			}
 		}
 		foreach ($this->fnmatchAnalyseExcludes as $exclude) {