feat: extend ALS with symbol navigation, references, rename, and workspace symbols by arikon · Pull Request #2647 · ansible/vscode-ansible

arikon · 2026-03-15T06:49:09Z

Summary

Extends the Ansible Language Server with comprehensive LSP navigation features built on a unified symbol infrastructure.

New LSP capabilities

Document Symbol — outline view and breadcrumbs for plays, tasks, blocks, roles, handlers
References — find all references for handlers (notify/name/listen), variables, file paths, roles
Rename — rename handlers with automatic notify/name/listen co-rename matrix
Workspace Symbol — fuzzy search across all open documents with caching
Symbol-based Hover — contextual hover info for handlers, variables, file paths, roles
Symbol-based Go to Definition — jump to handler definitions, variable declarations, included files, role directories

Infrastructure

ansibleSymbols.ts — unified symbol extraction engine supporting handlers, variables (vars, vars_prompt, vars_files, set_fact, register), file paths (include_tasks, template, copy), and roles
roleResolver.ts — role path resolution, argument_specs parsing, cross-file symbol search within role directories
ansibleConfig.ts — roles_paths support from ansible-config dump
Enhanced completion — dict-format vars support, role variable completion via roleResolver

Cleanup

Removed unused test fixtures (dynamic_inventory.py, new_ansible_config.cfg)
Added LSP support documentation

Wait-On: #2665

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Adds Document Symbol support to the Ansible Language Server, enabling outline view and breadcrumbs in editors. Supports plays, tasks, blocks, roles, and task sections (handlers, pre_tasks, post_tasks). Falls back to flat SymbolInformation when the client lacks hierarchical support. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

- Use node: protocol for fs and path imports in cli.ts - Extract collectPlayChildren to reduce cognitive complexity - Add tests for edge cases (nameless play/block, non-sequence YAML) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add tests for uncovered edge cases in documentSymbolProvider: - Task fallback to "Task" when no name or module is present - Play fallback to "Play" when hosts is absent - Role with "name" key instead of "role" key Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

- Fix null type cast in processRootSequence return type - Extract blockSectionKeys constant to eliminate regex duplication - Rename getKeyRange to getSelectionRange for accurate semantics - Add comment explaining single YAML document limitation Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

- Replace all `{} as any` with typed emptyDocsLibrary mock - Add null-case tests for non-symbol position and non-existent role Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

- Add tests for handler, variable, filePath, and role definitions - Add cross-file role definition tests - Add null-case tests for definition provider - Add dict-format vars completion test for Jinja2 brackets Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add unified symbol extraction (ansibleSymbols.ts) supporting handlers, variables, file paths, and roles across playbooks and role directories. Add role resolver (roleResolver.ts) for path resolution, argument_specs parsing, and cross-file symbol search. Extend ansibleConfig with roles_paths support. Include comprehensive test suites and fixtures. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Wire up onReferences, onRenameRequest, onPrepareRename, and onWorkspaceSymbol handlers in the language service. The rename provider handles handler notify/name/listen co-rename matrix. Workspace symbol provider supports fuzzy search with caching. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add symbol-based hover and go-to-definition for handlers, variables, file paths, and roles. Extend completion to support dict-format vars and role variables via roleResolver integration. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Remove dynamic_inventory.py and new_ansible_config.cfg from completion fixtures — no test references these files directly or indirectly. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Document implemented and planned LSP features including completions, hover, diagnostics, document symbols, references, rename, and workspace symbols. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…esolver Split ansibleSymbols.ts into focused modules (handlerSymbols, variableSymbols, moduleSymbols, symbolDefinitions). Export shared patterns from ansible.ts, add workspace symbol cache invalidation, fix nested /roles/ path resolution, and add escapeRegex utility. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…iders Pass rolesPaths from AnsibleConfig to definition, hover, references, rename, and workspace symbol providers so roles in DEFAULT_ROLES_PATH are resolved correctly. Also fix getRoleContextFromUri to check rolesPaths before /roles/ path fallback, supporting nested vendor roles. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Unblock the LSP event loop by replacing heavy synchronous fs operations (readFileSync, readdirSync) with their async equivalents from fs/promises. Light single-syscall ops (existsSync, statSync, lstatSync, mkdirSync) are intentionally kept synchronous. docsParser.ts is excluded (separate task). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

