Skip to content

Fix broken link format detection #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions extension.neon
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ services:
relativePathHelper: '@simpleRelativePathHelper'
ciDetectedErrorFormatter: '@PHPStan\Command\ErrorFormatter\CiDetectedErrorFormatter'
editorUrl: '%editorUrl%'
environmentVariables: '%env%'
20 changes: 14 additions & 6 deletions src/TicketSwapErrorFormatter.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,31 +27,39 @@ final class TicketSwapErrorFormatter implements ErrorFormatter
private ErrorFormatter $ciDetectedErrorFormatter;
private ?string $editorUrl;

/**
* @param RelativePathHelper $relativePathHelper
* @param ErrorFormatter $ciDetectedErrorFormatter
* @param string|null $editorUrl
* @param array<string, mixed> $environmentVariables
*/
public function __construct(
RelativePathHelper $relativePathHelper,
ErrorFormatter $ciDetectedErrorFormatter,
?string $editorUrl = null
?string $editorUrl,
array $environmentVariables
) {
$this->relativePathHelper = $relativePathHelper;
$this->ciDetectedErrorFormatter = $ciDetectedErrorFormatter;
$this->editorUrl = $editorUrl;
$this->linkFormat = self::getLinkFormatFromEnv();
$this->linkFormat = self::getLinkFormatFromEnv($environmentVariables);
}

/**
* @param array<string, mixed> $environmentVariables
* @return self::LINK_FORMAT_*
*/
public static function getLinkFormatFromEnv() : string
public static function getLinkFormatFromEnv(array $environmentVariables) : string
{
if (getenv('GITHUB_ACTIONS') !== false) {
if (isset($environmentVariables['GITHUB_ACTIONS'])) {
return self::LINK_FORMAT_GITHUB_ACTIONS;
}

if (getenv('TERMINAL_EMULATOR') !== 'JetBrains-JediTerm') {
if (isset($environmentVariables['TERMINAL_EMULATOR']) && $environmentVariables['TERMINAL_EMULATOR'] === 'JetBrains-JediTerm') {
return self::LINK_FORMAT_PHPSTORM;
}

if (getenv('TERM_PROGRAM') !== 'WarpTerminal') {
if (isset($environmentVariables['TERM_PROGRAM']) && $environmentVariables['TERM_PROGRAM'] === 'WarpTerminal') {
return self::LINK_FORMAT_WARP;
}

Expand Down
41 changes: 40 additions & 1 deletion tests/TicketSwapErrorFormatterTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,46 @@ public function formatErrors(AnalysisResult $analysisResult, Output $output): in
return 0;
}
},
self::PHPSTOR_EDITOR_URL
self::PHPSTOR_EDITOR_URL,
[]
);
}

/**
* @return iterable<array{TicketSwapErrorFormatter::LINK_FORMAT_*, array<string, string>}>
*/
public static function provideLinkFormatFromEnv() : iterable
{
yield 'GitHub Actions' => [
TicketSwapErrorFormatter::LINK_FORMAT_GITHUB_ACTIONS,
['GITHUB_ACTIONS' => 'true'],
];
yield 'JetBrains' => [
TicketSwapErrorFormatter::LINK_FORMAT_PHPSTORM,
['TERMINAL_EMULATOR' => 'JetBrains-JediTerm'],
];
yield 'Warp' => [
TicketSwapErrorFormatter::LINK_FORMAT_WARP,
['TERM_PROGRAM' => 'WarpTerminal'],
];
yield 'Ghostty' => [
TicketSwapErrorFormatter::LINK_FORMAT_DEFAULT,
['TERM_PROGRAM' => 'ghostty'],
];
yield 'Default' => [
TicketSwapErrorFormatter::LINK_FORMAT_DEFAULT,
[],
];
}

/**
* @dataProvider provideLinkFormatFromEnv
*/
public function testGetLinkFormatFromEnv(string $expected, array $environmentVariables) : void
{
self::assertSame(
$expected,
TicketSwapErrorFormatter::getLinkFormatFromEnv($environmentVariables)
);
}

Expand Down