adding generate params command by polatengin · Pull Request #6601 · Azure/bicep

polatengin · 2022-04-20T22:01:47Z

Fixes #512

Contributing a feature

I have opened a new issue for the proposal, or commented on an existing one, and ensured that the Bicep maintainers are good with the design of the feature being implemented
I have included "Fixes #{issue_number}" in the PR description, so GitHub can link to the issue and close it when the PR is merged

alex-frankel · 2022-04-25T00:59:14Z

Thanks for the contribution @polatengin!

Can you clarify the intended usage of the feature? I looked in the command bar in VS code and tried right-clicking on the file name, but didn't see anything in either location. Is this implemented in the CLI?

ucheNkadiCode · 2022-05-18T19:33:09Z

@shenglol and @anthony-c-martin when either of you have time.

From my understanding, the updates that were made were to make this command available in the Bicep CLI as well as the Command Pallete. Thank you!

Questions for @polatengin,

I also believe this overwrites a parameters file of the same name each time (e.g main.parameters.json) it is called correct Engin? Or does it update the file to append params that are not found and keeps all of the existing params?
Does this also implement telemetry so we can tell how often customers use this feature? Thank you!

src/vscode-bicep/src/extension.ts

polatengin · 2022-05-18T22:24:04Z

hey @ucheNkadiCode ,

You're right, GenerateParams implemented in both the CLI and the VSCode Extension (I also added required structures into the Language Server)

I also believe this overwrites a parameters file of the same name each time (e.g main.parameters.json) it is called correct Engin? Or does it update the file to append params that are not found and keeps all of the existing params?

Yes, it overwrites the parameters file, if there is already one. if this is not the expected behavior, I can change it.

Does this also implement telemetry so we can tell how often customers use this feature? Thank you!

I didn't implemented telemetry, let me check how can I do it.

src/Bicep.LangServer/Handlers/BicepGenerateParamsCommandHandler.cs

src/vscode-bicep/src/commands/generateParams.ts

…r.cs Co-authored-by: Stephen Weatherford (MSFT) <StephenWeatherford@users.noreply.github.com>

Co-authored-by: Stephen Weatherford (MSFT) <StephenWeatherford@users.noreply.github.com>

…r.cs Co-authored-by: Stephen Weatherford (MSFT) <StephenWeatherford@users.noreply.github.com>

src/vscode-bicep/src/commands/generateParams.ts

…ehavior, updating existing tests

anthony-c-martin · 2022-06-07T23:24:53Z

src/Bicep.LangServer/Handlers/BicepGenerateParamsCommandHandler.cs

+            }
+
+            var emitter = new TemplateEmitter(compilation.GetEntrypointSemanticModel(), emitterSettings);
+            using var fileStream = new FileStream(compiledFilePath, FileMode.OpenOrCreate, FileAccess.ReadWrite);


I don't think FileMode.OpenOrCreate is what you want here - it means you'll potentially only overwrite part of the file if you write fewer bytes than the size of the existing file.

For example, if I run the command to generate the file, add some newlines to pad it a bit, and run the command again, I get the following (note lines 28-30 left behind from the old file after the JSON ends):

…nature of emitparametersfile methods, updating tofile method signature accordingly

anthony-c-martin

Looks good, thanks for contributing!

polatengin and others added 14 commits April 20, 2022 14:11

adding generate-params sub-command

b53c0cb

adding parametersfilewriter into service collection

47db892

creating generate params file arguments structure

3e1f5dd

creating generate params file command handler

7051d05

adding generate-params command name

2960a08

formatting document

feb27c8

adding helper to create parameters file path and name

dda2f9e

adding emitter functions for the parameters file writer

28ff5ea

adding generate file sub-command arguments parser

798764f

formatting document

c14b0a8

adding parameters file writer

4fb6385

adding parameters file template writer

6641f4a

fixing access modifier

bddefba

Merge branch 'Azure:main' into enpolat/512-generate-params-command

105416d

polatengin mentioned this pull request Apr 22, 2022

Auto-generate parameter files #512

Closed

ucheNkadiCode mentioned this pull request May 17, 2022

Bicep deploy - additional params support #6159

Closed

polatengin added 8 commits May 18, 2022 18:01

adding language server constant for the generate params command handler

9cec396

adding command handler for generate params

98c6182

adding generate params command to the extension

7c44178

calling generateParams from language server when the command invoked

52b391d

adding generateparams to the command list

9f65b47

adding generateparams to the command list

c3ef431

adding generate params handler to the language server

8cf8698

updating naming schema for the parameters file

8c3a3d6

Merge branch 'main' into enpolat/512-generate-params-command

44c0ff7

shenglol reviewed May 18, 2022

