Azure / Azure/bicep

VSCode - Enhance "required properties" to generate code with param order

Open
#7,416 2 comments 2 reactions 0 assignees View on GitHub
enhancement good first issue
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 21m
Merged PRs (30d)
79

Description

I think it could be useful to have the parameters of a bicep file remember the order they are declared. This way when generating code with a feature like `required properties` it would preserve that order. I find myself constantly reorganizing.

In the example I would expect the module params to be in this order:

1. name
2. location
3. third
4. fourth

but instead results in:

1. fourth
2. location
3. name
4. third

![image](https://user-images.githubusercontent.com/700740/176587167-563e6e54-46f9-4f62-9f94-8c406fdbb51d.png)

```
Version: 1.68.1 (user setup)
Commit: 30d9c6cd9483b2cc586687151bcbcd635f373630
Date: 2022-06-14T12:48:58.283Z
Electron: 17.4.7
Chromium: 98.0.4758.141
Node.js: 16.13.0
V8: 9.8.177.13-electron.0
OS: Windows_NT x64 10.0.22000
Bicep CLI version 0.7.4 (5afc312467)
```

Contributor guide

Open the contributing guide

Research direction

Reproduce the VSCode "required properties" generation behavior with the example parameter declarations, then trace the required properties feature and how it orders module parameters. Done means generated parameters follow their declaration order: name, location, third, fourth, rather than the current order.

Written by the indexing model from the issue text.

Assessment

Tech stack
vscode
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.