Skip to content

Fix newline detection on descriptions #409

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
merged 2 commits into from
Apr 13, 2025
Merged

Fix newline detection on descriptions #409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2ad295
Enable running integration tests in pipelines
jaapio Apr 13, 2025
d1c6c03
Fix issue with tag description end detection.
jaapio Apr 13, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/workflows/integrate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,11 @@ jobs:
with:
composer-root-version: "5.x-dev"
upcoming-releases: true

integration-tests:
name: "Integration test"
uses: "phpDocumentor/.github/.github/workflows/continuous-integration.yml@v0.8"
with:
composer-root-version: "5.x-dev"
upcoming-releases: true
test-suite: "integration"
14 changes: 6 additions & 8 deletions src/DocBlock/Tags/Factory/AbstractPHPStanFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,13 @@ public function __construct(PHPStanFactory ...$factories)

public function create(string $tagLine, ?TypeContext $context = null): Tag
{
$tokens = $this->tokenizeLine($tagLine);
$tokens = $this->tokenizeLine($tagLine . "\n");
$ast = $this->parser->parseTag($tokens);
if (class_exists(ParserConfig::class) === false) {
if (property_exists($ast->value, 'description') === true) {
$ast->value->setAttribute(
'description',
$ast->value->description . $tokens->joinUntil(Lexer::TOKEN_END)
);
}
if (property_exists($ast->value, 'description') === true) {
$ast->value->setAttribute(
'description',
rtrim($ast->value->description . $tokens->joinUntil(Lexer::TOKEN_END), "\n")
);
}

if ($context === null) {
Expand Down