View reviewed changes

src/vscode-bicep/src/extension.ts Show resolved Hide resolved

adding the missingimport

252f86d

StephenWeatherford reviewed Jun 6, 2022

View reviewed changes

src/Bicep.LangServer/Handlers/BicepGenerateParamsCommandHandler.cs Outdated Show resolved Hide resolved

StephenWeatherford reviewed Jun 6, 2022

View reviewed changes

src/Bicep.LangServer/Handlers/BicepGenerateParamsCommandHandler.cs Outdated Show resolved Hide resolved

StephenWeatherford reviewed Jun 6, 2022

View reviewed changes

src/vscode-bicep/src/commands/generateParams.ts Outdated Show resolved Hide resolved

polatengin and others added 10 commits June 6, 2022 14:44

Update src/Bicep.LangServer/Handlers/BicepGenerateParamsCommandHandle…

db73f32

…r.cs Co-authored-by: Stephen Weatherford (MSFT) <StephenWeatherford@users.noreply.github.com>

Update src/Bicep.LangServer/Handlers/BicepGenerateParamsCommandHandle…

cf7aac0

…r.cs Co-authored-by: Stephen Weatherford (MSFT) <StephenWeatherford@users.noreply.github.com>

Update src/Bicep.LangServer/Handlers/BicepGenerateParamsCommandHandle…

c9736ba

…r.cs Co-authored-by: Stephen Weatherford (MSFT) <StephenWeatherford@users.noreply.github.com>

Update src/vscode-bicep/src/commands/generateParams.ts

b904317

Co-authored-by: Stephen Weatherford (MSFT) <StephenWeatherford@users.noreply.github.com>

Update src/Bicep.LangServer/Handlers/BicepGenerateParamsCommandHandle…

7e9d96a

…r.cs Co-authored-by: Stephen Weatherford (MSFT) <StephenWeatherford@users.noreply.github.com>

removing unneeded imports, adding missing import

4033555

updating return message

2e08c4e

removing unneeded import

470b267

updating method name

da4235c

updating test sample file

5e0e5c9

StephenWeatherford reviewed Jun 7, 2022

View reviewed changes

src/vscode-bicep/src/commands/generateParams.ts Outdated Show resolved Hide resolved

StephenWeatherford reviewed Jun 7, 2022

View reviewed changes

src/vscode-bicep/src/commands/generateParams.ts Outdated Show resolved Hide resolved

polatengin added 6 commits June 7, 2022 04:08

updating logic, based on the suggestions from the github pr

d0fd254

ignoring params with default values, adding more tests to check the b…

d88a9b1

…ehavior, updating existing tests

Merge branch 'main' into enpolat/512-generate-params-command

fa26e1f

adding support for different param types

bae8c5d

fixing parameter types

c008917

changing the file open mode

581ed75

anthony-c-martin reviewed Jun 7, 2022

View reviewed changes

changing access mode of the existing parameter file, changing the sig…

7dcb162

…nature of emitparametersfile methods, updating tofile method signature accordingly

anthony-c-martin approved these changes Jun 8, 2022

View reviewed changes

anthony-c-martin enabled auto-merge (squash) June 8, 2022 12:55

anthony-c-martin disabled auto-merge June 8, 2022 12:55

anthony-c-martin merged commit c492c79 into Azure:main Jun 8, 2022

polatengin deleted the enpolat/512-generate-params-command branch June 14, 2022 00:20

PramodValavala-MSFT mentioned this pull request Jun 21, 2022

[ARM] Fix #22930: az bicep generate-params: Add support for bicep generate-params command Azure/azure-cli#22951

Merged

3 tasks

ChristopherGLewis mentioned this pull request Jul 1, 2022

The Generate Parameters command should work like the ARM one and offer a choice of both "required" and "all" parameters #7434

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding generate params command#6601

adding generate params command#6601
anthony-c-martin merged 77 commits intoAzure:mainfrom
polatengin:enpolat/512-generate-params-command

polatengin commented Apr 20, 2022

Uh oh!

alex-frankel commented Apr 25, 2022

Uh oh!

ucheNkadiCode commented May 18, 2022

Uh oh!

Uh oh!

polatengin commented May 18, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anthony-c-martin Jun 7, 2022 •

edited

Loading

Uh oh!

anthony-c-martin left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Conversation

polatengin commented Apr 20, 2022

Contributing a feature

Uh oh!

alex-frankel commented Apr 25, 2022

Uh oh!

ucheNkadiCode commented May 18, 2022

Uh oh!

Uh oh!

polatengin commented May 18, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anthony-c-martin Jun 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anthony-c-martin left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

anthony-c-martin Jun 7, 2022 •

edited

Loading