#Official Laravel VS Code Extension

Below you'll find a list of features as well as a roadmap with features we will be integrating soon.

Please Note:

• ›This extension will occasionally boot your app in the background to collect information about your app for use in autocompletion, linking, hovering, and diagnostics
• ›When you first install the extension it will download a small binary to your machine, we use this binary for PHP parsing
• ›This extension is intended to provide Laravel-specific intelligence, not general PHP intelligence. If you are currently using an extension for general PHP intelligence, it is recommended to continue using that in conjunction with this extension.

##Supported Versions

The extension supports all Laravel versions currently listed under the Support Policy and requires PHP >= 8.2 to run.

##Features

A non-exhaustive list of features covered in the extension:

###App Bindings

app('auth')
App::make('auth.driver')
app()->make('auth.driver')
App::bound('auth.driver')
App::isShared('auth.driver')
// etc

• ›Auto-completion
• ›Links directly to binding
• ›Warns when binding not found
• ›Hoverable

###Assets

asset('my-amazing-jpeg.png')

• ›Auto-completion
• ›Links directly to asset
• ›Warns when asset not found

###Blade

• ›Syntax highlighting

###Config

config('broadcasting.connections.reverb.app_id');
Config::get('broadcasting.connections.reverb.app_id');
Config::getMany([
    'broadcasting.connections.reverb.app_id',
    'broadcasting.connections.reverb.driver',
]);
config()->string('broadcasting.connections.reverb.app_id');
// etc

• ›Auto-completion
• ›Links directly to config value
• ›Warns when config not found
• ›Hoverable

###Eloquent

• ›Method auto-completion
• ›Field auto-completion (e.g. where methods, create/make/object creation)
• ›Relationship auto-completion (e.g. with method + with with array keys)
• ›Sub-query auto-completion ( with with array keys + value as closure)

###Env

env('REVERB_APP_ID');
Env::get('REVERB_APP_ID');

• ›Auto-completion
• ›Links directly to env value
• ›Warns when env not found, offers quick fixes:
  • ›Add to .env
  • ›Copy value from .env.example
• ›Hoverable

###Inertia

inertia('Pages/Dashboard');
Inertia::render('Pages/Dashboard');
Route::inertia('/dashboard', 'Pages/Dashboard');

• ›Auto-completion
• ›Links directly to JS view
• ›Warns when view not found, offers quick fixes:
  • ›Create view
• ›Hoverable

Note: If the extension is unable to find your Inertia views, ensure your inertia.pages.paths and/or inertia.pages.extensions config values are correct. Older projects may still use inertia.page_* or inertia.testing.page_*.

###Route

route('dashboard');
signedRoute('dashboard');
Redirect::route('dashboard');
Redirect::signedRoute('dashboard');
URL::route('dashboard');
URL::signedRoute('dashboard');
Route::middleware('auth');
redirect()->route('dashboard');
// etc

• ›Auto-completion
• ›Links directly to route definition
• ›Warns when route not found
• ›Hoverable

###Middleware

Route::middleware('auth');
Route::middleware(['auth', 'web']);
Route::withoutMiddleware('auth');
// etc

• ›Auto-completion
• ›Links directly to middleware handling
• ›Warns when middleware not found
• ›Hoverable

###Translation

trans('auth.failed');
__('auth.failed');
Lang::has('auth.failed');
Lang::get('auth.failed');
// etc

• ›Auto-completion
• ›Links directly to translation
• ›Warns when translation not found
• ›Hoverable
• ›Parameter auto-completion

###Validation

Validator::validate($input, ['name' => 'required']);
request()->validate(['name' => 'required']);
request()->sometimes(['name' => 'required']);
// etc

• ›Auto-completion for strings/arrays (not "|" just yet)

###View

view('dashboard');
Route::view('/', 'home');

• ›Auto-completion
• ›Links directly to Blade view
• ›Warns when view not found, offers quick fixes:
  • ›Create view
• ›Hoverable

##On the Roadmap

• ›Integration with VS Code test runner
• ›Livewire support
• ›Volt support
• ›Pint support
• ›Better autocompletion, linking, hovering, and diagnostics in Blade files

###LSP Availability

Our focus right now is to create the best VS Code experience for Laravel developers. While we're not ruling out the possibility of porting much of this functionality to an LSP in the future, it's not on the immediate roadmap.