chocolatey / chocolatey/choco

Extend ValidationResult class to include additional metadata

Open
#3,810 1 comment 1 reaction 1 assignee Claimed by @AdmiringWorm View on GitHub
1 - Ready Enhancement NO RELEASE NOTES
Dominant language
C#
Stars
11.5k
Forks
960
PR merge metrics
No merged PRs in 30d

Description

### Checklist

- [x] I have verified this is the correct repository for opening this issue.
- [x] I have verified no other issues exist related to my request.

### Is Your Feature Request Related To A Problem? Please describe.

Currently when we are implementating global validations in CLI or other related products, we need to specify the exact formatting that we want the CLI to output, instead of relying on setting specific metadata properties and let CLI decide on how things are outputted.

### Describe The Solution. Why is it needed?

To allow more easily specify the necessary information, without having to think of how items are formatted we should introduce additional metadata elements on the ValidationResult class, such as HelpUri/ReferencUri, Action Message, Title (Optional) and maybe even existing Message by an array of strings (or similar). We can then more easily change how CLI is outputting items in the future without having to make changes to existing Validators in CLI or other projects.

### Additional Context

_No response_

### Related Issues

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.