NOTICE

The extension is currently pending review for inclusion in Package Control.

In the meantime, you can install it locally:

First, install the LSP package from Package Control.

Clone the repository into your Sublime Text Packages directory:

# macOS
git clone https://github.com/laravel/sublime-extension.git "$HOME/Library/Application Support/Sublime Text/Packages/LSP-Laravel"

# Linux
git clone https://github.com/laravel/sublime-extension.git "$HOME/.config/sublime-text/Packages/LSP-Laravel"

# Windows
git clone https://github.com/laravel/sublime-extension.git "$env:APPDATA\Sublime Text\Packages\LSP-Laravel"

Then restart Sublime Text.

Introduction

The Laravel Sublime Text extension integrates the Laravel LSP server with Sublime Text, providing completions, hover information, diagnostics, links, and code actions for your PHP and Blade files.

LSP Documentation

Documentation for Laravel LSP can be found in the Laravel LSP repository.

Installation

Install the LSP package from Package Control, then search for “LSP-Laravel” and select Install.

For Blade files, also install the Laravel Blade package from Package Control.

Configuration

No configuration is required by default.

To pass initialization options directly to the Laravel LSP server, open Preferences → Package Settings → LSP → Servers → LSP-Laravel and configure initialization_options:

{
  "initialization_options": {
    "phpEnvironment": "sail"
  }
}

For the full list of available configuration options, see the Laravel LSP repository.

Updates

The extension checks for Laravel LSP updates at most once every two hours. To force an update check without waiting, run LSP-Laravel: Update Laravel LSP Server from the command palette.

Contributing

Thank you for considering contributing to the Laravel Sublime Text extension! The contribution guide can be found in the Laravel documentation.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

The Laravel Sublime Text extension is open-sourced software licensed under the MIT license.