arikon requested review from a team as code owners March 15, 2026 06:49

Copilot AI review requested due to automatic review settings March 15, 2026 06:49

github-project-automation bot added this to 🧰 devtools project board Mar 15, 2026

Copilot AI reviewed Mar 15, 2026

View reviewed changes

arikon temporarily deployed to ack March 15, 2026 06:49 — with GitHub Actions Inactive

arikon temporarily deployed to ci March 15, 2026 06:49 — with GitHub Actions Inactive

arikon had a problem deploying to ci March 15, 2026 06:49 — with GitHub Actions Error

github-actions bot added the feat label Mar 15, 2026

arikon requested a review from Copilot March 15, 2026 06:51

Copilot AI reviewed Mar 15, 2026

View reviewed changes

arikon requested a review from Copilot March 15, 2026 06:51

Copilot AI reviewed Mar 15, 2026

View reviewed changes

arikon requested a review from Copilot March 15, 2026 06:52

Copilot AI reviewed Mar 15, 2026

View reviewed changes

arikon force-pushed the feat/als-document-symbol-provider branch from f5df827 to 6af7b6e Compare March 15, 2026 07:00

arikon had a problem deploying to ci March 15, 2026 07:00 — with GitHub Actions Error

arikon temporarily deployed to ci March 15, 2026 07:00 — with GitHub Actions Inactive

arikon temporarily deployed to ack March 15, 2026 12:35 — with GitHub Actions Inactive

github-actions bot added feat and removed feat labels Mar 15, 2026

arikon temporarily deployed to ci March 15, 2026 12:41 — with GitHub Actions Inactive

arikon temporarily deployed to ack March 15, 2026 12:42 — with GitHub Actions Inactive

github-actions bot added feat and removed feat labels Mar 15, 2026

arikon temporarily deployed to ack March 15, 2026 12:43 — with GitHub Actions Inactive

arikon temporarily deployed to ack March 17, 2026 11:55 — with GitHub Actions Inactive

github-actions bot added feat and removed feat labels Mar 17, 2026

arikon and others added 12 commits March 17, 2026 12:58

fix: address SonarCloud quality gate issues

8f5f103

- Use node: protocol for fs and path imports in cli.ts - Extract collectPlayChildren to reduce cognitive complexity - Add tests for edge cases (nameless play/block, non-sequence YAML) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

fix: format ternary expression per prettier rules

314ef8a

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

fix: replace untyped mocks and add null-case tests in hoverProvider

68e8992

- Replace all `{} as any` with typed emptyDocsLibrary mock - Add null-case tests for non-symbol position and non-existent role Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

chore: remove unused test fixtures

3174904

Remove dynamic_inventory.py and new_ansible_config.cfg from completion fixtures — no test references these files directly or indirectly. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

docs: add LSP support documentation for ALS

9683c1a

Document implemented and planned LSP features including completions, hover, diagnostics, document symbols, references, rename, and workspace symbols. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

arikon force-pushed the feat/als-document-symbol-provider branch from 1806fd8 to 9683c1a Compare March 17, 2026 12:09

arikon had a problem deploying to ci March 17, 2026 12:09 — with GitHub Actions Error

revert: restore dynamic_inventory.py and new_ansible_config.cfg fixtures

276d239

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

arikon temporarily deployed to ci March 17, 2026 12:12 — with GitHub Actions Inactive

arikon temporarily deployed to ack March 17, 2026 12:59 — with GitHub Actions Inactive

github-actions bot removed the feat label Mar 17, 2026

arikon and others added 3 commits March 17, 2026 15:40

Copilot AI reviewed Mar 19, 2026

View reviewed changes

Merge branch 'main' into feat/als-document-symbol-provider

618a9ff

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: extend ALS with symbol navigation, references, rename, and workspace symbols#2647

feat: extend ALS with symbol navigation, references, rename, and workspace symbols#2647
arikon wants to merge 17 commits intoansible:mainfrom
arikon:feat/als-document-symbol-provider

arikon commented Mar 15, 2026 •

edited by ssbarnea

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

arikon commented Mar 15, 2026 • edited by ssbarnea Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

New LSP capabilities

Infrastructure

Cleanup

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

arikon commented Mar 15, 2026 •

edited by ssbarnea

Loading