Add experimental LSP server for bundle files#4714
Draft
shreyas-goenka wants to merge 9 commits intomainfrom
Draft
Add experimental LSP server for bundle files#4714shreyas-goenka wants to merge 9 commits intomainfrom
shreyas-goenka wants to merge 9 commits intomainfrom
Conversation
shreyas-goenka
added a commit
to databricks/databricks-vscode
that referenced
this pull request
Mar 12, 2026
Introduces a BundleLSPClient that spawns `databricks bundle lsp` via stdio to provide deployment-aware features for bundle YAML files: - Document links: Ctrl+click on resource keys to open in workspace - Hover: Shows resource ID, name, and workspace link The client connects to the CLI's new hidden LSP server and activates for all bundle YAML files (databricks.yml, databricks.yaml, etc.). Stacks with the existing Red Hat YAML extension. Depends on: databricks/cli#4714 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
3 tasks
Collaborator
|
Commit: a27b67f
11 interesting tests: 9 SKIP, 2 RECOVERED
Top 4 slowest tests (at least 2 minutes):
|
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
Collaborator
|
Commit: 411026e
17 interesting tests: 10 SKIP, 7 RECOVERED
Top 20 slowest tests (at least 2 minutes):
|
Contributor
|
this is so cool !!! |
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
Two proposals:
1. Replace regex-based ${...} parsing with a proper two-mode character scanner
2. Add "did you mean?" suggestions for invalid variable references
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Introduces a hidden `databricks bundle lsp` command that starts a Language Server Protocol server for bundle YAML files. The server provides: - Document links: Ctrl+click on resource keys to open them in the Databricks workspace browser - Hover: Shows resource ID, name, and a link to open in Databricks when hovering over resource keys The server reads deployment state from local state files (both direct engine and Terraform) to resolve resource IDs and construct workspace URLs without requiring authentication. Uses github.com/creachadair/jrpc2 for JSON-RPC 2.0 transport (same library used by terraform-ls). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Ctrl+click on ${...} references navigates to where the path is defined
- Ctrl+click on resource keys shows all interpolation references (peek view)
- Hover on resource keys shows URLs for all targets (up to 10)
- Merged tree loading supports include file resolution
- var.X shorthand resolves to variables.X definitions
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Use PathToURI() instead of "file://" + path for cross-platform URI construction - Replace platform-specific TestURIToPath with TestURIToPathRoundTrip - Fix gofmt alignment in handler map declarations Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The command is now at `databricks experimental bundle-lsp` instead of `databricks bundle lsp`. This better reflects its experimental status. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add interpolation autocomplete with var shorthand, sequence expansion,
and computed keys (bundle.target, workspace.current_user.*, etc.)
- Add diagnostic publishing for unresolvable ${...} references
- Fix race condition: add sync.RWMutex to Server for concurrent access
- Fix buildDisplayPath leading-dot bug for ${var} without trailing dot
- Extract duplicate URL-building into populateResourceURLs helper
- Change handleDefinition return type from any to []LSPLocation
- Remove terraform state support (direct engine only)
- Remove redundant file watcher patterns
Co-authored-by: Isaac
Use jrpc2.Notify() instead of jrpc2.Callback() for LSP notifications like textDocument/publishDiagnostics. Callback sends a request and blocks waiting for a response, but LSP notifications are fire-and-forget. This caused the server to hang after sending the first diagnostics notification. Also run registerFileWatchers in a goroutine since its Callback blocks waiting for the client response. Co-authored-by: Isaac
- Fix exhaustive switch for dyn.Kind in classifyValue - Fix gofmt formatting in protocol.go and server.go - Fix testifylint: use assert.Positive - Fix isComputedPath false positive (bundle.targets matching bundle.target) - Add missing computed keys (workspace.root_path, bundle.git.branch, etc.) - Add exit notification handler per LSP spec - Sync integration test handler map with server handler map - Fix contradictory hover text when resource has ID but no URL - Remove unused diagnostic severity constants Co-authored-by: Isaac
- Remove os.Exit from handleExit; use jrpcServer.Stop() instead - Move all file I/O out of the lock in loadBundleInfo; hold lock only to swap the new state - Export InterpolationRegexp from dynvar and use it in LSP instead of duplicating the regex - Unify computedPrefixes and computedKeys into a single source of truth (computedKeys in completion.go, used by diagnostics.go) - Use bytes.NewReader instead of strings.NewReader(string(data)) - Convert loadMergedTree/loadAllTargetState to standalone functions - Remove design docs from PR Co-authored-by: Isaac
shreyas-goenka
force-pushed
the
cli-dabs-lsp
branch
from
411026e to
d8e361f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an experimental LSP server for Databricks Asset Bundle (DABs) YAML files, invoked via
databricks experimental bundle-lsp.Features:
${...}interpolation paths including sequence indices (tasks[0]),varshorthand, and computed keys (bundle.target,workspace.current_user.*,bundle.git.*,workspace.root_path, etc.)${...}references to their definitions in the merged config tree, and from resource keys to all interpolation references${...}references (typos, missing keys)Technical details:
creachadair/jrpc2for JSON-RPC over stdiosync.RWMutex(file I/O performed outside the lock)dyn.Valuetree anddynvar.InterpolationRegexpfrom the existing bundle systemjrpc2.Notify()(notCallback()which blocks)This pull request was AI-assisted by Isaac.