Skip to content
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

[11.x] Fix withRouting docblock type #50563

Merged
merged 1 commit into from
Mar 14, 2024
Merged

Conversation

santigarcor
Copy link
Contributor

@santigarcor santigarcor commented Mar 14, 2024

The docblock type definition for the withRoute is accepting string|null for api prefix, but It should only accept string

    /**
     * Register the routing services for the application.
     *
     * @param  \Closure|null  $using
     * @param  string|null  $web
     * @param  string|null  $api
     * @param  string|null  $commands
     * @param  string|null  $channels
     * @param  string|null  $pages
     * @param  string|null  $apiPrefix <--- it should be string only
     * @param  callable|null  $then
     * @return $this
     */
    public function withRouting(?Closure $using = null,
        ?string $web = null,
        ?string $api = null,
        ?string $commands = null,
        ?string $channels = null,
        ?string $pages = null,
        ?string $health = null,
        string $apiPrefix = 'api',
        ?callable $then = null)

It leads VSCode to show this kind of error:

image

@santigarcor santigarcor changed the title Fix withRouting docblock type [11.x] Fix withRouting docblock type Mar 14, 2024
@nunomaduro nunomaduro merged commit 2af985e into laravel:11.x Mar 14, 2024
30 checks passed
@nunomaduro
Copy link
Member

Thanks!

@santigarcor santigarcor deleted the patch-1 branch March 14, 2024 18:33
tisnamuliarta referenced this pull request in tisnamuliarta/laravel-shadcn Mar 22, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [laravel/framework](https://laravel.com)
([source](https://togithub.com/laravel/framework)) | `11.0.5` ->
`11.0.8` |
[![age](https://developer.mend.io/api/mc/badges/age/packagist/laravel%2fframework/11.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/packagist/laravel%2fframework/11.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/packagist/laravel%2fframework/11.0.5/11.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/packagist/laravel%2fframework/11.0.5/11.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>laravel/framework (laravel/framework)</summary>

###
[`v11.0.8`](https://togithub.com/laravel/framework/compare/v11.0.7...v11.0.8)

[Compare
Source](https://togithub.com/laravel/framework/compare/v11.0.7...v11.0.8)

###
[`v11.0.7`](https://togithub.com/laravel/framework/blob/HEAD/CHANGELOG.md#v1107---2024-03-15)

[Compare
Source](https://togithub.com/laravel/framework/compare/v11.0.6...v11.0.7)

- \[11.x] Re-add translations for ValidationException by
[@&#8203;driesvints](https://togithub.com/driesvints) in
[https://github.com/laravel/framework/pull/50546](https://togithub.com/laravel/framework/pull/50546)
- \[11.x] Removes unused Dumpable trait by
[@&#8203;OussamaMater](https://togithub.com/OussamaMater) in
[https://github.com/laravel/framework/pull/50559](https://togithub.com/laravel/framework/pull/50559)
- \[11.x] Fix withRouting docblock type by
[@&#8203;santigarcor](https://togithub.com/santigarcor) in
[https://github.com/laravel/framework/pull/50563](https://togithub.com/laravel/framework/pull/50563)
- \[11.x] Fix docblock in FakeInvokedProcess.php by
[@&#8203;saMahmoudzadeh](https://togithub.com/saMahmoudzadeh) in
[https://github.com/laravel/framework/pull/50568](https://togithub.com/laravel/framework/pull/50568)
- \[11.x] fix: Add missing InvalidArgumentException import to
Database/Schema/SqlServerBuilder by
[@&#8203;ayutaya](https://togithub.com/ayutaya) in
[https://github.com/laravel/framework/pull/50573](https://togithub.com/laravel/framework/pull/50573)
- \[11.x] Improved translation for displaying the count of errors in the
validation message by
[@&#8203;andrey-helldar](https://togithub.com/andrey-helldar) in
[https://github.com/laravel/framework/pull/50560](https://togithub.com/laravel/framework/pull/50560)
- \[11.x] Fix retry_after to be an integer by
[@&#8203;driesvints](https://togithub.com/driesvints) in
[https://github.com/laravel/framework/pull/50580](https://togithub.com/laravel/framework/pull/50580)
- \[11.x] Use available `getPath()` instead of using `app_path()` to
detect if base controller exists by
[@&#8203;crynobone](https://togithub.com/crynobone) in
[https://github.com/laravel/framework/pull/50583](https://togithub.com/laravel/framework/pull/50583)
- \[11.x] Fix doc block: `[@return](https://togithub.com/return) static`
has been modified to `[@return](https://togithub.com/return) void` by
[@&#8203;saMahmoudzadeh](https://togithub.com/saMahmoudzadeh) in
[https://github.com/laravel/framework/pull/50592](https://togithub.com/laravel/framework/pull/50592)
- accept attributes for channels by
[@&#8203;taylorotwell](https://togithub.com/taylorotwell) in
laravel/framework@398f494

###
[`v11.0.6`](https://togithub.com/laravel/framework/blob/HEAD/CHANGELOG.md#v1106---2024-03-14)

[Compare
Source](https://togithub.com/laravel/framework/compare/v11.0.5...v11.0.6)

- \[11.x] Fix version constraints for illuminate/process by
[@&#8203;riesjart](https://togithub.com/riesjart) in
[https://github.com/laravel/framework/pull/50524](https://togithub.com/laravel/framework/pull/50524)
- \[11.x] Update Broadcasting Install Command With Bun Support by
[@&#8203;HDVinnie](https://togithub.com/HDVinnie) in
[https://github.com/laravel/framework/pull/50525](https://togithub.com/laravel/framework/pull/50525)
- \[11.x] Allows to comment `web` and `health` routes by
[@&#8203;nunomaduro](https://togithub.com/nunomaduro) in
[https://github.com/laravel/framework/pull/50533](https://togithub.com/laravel/framework/pull/50533)
- \[11.x] Add generics for Arr::first() by
[@&#8203;phh](https://togithub.com/phh) in
[https://github.com/laravel/framework/pull/50514](https://togithub.com/laravel/framework/pull/50514)
- Change default collation for MySQL by
[@&#8203;driesvints](https://togithub.com/driesvints) in
[https://github.com/laravel/framework/pull/50555](https://togithub.com/laravel/framework/pull/50555)
- \[11.x] Fixes install:broadcasting command by
[@&#8203;joedixon](https://togithub.com/joedixon) in
[https://github.com/laravel/framework/pull/50550](https://togithub.com/laravel/framework/pull/50550)
- \[11.x] Fix crash when configuration directory is non-existing by
[@&#8203;buismaarten](https://togithub.com/buismaarten) in
[https://github.com/laravel/framework/pull/50537](https://togithub.com/laravel/framework/pull/50537)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/tisnamuliarta/laravel-shadcn).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNDUuMCIsInVwZGF0ZWRJblZlciI6IjM3LjI2MS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants