Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the way to parse the example #22178

Merged
merged 5 commits into from
Jun 27, 2023
Merged

Conversation

kceiw
Copy link
Contributor

@kceiw kceiw commented Jun 26, 2023

Description

When we receive the examples from the service, we need to parse them to understand the command names and parameter names etc. It wasn't properly able to parse the examples with complex syntax, for example, the example with "()" or "{}" in them.

The fix is to use a different api to get the CommandAst from the text. That can better parse the examples.

Checklist

  • SHOULD select appropriate branch. Cmdlets from Autorest.PowerShell should go to generation branch.
  • SHOULD make the title of PR clear and informative, and in the present imperative tense.
  • SHOULD update ChangeLog.md file(s) appropriately
    • For any service, the ChangeLog.md file can be found at src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
    • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense. Add changelog in description section if PR goes into generation branch.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD have approved design review for the changes in this repository (Microsoft internal only) with following situations
    • Create new module from scratch
    • Create new resource types which are not easy to conform to Azure PowerShell Design Guidelines
    • Create new resource type which name doesn't use module name as prefix
    • Have design question before implementation
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT introduce breaking changes in Az minor release except preview version.
  • SHOULD NOT adjust version of module manually in pull request

- The existing way of using Parser.ParseInput doesn't create the CommandAst accurately especially
when the input include `@{}`. So we change to use PredictionContext that is also used by PSReadLine.
@azure-client-tools-bot-prd
Copy link

azure-client-tools-bot-prd bot commented Jun 26, 2023

️✔️Az.Accounts
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows

@vidai-msft vidai-msft merged commit 22502d8 into Azure:main Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants