Add AI agent detection to auto-switch to JSON output

Author: pushpak1300

composer.json

@@ -24,6 +24,7 @@
 		"nette/utils": "^3.2.5",
 		"nikic/php-parser": "^5.7.0",
 		"ondram/ci-detector": "^4.0",
+		"shipfastlabs/agent-detector": "^1.0",
 		"ondrejmirtes/better-reflection": "6.65.0.9",
 		"ondrejmirtes/composer-attribute-collector": "^1.1.1",
 		"ondrejmirtes/php-merge": "^4.1",

composer.lock

@@ -5,6 +5,7 @@
 use OndraM\CiDetector\CiDetector;
 use Override;
 use PHPStan\Analyser\InternalError;
+use PHPStan\Command\ErrorFormatter\AgentDetectedErrorFormatter;
 use PHPStan\Command\ErrorFormatter\BaselineNeonErrorFormatter;
 use PHPStan\Command\ErrorFormatter\BaselinePhpErrorFormatter;
 use PHPStan\Command\ErrorFormatter\ErrorFormatter;
@@ -235,11 +236,20 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 			$errorFormat = $inceptionResult->getContainer()->getParameter('errorFormat');
 		}
 
+		$container = $inceptionResult->getContainer();
+
+		if ($errorFormat === null) {
+			/** @var AgentDetectedErrorFormatter $agentFormatter */
+			$agentFormatter = $container->getByType(AgentDetectedErrorFormatter::class);
+			if ($agentFormatter->isAgentDetected()) {
+				$errorFormat = 'json';
+			}
+		}
+
 		if ($errorFormat === null) {
 			$errorFormat = 'table';
 		}
 
