Weave Code
The Laravel language server.
Frequently asked questions about Lsp
- How do I install and configure the Laravel Language Server in VS Code?
- Run `composer require laravel/lsp` in your Laravel project, then configure VS Code by adding this to your `settings.json`: `"php.validate.executablePath": "vendor/bin/laravel-lsp"` and set `"php.validate.run": "onType"` for real-time feedback. Ensure the PHP extension is enabled in VS Code.
- Does laravel/lsp support Laravel versions older than 11?
- No, the Laravel Language Server is designed for Laravel 11+ due to its reliance on modern PHP features like attributes and dependency injection. Legacy Laravel apps (10.x or below) may require manual adjustments or polyfills, though no official support is guaranteed.
- Can I run the LSP as a separate service instead of in-process with Laravel?
- Yes, you can host the LSP in a Docker container or remote server for better isolation, though this introduces network latency. Configure your editor’s LSP client to point to the remote endpoint (e.g., `http://localhost:3000` for a local Docker instance).
- Will the LSP slow down my development environment during heavy refactoring?
- The LSP may increase CPU/memory usage during real-time analysis, especially in large codebases. Mitigate this by offloading non-critical tasks to Laravel queues or pre-computing static analysis results (e.g., nightly builds). Caching with Redis can also help.
- How do I handle custom Laravel logic like annotations or macros that the LSP doesn’t recognize?
- The LSP may not natively support custom annotations, traits, or macros. Workarounds include extending the LSP with custom logic (if possible) or configuring your IDE to ignore unsupported elements. For complex cases, consider IDE-specific plugins or manual type hints.
- Is there a way to validate LSP results in CI/CD pipelines?
- Yes, you can integrate LSP checks into CI/CD by running the language server in a headless mode (e.g., via `vendor/bin/laravel-lsp validate`) and treating failures as build errors. This enforces type hints and code quality standards but adds overhead to your pipeline.
- What are the alternatives to laravel/lsp for PHP/Laravel IDE integration?
- Alternatives include the generic `php-language-server` (for broader PHP support) or IDE-specific tools like PHPStorm’s built-in PHP analysis. However, `laravel/lsp` is tailored for Laravel’s ecosystem, offering deeper integration with frameworks like Livewire, Blade, and Eloquent.
- How do I troubleshoot connection issues between my editor and the LSP?
- Start by checking the LSP logs (output in your terminal or editor’s LSP client). Common issues include incorrect executable paths, missing dependencies, or firewall blocking ports. For remote LSP, verify the endpoint URL and ensure the server is running. Restarting the LSP (`vendor/bin/laravel-lsp restart`) often resolves transient issues.
- Can I use laravel/lsp with Neovim or other non-VS Code editors?
- Yes, the LSP works with any editor supporting the Language Server Protocol, including Neovim (via `nvim-lspconfig`), Sublime Text (with plugins like LSP), or Emacs (with `lsp-mode`). Configure your editor’s LSP client to point to `vendor/bin/laravel-lsp` as the server executable.
- What’s the best way to manage memory usage if the LSP bloats my IDE?
- To reduce memory overhead, disable unnecessary LSP features (e.g., symbol indexing) in your editor settings or configure the LSP to run in a separate process. For large projects, pre-compute analysis results and cache them (e.g., using Redis) to avoid real-time heavy lifting.
Weaver
How can I help you explore Laravel packages today?