Editor support

sphp lsp is a language server for .sphp (and .php) files. It finds the project from the sphp.toml in the workspace folder, or uses the defaults.

It provides:

• diagnostics for every project file, updated as you type
• hover with types (narrowed by smart casts), signatures and doc comments
• go to definition and type definition, into the stdlib and PHP's stubs too
• find references, highlights and rename (which keeps $ where it belongs)
• completion of members after ->/:: (extension functions included), locals, functions, classes and keywords
• signature help and inlay type hints for val/var and lambda parameters
• semantic highlighting: immutable bindings are readonly, mutable ones have a mutable modifier, so a theme can tell them apart
• document and workspace symbols, folding and selection ranges

VS Code

The extension registers .sphp files, highlights them and starts sphp lsp. Until it is on the Marketplace, download stirphp-vscode-<version>.vsix from a release and install it:

code --install-extension stirphp-vscode-0.1.1.vsix

Its source is in editors/vscode of the core repository.

The extension downloads sphp by itself: on first start it fetches the build for your platform from the releases (verified against SHA256SUMS), and every few hours it installs newer builds, offering to restart the server. Set sphp.server.path to use your own sphp instead.

Setting	Default
sphp.server.path	(empty)	The sphp to run instead of the downloaded one
sphp.server.channel	stable	Download releases, or nightly builds
sphp.server.autoUpdate	true	Install newer builds of the channel
sphp.php.enable	false	Also serve .php files
sphp.trace.server	off	Log LSP traffic

StirPHP: Check for Updates checks at any time.

Neovim

Neovim 0.11 or later:

vim.filetype.add({ extension = { sphp = 'sphp' } })
vim.lsp.config('sphp', {
  cmd = { 'sphp', 'lsp' },
  filetypes = { 'sphp', 'php' },
  root_markers = { 'sphp.toml', '.git' },
})
vim.lsp.enable('sphp')

Helix

In languages.toml:

[language-server.sphp]
command = "sphp"
args = ["lsp"]

[[language]]
name = "sphp"
scope = "source.sphp"
file-types = ["sphp"]
roots = ["sphp.toml"]
language-servers = ["sphp"]

Other editors

Any editor with LSP support works the same way: run sphp lsp for .sphp files, with the project directory as the workspace root.