Option to allow Xdebug for debugging purposes

phpstan · Oct 19, 2019 · 3b379a3 · 3b379a3
1 parent c327552
commit 3b379a3
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 9 deletions.
diff --git a/bin/phpstan b/bin/phpstan
@@ -1,7 +1,6 @@
 #!/usr/bin/env php
 <?php declare(strict_types=1);
 
-use Composer\XdebugHandler\XdebugHandler;
 use PHPStan\Command\AnalyseCommand;
 use PHPStan\Command\DumpDependenciesCommand;
 
@@ -42,10 +41,6 @@ if (is_file($devOrPharAutoloadFile)) {
 	require_once $devOrPharAutoloadFile;
 }
 
-$xdebug = new XdebugHandler('phpstan', '--ansi');
-$xdebug->check();
-unset($xdebug);
-
 $version = 'Version unknown';
 try {
 	$version = \Jean85\PrettyVersions::getVersion('phpstan/phpstan')->getPrettyVersion();

diff --git a/src/Command/AnalyseCommand.php b/src/Command/AnalyseCommand.php
@@ -31,6 +31,7 @@ protected function configure(): void
 				new InputOption('autoload-file', 'a', InputOption::VALUE_REQUIRED, 'Project\'s additional autoload file path'),
 				new InputOption('error-format', null, InputOption::VALUE_REQUIRED, 'Format in which to print the result of the analysis', 'table'),
 				new InputOption('memory-limit', null, InputOption::VALUE_REQUIRED, 'Memory limit for analysis'),
+				new InputOption('xdebug', null, InputOption::VALUE_NONE, 'Allow running with XDebug for debugging purposes'),
 			]);
 	}
 
@@ -63,6 +64,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 		$configuration = $input->getOption('configuration');
 		$level = $input->getOption(self::OPTION_LEVEL);
 		$pathsFile = $input->getOption('paths-file');
+		$allowXdebug = $input->getOption('xdebug');
 
 		if (
 			!is_array($paths)
@@ -71,6 +73,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 			|| (!is_string($configuration) && $configuration !== null)
 			|| (!is_string($level) && $level !== null)
 			|| (!is_string($pathsFile) && $pathsFile !== null)
+			|| (!is_bool($allowXdebug))
 		) {
 			throw new \PHPStan\ShouldNotHappenException();
 		}
@@ -84,7 +87,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 				$memoryLimit,
 				$autoloadFile,
 				$configuration,
-				$level
+				$level,
+				$allowXdebug
 			);
 		} catch (\PHPStan\Command\InceptionNotSuccessfulException $e) {
 			return 1;

diff --git a/src/Command/CommandHelper.php b/src/Command/CommandHelper.php
@@ -2,6 +2,7 @@
 
 namespace PHPStan\Command;
 
+use Composer\XdebugHandler\XdebugHandler;
 use Nette\DI\Config\Adapters\NeonAdapter;
 use Nette\DI\Config\Adapters\PhpAdapter;
 use Nette\DI\Helpers;
@@ -33,9 +34,15 @@ public static function begin(
 		?string $memoryLimit,
 		?string $autoloadFile,
 		?string $projectConfigFile,
-		?string $level
+		?string $level,
+		bool $allowXdebug
 	): InceptionResult
 	{
+		if (!$allowXdebug) {
+			$xdebug = new XdebugHandler('phpstan', '--ansi');
+			$xdebug->check();
+			unset($xdebug);
+		}
 		$errorOutput = $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output;
 		$consoleStyle = new ErrorsConsoleStyle($input, $output);
 		if ($memoryLimit !== null) {

diff --git a/src/Command/DumpDependenciesCommand.php b/src/Command/DumpDependenciesCommand.php
@@ -27,6 +27,7 @@ protected function configure(): void
 				new InputOption('autoload-file', 'a', InputOption::VALUE_REQUIRED, 'Project\'s additional autoload file path'),
 				new InputOption('memory-limit', null, InputOption::VALUE_REQUIRED, 'Memory limit for the run'),
 				new InputOption('analysed-paths', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Project-scope paths'),
+				new InputOption('xdebug', null, InputOption::VALUE_NONE, 'Allow running with XDebug for debugging purposes'),
 			]);
 	}
 
@@ -47,6 +48,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
 			/** @var string|null $pathsFile */
 			$pathsFile = $input->getOption('paths-file');
+
+			/** @var bool $allowXdebug */
+			$allowXdebug = $input->getOption('xdebug');
+
 			$inceptionResult = CommandHelper::begin(
 				$input,
 				$output,
@@ -55,7 +60,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 				$memoryLimit,
 				$autoloadFile,
 				$configurationFile,
-				'0' // irrelevant but prevents an error when a config file is passed
+				'0', // irrelevant but prevents an error when a config file is passed
+				$allowXdebug
 			);
 		} catch (\PHPStan\Command\InceptionNotSuccessfulException $e) {
 			return 1;

diff --git a/tests/PHPStan/Command/CommandHelperTest.php b/tests/PHPStan/Command/CommandHelperTest.php
@@ -116,7 +116,8 @@ public function testBegin(
 				null,
 				null,
 				$projectConfigFile,
-				$level
+				$level,
+				false
 			);
 			if ($expectException) {
 				$this->fail();