List all available properties in error message instead of grouping them as "and X others"

pulumi / pulumi-yaml

YAML language provider for Pulumi

Apache License 2.0

38 stars 11 forks source link

List all available properties in error message instead of grouping them as "and X others" #460

Open jamest-gaia opened 1 year ago

jamest-gaia commented 1 year ago

Hello!

Vote on this issue by adding a 👍 reaction
If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

When I'm developing something in AWS Crosswalk using YAML it would save me a bunch of time if I could see the available properties right in the error message. See screenshot

Affected area/feature

RobbieMcKinstry commented 1 year ago

Hi @jamest-gaia Thanks for opening this issue. I can see how that would improve your ability to address the error. I suppose the current approach is an attempt to limit the size of log lines for resources with a large number of arguments. I suppose its a trade-off between these two usability cases, but it's possible we haven't struck the perfect balance here.

aureq commented 1 year ago

@RobbieMcKinstry A few ideas for the improvement since there's no native YAML completion.

Could we consider using the --verbose flag so the full list of properties is displayed?
I think showing required vs optional properties would tremendously help. The required ones should always be displayed.
Required properties should be displayed differently than optional ones when the full list of properties is displayed.
If the list of properties is shortened, then we should try to be smart and guide the user to use --verbose to increase the properties visibility

jamest-gaia commented 1 year ago

Thanks @aureq , having --verbose (and being guided to use it) would be very satisfactory to me.

Also, a visual indication or grouping of required vs optional properties would also be very helpful.