`route()` calls with missing required parameters have no IDE suggestions/completions on any parameters

[rrmesquita]

Ziggy version

2.4.2

Laravel version

none

Description

As the title says, when a route contains required parameters, intellisense is lost.

This is easily reproduceable within tests/js/route.test-d.ts, so there is no relevant information to put in the other fields of this issue.

Steps to reproduce

1. Open tests/js/route.test-d.ts

2. On line 25, remove the comment parameter and hit Ctrl/Cmd + Space to view suggested intellisense and assert it shows generic stuff instead of actual parameters.

3. On the posts.comments.show route declaration (line 11), make the post parameter optional by changing required to false .

4. Again on line 25, hit Ctrl/Cmd + Space again and assert it suggests the "correct" information about the route parameters.

[bakerkretzmar]

What editor/IDE is that?

[rrmesquita]

I used VS Code for that demonstration

edit: I attempted to use github.dev but I didn't know how to install dependencies, so I switched to VS Code

[stefanocurnis]

I does not work in PHPStorm too

[bakerkretzmar]

Weird. It seems like it's only the first required param, if I add another route with several required params as soon as I enter one of them the others are suggested. No clue what's going on here. This might be over my head in terms of the level of TypeScript going on but I'll keep thinking about it.

[rrmesquita]

@bakerkretzmar do you mind providing that example? I couldn't reproduce it.

[bakerkretzmar]

Sorry I didn't explain it very well and I wasn't exactly right. This only happens when there are missing required parameters—as soon as all the required parameters are entered, the other (optional) ones are suggested correctly.

With the existing posts.comments.show route in the test file, if you enter route('posts.comments.show', { post: 1 }) and then go to add another parameter and press ctrl+space, it suggests comment.

[aeruggiero]

Sorry I didn't explain it very well and I wasn't exactly right. This only happens when there are missing required parameters—as soon as all the required parameters are entered, the other (optional) ones are suggested correctly.

With the existing posts.comments.show route in the test file, if you enter route('posts.comments.show', { post: 1 }) and then go to add another parameter and press ctrl+space, it suggests comment.

You're completely right, but, at least for me, the issue occurs when there is a Default parameter value among the parameters. Although the url is correctly generated, typescripts screams for help, as it doesn't find the required parameter (fulfilled with the Default Parameter.

I haven't tested the following, but my code is basically identical, except is not locale but another default parameter:

Route::get('{locale}/posts/{post}', fn (Post $post) => /* ... */)->name('posts.show');
URL::defaults(['locale' => $request->user()->locale ?? 'de']);

route('posts.show', {post:3}); // 'https://ziggy.test/de/posts/3' 

The route('posts.show', {post:3}); will give error unless locale parameter is passed too

EDIT:
The trick, for this specific case, would be to put to false the required property of the Default Parameter in the ziggy.d.ts file

[1000Reasons]

I am experiencing this same issue with PHPStorm.

1. I have a route with an optional parameter. That route has autocomplete for params.
2. I have a route with multiple required parameters. No autocomplete for params.
3. I have a route with multiple required parameters. I enter one required parameter. Still no parameter autocompletion.

Ziggy (composer): 2.5.2
PHPStorm: 2024.3.3