PhpStorm - Unresolved function or method route()

[Jacobtims]

Ziggy version

1.0

Laravel version

9.19

Description

I've already have this problem for a while.
When I use route() in my Vue.js file, it is underlined. When I hover over it it says: Unresolved function or method route().

I'm using the @routes on my app.blade.php
How can I get rid of this underline?

Ziggy call and context

When I use PhpStorm.

Ziggy configuration

Object { url: "http://application.test", port: null, defaults: {}, routes: {…} }
​
defaults: Object {  }
​
port: null
​
routes: Object { "ignition.healthCheck": {…}, "ignition.executeSolution": {…}, "ignition.updateConfig": {…}, … }
​
url: "http://application.test"

Route definition

Route::get('/dashboard', function () {
    return Inertia::render('Dashboard');
})->middleware(['auth', 'verified'])->name('dashboard');

[bakerkretzmar]

I would guess this is because it thinks there is no route() function defined and doesn't know that it's defined globally, but I don't use PHPStorm so I'm not sure. Is there any way you can tell it to ignore that one function?

[warrickbayman]

Not sure if you still need this, but if you're using TypeScript, you can do something like this in a declaration file:

declare function route(name: string, params?: any): string;

If you have TypeScript configured, PHPStorm will pick up that declaration. Not sure if there's a better way.

[new-user-name]

I fell back to your solution. Don't know how to make route() visible in Laravel Nova user-defined components.

[CamKem]

It would be great if the creator of Ziggy (or another member of the community) could make a plugin for PhpStorm that gives declarative support for route() in Phpstorm so the program know that it is using a global route() function. @taylorotwell

[adelf]

Well, it's fixed only for js sources. Inside Vue templates - still warnings

[darakanoit]

i`m waiting functional on vue component :)

[adelf]

Everything looks good now. I'll try to release the next version in the next week.

[Jacobtims]

Thx! It works fine in the new update.

[CamKem]

Thanks heaps for this addition, it is so much cleaner in PhpStorm to have this function being picked up by thee IDE.
So worth the subscription for Laravel Idea! @adelf

[new-user-name]

Hi, thanks for your discussion. What have I to do exactly? I installed 1.6, added @routes to blade.
ts compiles OK, but PHPstorm still says "Unresolved function or method route()".

[CamKem]

You need to install the Laravel Idea plugin, it's a really great tool I highly recommend it.
It is paid, but totally worth it for how much it helps & also increases productivity.

[lucasdcrk]

For anyone reading later on, another solution is to create a route.js file in your utilites folder or similar, with the following content:

// utilities/route.js

import Router from 'ziggy-js/src/js/Router.js'

export function route(name, params, absolute, config) {
  const router = new Router(name, params, absolute, config);

  return name ? router.toString() : router;
}

Then import the method in your Vue components (auto imports will work), or use global properties

import { route } from '@/utilities/route.js'