Skip to content

index.rst

Latest commit

 

History

History
179 lines (132 loc) · 6.55 KB

index.rst

File metadata and controls

179 lines (132 loc) · 6.55 KB
Raw

Symfony Language Tools Documentation

Symfony Language Tools brings Symfony-specific features to your editor: completion, hover, navigation, references, rename and diagnostics for routes, services, templates, translations and more. It implements the Language Server Protocol, so its Symfony features are independent of any particular editor, and it runs alongside a general PHP language server instead of replacing it.

Setting Up Your Client

Symfony Language Tools officially supports the following clients. Use the corresponding page for installation, configuration and troubleshooting:

  • VS Code: install the Symfony Language Tools extension from the Visual Studio Marketplace. It bundles the language server, so no separate download is needed;
  • Neovim: install the server with Mason or from a standalone release, then enable it through nvim-lspconfig;
  • Zed: install the extension to download and run the server automatically on Linux and macOS;
  • OpenCode: install the standalone server, then configure it as a custom language server for Symfony-aware diagnostics and navigation.

Any other editor with a Language Server Protocol client can run the standalone server: see installing a release below and configure your client to start symfony-lsp.

Project Configuration

Use .symfony-lsp.json to share project settings between editors and the command-line checker. See project configuration for all options and multi-project examples.

Features

Symfony Language Tools understands routing, dependency injection, Twig templates, translations, environment variables, bundle configuration, Console commands, Messenger, events, security, form and validation metadata, AssetMapper, Stimulus and Doctrine. Each integration page documents its supported declarations, references and editor features. See the supported integrations for the complete feature matrix.

Tested with Real Applications

Symfony Language Tools is continuously tested with real open-source projects across supported Symfony versions:

These applications cover conventional and legacy layouts, large codebases, bundle ecosystems and different Symfony features.

Requirements

The language server supports the maintained Symfony versions listed in Symfony's release metadata. Your application must have its Composer dependencies installed and provide a PHP command compatible with its Symfony version. The PHP command doesn't have to run on your machine: applications that run in a container are officially supported through Docker support.

Installing a Standalone Release

The VS Code extension bundles the language server, and the Zed extension downloads it automatically. For a manual installation or a custom binary, download the archive for your platform from the GitHub release:

  • linux-x64 or linux-arm64;
  • macos-x64 or macos-arm64;
  • windows-x64.

Extract the archive to get the self-contained symfony-lsp executable. On Windows, it has an .exe suffix.

The release also contains SHA256SUMS. Verify the archive checksum before running it.

Verify the Unix executable before configuring an editor:

$ ./symfony-lsp --version

The macOS binaries aren't signed or notarized. If macOS quarantines an archive downloaded from the release, remove the quarantine attribute from the extracted directory after verifying where the archive came from:

$ xattr -dr com.apple.quarantine /path/to/symfony-lsp-vX.Y.Z-macos-arm64

Run ./symfony-lsp without arguments to start the Language Server Protocol connection over standard input and standard output. Pass --socket=<port> to connect to a client listening on that local port instead. On Windows, the bundled runtime cannot serve the protocol over standard input and output, so clients must use the socket transport there; the bundled VS Code extension does this automatically.

The server raises PHP's memory_limit to 2G when the configured limit is lower. Set the SYMFONY_LSP_MEMORY_LIMIT environment variable to override the limit with any PHP memory limit value, such as 512M, 4G or -1 for no limit.

Running Diagnostics Without an Editor

Use the same executable to check saved Symfony project files in local automation or CI:

$ ./symfony-lsp check

The command can produce human, JSON, GitHub Actions, GitLab Code Quality and SARIF reports, select blocking diagnostic codes and maintain an occurrence-specific baseline. Runtime analysis executes application code; pass --source-only when it must remain disabled. See Running Diagnostics Without an Editor for configuration, output, baseline and exit-status details.

Upgrading

Download the new archive for the same platform, stop the editor client and replace the executable. Verify the installed version, then restart or reload the editor:

$ ./symfony-lsp --version

The first workspace initialization after an upgrade rebuilds the project index.

Installing the Server from Source

Source installations require PHP 8.4.1 or later and Composer 2. Clone this repository outside the Symfony application that you want to edit. Install the server dependencies and build the native parser extension:

$ composer install
$ composer tree-sitter:build

The development executable is bin/symfony-lsp. On Unix, no additional PHP extension configuration is required. Verify that it starts:

$ ./bin/symfony-lsp --version