From 1d235d0f8b04592adf31be5ad0d2cc6992102338 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 31 Jul 2026 16:38:07 +0000 Subject: [PATCH] docs(editor-setup): document LSP diagnostics and driver docs on hover heph#296 added missing-required-field diagnostics for target()/ provider_state() calls and driver config-field docs on hover once a target's driver is resolved. Document both in the editor setup guide. Refs hephbuild/heph@85b556b34b37287d12613a5a7d2963a7edd7f5d1 (#296) Co-Authored-By: Claude Sonnet 5 Claude-Session: https://claude.ai/code/session_01JT52j7Xj26SsQAkreF4tFd --- website/docs/guides/editor-setup.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/website/docs/guides/editor-setup.md b/website/docs/guides/editor-setup.md index 9666ef5..c45af4f 100644 --- a/website/docs/guides/editor-setup.md +++ b/website/docs/guides/editor-setup.md @@ -1,21 +1,22 @@ --- title: "Editor setup" sidebar_position: 6 -description: Connect your editor to heph's language server for completion, hover, go-to-definition, and formatting. +description: Connect your editor to heph's language server for diagnostics, completion, hover, go-to-definition, and formatting. --- # Editor setup heph ships a language server that connects to any editor supporting the Language -Server Protocol. It provides completion, hover documentation, go-to-definition, -and document formatting. +Server Protocol. It provides diagnostics, completion, hover documentation, +go-to-definition, and document formatting. ## What it provides | Feature | What you get | |---------|-------------| +| Diagnostics | Flags a `target()` or `provider_state()` call that's missing a required field — a base field like `name`, or, once `driver`/`provider` is set, a field required by that driver or provider. | | Completion | `target`, `file`, `glob`, `struct`, `provider_state`, `heph.core.*`, and every provider function complete with their signatures and inline docs. Address strings (`//pkg:name`) complete packages and target names as you type. Inside a `target(driver="exec", …)` call, the driver's accepted fields complete with types and descriptions. | -| Hover | Signature and documentation for any builtin or provider function. Hover a `target()` call to see the addresses it produced. | +| Hover | Signature and documentation for any builtin or provider function. Hover a `target()` call to see the addresses it produced and, once its `driver` is set, that driver's config fields with their types and descriptions. | | Go-to-definition | Jump to the BUILD file that defines an address — both `//pkg:name` and relative `:name` forms. | | Formatting | Format-on-save rewrites the open BUILD file to canonical style. Uses the same rules as [`heph tool build-fmt`](/docs/guides/formatting-build-files), respecting the workspace `indent` setting and the `# heph:fmt skip-file` directive. |