-		$container = $inceptionResult->getContainer();
 		$errorFormatterServiceName = sprintf('errorFormatter.%s', $errorFormat);
 		if (!$container->hasService($errorFormatterServiceName)) {
 			$errorOutput->writeLineFormatted(sprintf(

src/Command/AnalyseCommand.php

@@ -0,0 +1,35 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Command\ErrorFormatter;
+
+use AgentDetector\AgentDetector;
+use PHPStan\Command\AnalysisResult;
+use PHPStan\Command\Output;
+use PHPStan\DependencyInjection\AutowiredParameter;
+use PHPStan\DependencyInjection\AutowiredService;
+
+/**
+ * @api
+ */
+#[AutowiredService(as: AgentDetectedErrorFormatter::class)]
+final class AgentDetectedErrorFormatter implements ErrorFormatter
+{
+
+	public function __construct(
+		#[AutowiredParameter(ref: '@errorFormatter.json')]
+		private JsonErrorFormatter $jsonErrorFormatter,
+	)
+	{
+	}
+
+	public function isAgentDetected(): bool
+	{
+		return AgentDetector::detect()->isAgent;
+	}
+
+	public function formatErrors(AnalysisResult $analysisResult, Output $output): int
+	{
+		return $this->jsonErrorFormatter->formatErrors($analysisResult, $output);
+	}
+
+}

src/Command/ErrorFormatter/AgentDetectedErrorFormatter.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Command;
 
+use AgentDetector\AgentDetector;
 use OndraM\CiDetector\CiDetector;
 use Override;
 use Symfony\Component\Console\Helper\Helper;
@@ -29,6 +30,8 @@ final class ErrorsConsoleStyle extends SymfonyStyle
 
 	private ?bool $isCiDetected = null;
 
+	private ?bool $isAgentDetected = null;
+
 	public function __construct(InputInterface $input, OutputInterface $output)
 	{
 		parent::__construct($input, $output);
@@ -45,6 +48,11 @@ private function isCiDetected(): bool
 		return $this->isCiDetected;
 	}
 
+	private function isAgentDetected(): bool
+	{
+		return $this->isAgentDetected ??= AgentDetector::detect()->isAgent;
+	}
+
 	/**
 	 * @param string[] $headers
 	 * @param string[][] $rows
@@ -95,9 +103,10 @@ public function createProgressBar(int $max = 0): ProgressBar
 		}
 
 		$ci = $this->isCiDetected();
-		$this->progressBar->setOverwrite(!$ci);
+		$agent = $this->isAgentDetected();
+		$this->progressBar->setOverwrite(!$ci && !$agent);
 
-		if ($ci) {
+		if ($ci || $agent) {
 			$this->progressBar->minSecondsBetweenRedraws(15);
 			$this->progressBar->maxSecondsBetweenRedraws(30);
 		} elseif (DIRECTORY_SEPARATOR === '\\') {

src/Command/ErrorsConsoleStyle.php

@@ -0,0 +1,86 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Command\ErrorFormatter;
+
+use Override;
+use PHPStan\Testing\ErrorFormatterTestCase;
+use function putenv;
+
+class AgentDetectedErrorFormatterTest extends ErrorFormatterTestCase
+{
+
+	#[Override]
+	protected function setUp(): void
+	{
+		putenv('AI_AGENT');
+		putenv('CURSOR_TRACE_ID');
+		putenv('CURSOR_AGENT');
+		putenv('GEMINI_CLI');
+		putenv('CODEX_SANDBOX');
+		putenv('AUGMENT_AGENT');
+		putenv('OPENCODE_CLIENT');
+		putenv('OPENCODE');
+		putenv('CLAUDECODE');
+		putenv('CLAUDE_CODE');
+		putenv('REPL_ID');
+	}
+
+	#[Override]
+	protected function tearDown(): void
+	{
+		putenv('AI_AGENT');
+	}
+
+	public function testIsAgentDetectedReturnsFalse(): void
+	{
+		$formatter = new AgentDetectedErrorFormatter(new JsonErrorFormatter(false));
+		$this->assertFalse($formatter->isAgentDetected());
+	}
+
+	public function testIsAgentDetectedReturnsTrueWithAiAgent(): void
+	{
+		putenv('AI_AGENT=test');
+		$formatter = new AgentDetectedErrorFormatter(new JsonErrorFormatter(false));
+		$this->assertTrue($formatter->isAgentDetected());
+	}
+
+	public function testIsAgentDetectedReturnsTrueWithClaudeCode(): void
+	{
+		putenv('CLAUDE_CODE=1');
+		$formatter = new AgentDetectedErrorFormatter(new JsonErrorFormatter(false));
+		$this->assertTrue($formatter->isAgentDetected());
+	}
+
+	public function testFormatErrorsProducesValidJson(): void
+	{
+		$formatter = new AgentDetectedErrorFormatter(new JsonErrorFormatter(false));
+
+		$exitCode = $formatter->formatErrors(
+			$this->getAnalysisResult(1, 0),
+			$this->getOutput(),
+		);
+
+		$this->assertSame(1, $exitCode);
+		$this->assertJsonStringEqualsJsonString(
+			'{"totals":{"errors":0,"file_errors":1},"files":{"/data/folder/with space/and unicode 😃/project/folder with unicode 😃/file name with \\"spaces\\" and unicode 😃.php":{"errors":1,"messages":[{"message":"Foo","line":4,"ignorable":true}]}},"errors":[]}',
+			$this->getOutputContent(),
+		);
+	}
+
+	public function testFormatErrorsNoErrors(): void
+	{
+		$formatter = new AgentDetectedErrorFormatter(new JsonErrorFormatter(false));
+
+		$exitCode = $formatter->formatErrors(
+			$this->getAnalysisResult(0, 0),
+			$this->getOutput(),
+		);
+
+		$this->assertSame(0, $exitCode);
+		$this->assertJsonStringEqualsJsonString(
+			'{"totals":{"errors":0,"file_errors":0},"files":{},"errors":[]}',
+			$this->getOutputContent(),
+		);
+	}
+
+}