Azure / Azure/bicep

Feature Request: Inlay Hints for reference type

Open
#15,048 4 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 21m
Merged PRs (30d)
79

Description

**Is your feature request related to a problem? Please describe.**
The language server should support [inlay hints](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_inlayHint) and emit inlay hints that indicate for a given reference, whether it comes from a param, var, or resource.

For example:

```bicep
param Test = 'ok'

var mytest = Test
```

should become when inlay hints are enabled:
```bicep
param Test = 'ok'

var mytest = param:Test
```
Where param will of course be rendered with alternate smaller gray font or whatnot by the editor.

Further, functions should emit inlay hints for their parameters where available.

Contributor guide

Open the contributing guide

Research direction

Start with the linked LSP 3.17 textDocument/inlayHint specification, then locate the Bicep language-server handling for references and functions. Done means references expose whether they are params, variables, or resources, and functions expose parameter hints where available, with behavior matching the examples; the issue names no files or tests.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.