Moved the list of relative paths in parameters to parametersSchema.neon

This can now be extended by extensions and project configs!

Author: ondrejmirtes

build/ignore-by-architecture.neon.php

@@ -1,11 +1,12 @@
 <?php declare(strict_types = 1);
 
-use PHPStan\DependencyInjection\NeonAdapter;
-
-$adapter = new NeonAdapter();
-
 if (PHP_INT_SIZE === 4) {
-	return $adapter->load(__DIR__ . '/baseline-32bit.neon');
+	$config = [];
+	$config['includes'] = [
+		__DIR__ . '/baseline-32bit.neon',
+	];
+
+	return $config;
 }
 
 return [];

conf/config.neon

@@ -209,6 +209,7 @@ parameters:
 
 extensions:
 	rules: PHPStan\DependencyInjection\RulesExtension
+	expandRelativePaths: PHPStan\DependencyInjection\ExpandRelativePathExtension
 	conditionalTags: PHPStan\DependencyInjection\ConditionalTagsExtension
 	parametersSchema: PHPStan\DependencyInjection\ParametersSchemaExtension
 	validateIgnoredErrors: PHPStan\DependencyInjection\ValidateIgnoredErrorsExtension

conf/parametersSchema.neon

@@ -197,3 +197,22 @@ parametersSchema:
 	# internal - editor mode
 	singleReflectionFile: schema(string(), nullable())
 	singleReflectionInsteadOfFile: schema(string(), nullable())
+
+expandRelativePaths:
+	- '[parameters][paths][]'
+	- '[parameters][excludePaths][]'
+	- '[parameters][excludePaths][analyse][]'
+	- '[parameters][excludePaths][analyseAndScan][]'
+	- '[parameters][ignoreErrors][][paths][]'
+	- '[parameters][ignoreErrors][][path]'
+	- '[parameters][bootstrapFiles][]'
+	- '[parameters][scanFiles][]'
+	- '[parameters][scanDirectories][]'
+	- '[parameters][tmpDir]'
+	- '[parameters][pro][tmpDir]'
+	- '[parameters][memoryLimitFile]'
+	- '[parameters][benchmarkFile]'
+	- '[parameters][stubFiles][]'
+	- '[parameters][symfony][consoleApplicationLoader]'
+	- '[parameters][symfony][containerXmlPath]'
+	- '[parameters][doctrine][objectManagerLoader]'

src/Command/CommandHelper.php

@@ -257,6 +257,10 @@ public static function begin(
 				$containerFactory->getRootDirectory(),
 				$containerFactory->getCurrentWorkingDirectory(),
 				$generateBaselineFile,
+				[
+					'[parameters][paths][]',
+					'[parameters][tmpDir]',
+				],
 			))->createLoader();
 
 			try {

src/DependencyInjection/ContainerFactory.php

@@ -120,6 +120,7 @@ public function create(
 			$this->rootDirectory,
 			$this->currentWorkingDirectory,
 			$generateBaselineFile,
+			$projectConfig['expandRelativePaths'],
 		), $this->journalContainer);
 		$configurator->defaultExtensions = [
 			'php' => PhpExtension::class,
@@ -222,7 +223,7 @@ private function detectDuplicateIncludedFiles(
 		array $loaderParameters,
 	): array
 	{
-		$neonAdapter = new NeonAdapter();
+		$neonAdapter = new NeonAdapter([]);
 		$phpAdapter = new PhpAdapter();
 		$allConfigFiles = [];
 		$configArray = [];

src/DependencyInjection/ExpandRelativePathExtension.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DependencyInjection;
+
+use Nette\DI\CompilerExtension;
+use Nette\Schema\Expect;
+use Nette\Schema\Schema;
+
+final class ExpandRelativePathExtension extends CompilerExtension
+{
+
+	public function getConfigSchema(): Schema
+	{
+		return Expect::listOf('string');
+	}
+
+}

src/DependencyInjection/LoaderFactory.php

@@ -9,20 +9,26 @@
 final class LoaderFactory
 {
 
+	/**
+	 * @param list<string> $expandRelativePaths
+	 */
 	public function __construct(
 		private FileHelper $fileHelper,
 		private string $rootDir,
 		private string $currentWorkingDirectory,
 		private ?string $generateBaselineFile,
+		private array $expandRelativePaths,
 	)
 	{
 	}
 
 	public function createLoader(): Loader
 	{
+		$neonAdapter = new NeonAdapter($this->expandRelativePaths);
+
 		$loader = new NeonLoader($this->fileHelper, $this->generateBaselineFile);
-		$loader->addAdapter('dist', NeonAdapter::class);
-		$loader->addAdapter('neon', NeonAdapter::class);
+		$loader->addAdapter('dist', $neonAdapter);
+		$loader->addAdapter('neon', $neonAdapter);
 		$loader->setParameters([
 			'rootDir' => $this->rootDir,
 			'currentWorkingDirectory' => $this->currentWorkingDirectory,

src/DependencyInjection/NeonAdapter.php

@@ -29,13 +29,20 @@
 final class NeonAdapter implements Adapter
 {
 
-	public const CACHE_KEY = 'v30-no-underscore';
+	public const CACHE_KEY = 'v31-expand-relative-paths';
 
 	private const PREVENT_MERGING_SUFFIX = '!';
 
 	/** @var FileHelper[] */
 	private array $fileHelpers = [];
 
+	/**
+	 * @param list<string> $expandRelativePaths
+	 */
+	public function __construct(private array $expandRelativePaths)
+	{
+	}
+
 	/**
 	 * @return mixed[]
 	 */
@@ -117,25 +124,7 @@ public function process(array $arr, string $fileKey, string $file): array
 				}
 			}
 
-			if (in_array($keyToResolve, [
-				'[parameters][paths][]',
-				'[parameters][excludePaths][]',
-				'[parameters][excludePaths][analyse][]',
-				'[parameters][excludePaths][analyseAndScan][]',
-				'[parameters][ignoreErrors][][paths][]',
-				'[parameters][ignoreErrors][][path]',
-				'[parameters][bootstrapFiles][]',
-				'[parameters][scanFiles][]',
-				'[parameters][scanDirectories][]',
-				'[parameters][tmpDir]',
-				'[parameters][pro][tmpDir]',
-				'[parameters][memoryLimitFile]',
-				'[parameters][benchmarkFile]',
-				'[parameters][stubFiles][]',
-				'[parameters][symfony][consoleApplicationLoader]',
-				'[parameters][symfony][containerXmlPath]',
-				'[parameters][doctrine][objectManagerLoader]',
-			], true) && is_string($val) && !str_contains($val, '%') && !str_starts_with($val, '*')) {
+			if (in_array($keyToResolve, $this->expandRelativePaths, true) && is_string($val) && !str_contains($val, '%') && !str_starts_with($val, '*')) {
 				$fileHelper = $this->createFileHelperByFile($file);
 				$val = $fileHelper->normalizePath($fileHelper->absolutizePath($val));
 			}