Azure / Azure/bicep

[VS Code Extension] provides information about required properties and default values

Open
#4,323 1 comment 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.**
When editing a Bicep template with VS Code, I have no information about what properties are required, and what is the default value of property to see which ones could be omitted.

**Describe the solution you'd like**
When a property is hovered, for example like this:
![image](https://user-images.githubusercontent.com/593151/132358869-38c6b315-a3e5-4e11-856c-417a28739c81.png)

the information from the [azure templates docs](https://docs.microsoft.com/en-us/azure/templates/microsoft.documentdb/databaseaccounts?tabs=bicep) is displayed.
It would be very useful to also have here the information about whether the property is required and what is its default value.

Contributor guide

Open the contributing guide

Research direction

Start with the Bicep VS Code extension's existing property-hover behavior and compare its output with the linked Azure templates documentation. Trace where hover information is assembled and determine how required-property and default-value metadata is represented. Done means hovering a property shows those details when the documentation provides them.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, vscode
Domain
developer-experience, devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.