Skip to content

Update error message in UrlRUle to better handle URLs #159

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.

Sign up for GitHub

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
staabm merged 3 commits into from
Aug 27, 2025
Merged

Update error message in UrlRUle to better handle URLs #159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3be2361
Update error message in UrlRUle to better handle URLs
thePanz Aug 22, 2025
e4b6a16
Merge branch 'main' into patch-1
staabm Aug 27, 2025
e8420c8
Update TodoByIssueUrlRuleTest.php
staabm Aug 27, 2025
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
6 changes: 4 additions & 2 deletions src/TodoByIssueUrlRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,12 @@ public function processNode(Node $node, Scope $scope): array
continue;
}

// Adding a space after the {url} allows to have a proper clickable link, without the
// additional character at the end being part of the link's URL, which breaks GitHub links.
if ('' !== $todoText) {
$errorMessage = "Should have been resolved in {$url}: ". rtrim($todoText, '.') .'.';
$errorMessage = "Should have been resolved in {$url} : ". rtrim($todoText, '.') .'.';
} else {
$errorMessage = "Comment should have been resolved with {$url}.";
$errorMessage = "Comment should have been resolved with {$url} .";
}

$errors[] = $this->errorBuilder->buildError(
Expand Down
4 changes: 2 additions & 2 deletions tests/TodoByIssueUrlRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ public static function provideErrors(): iterable
yield [
[
[
'Should have been resolved in https://github.com/staabm/phpstan-todo-by/issues/47: we need todo something when this issue is resolved.',
'Should have been resolved in https://github.com/staabm/phpstan-todo-by/issues/47 : we need todo something when this issue is resolved.',
5,
],
[
'Comment should have been resolved with https://github.com/staabm/phpstan-todo-by/pull/155.',
'Comment should have been resolved with https://github.com/staabm/phpstan-todo-by/pull/155 .',
6,
],
],
Expand Down