Azure / Azure/bicep

"View type definition" ability to show virtual window in-editor of `.bicep`-formatted types

Open
#11,739 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 2h
Merged PRs (30d)
79

Description

For resource types, we currently link to the public template documentation in a browser window. This has the following disadvantages:
- It doesn't take into account changes between Bicep versions (you're always looking at "latest" - this doesn't necessarily match what your editor sees.
- It breaks your flow somewhat
- It doesn't work with editor tooling, and detailed information is hidden
- It doesn't teach you how to use Bicep types.

Now that we have the ability to express types in Bicep, it would be great to bring up a generated `.bicep` file containing the "decompiled" type info.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the current “View type definition” behavior and the issue’s described ability to express types in Bicep. The work is done when resource types open as generated .bicep content in the editor, with information matching the editor’s Bicep version and usable by editor tooling.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.