Skip to content

fix(framework): read one-line docblock vars in meta:view-component #2299

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

Open
dereuromark wants to merge 2 commits into
base: 3.x
Choose a base branch
from
+58 −6
Open

fix(framework): read one-line docblock vars in meta:view-component #2299

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
1020621
fix(framework): read one-line docblock vars in `meta:view-component`
dereuromark Sep 15, 2026
1324e72
fix(framework): tolerate CRLF when reading docblock var tags
dereuromark Sep 16, 2026
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
17 changes: 11 additions & 6 deletions src/Tempest/Framework/Commands/MetaViewComponentCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
use Tempest\Console\ConsoleCommand;
use Tempest\Console\HasConsole;
use Tempest\Support\Arr\ImmutableArray;
use Tempest\Support\Str\ImmutableString;
use Tempest\View\Slot;
use Tempest\View\ViewComponent;
use Tempest\View\ViewConfig;
Expand Down Expand Up @@ -81,11 +80,17 @@ private function resolveSlots(ViewComponent $viewComponent): ImmutableArray
private function resolveVariables(ViewComponent $viewComponent): ImmutableArray
{
return str($viewComponent->contents)
->matchAll('/^\s*\*\s*@var.*$/m')
->map(fn (array $matches) => str($matches[0]))
->map(fn (ImmutableString $line) => $line->replaceRegex('/^\s*\*\s*@var\s*/', ''))
->map(fn (ImmutableString $line) => $line->trim())
->map(fn (ImmutableString $line) => $line->explode(limit: 3))
->matchAll(
pattern: '/(?:^\s*\*|\/\*\*)[ \t]*@var[ \t]+(?<declaration>[^\r\n]*?)[ \t]*(?:\*\/(?:\s*(?<assignee>\$\w+)\s*=(?!=))?|\r?$)/m',
matches: ['declaration', 'assignee'],
)
->map(fn (array $matches) => [
'parts' => str($matches['declaration'])->explode(limit: 3),
'assignee' => $matches['assignee'] ?? null,
])
// A one-line `@var` right before an assignment types a local variable, not an attribute.
->filter(fn (array $match) => $match['assignee'] === null || $match['assignee'] !== ($match['parts'][1] ?? null))
->map(fn (array $match) => $match['parts'])
->mapWithKeys(
fn (ImmutableArray $parts) => yield $parts[1] => [
'type' => $parts[0],
Expand Down
47 changes: 47 additions & 0 deletions tests/Integration/Framework/Commands/MetaViewComponentCommandTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,51 @@ public function show_meta_for_view_component(): void
],
JSON);
}

#[Test]
public function show_variables_declared_in_one_line_docblock(): void
{
$this->console
->call('meta:view-component x-with-variable')
->assertSuccess()
->assertSee(<<<'JSON'
"variables": [
{
"type": "string",
"name": "$variable",
"attributeName": "variable",
"description": null
}
]
JSON);
}

#[Test]
public function show_description_of_one_line_docblock_variable(): void
{
$this->console
->call('meta:view-component x-submit')
->assertSuccess()
->assertSee(<<<'JSON'
"variables": [
{
"type": "null|string",
"name": "$label",
"attributeName": "label",
"description": "The submit button's label"
}
]
JSON);
}

#[Test]
public function ignore_one_line_docblock_typing_a_local_assignment(): void
{
$this->console
->call('meta:view-component x-input')
->assertSuccess()
->assertSee('"name": "$default",')
->assertNotSee('$formSession')
->assertNotSee('$validator');
}
}
Loading