DSC should ship Reasons class

[ThomasNieto]

Prerequisites

• Write a descriptive title.
• Make sure you are able to repro it on the latest released version
• Search the existing issues.

Steps to reproduce

PSDSC should ship a Reasons class so each DSC resource module doesn't need to define it. It would also address the issue with Reasons type name conflict issues. Backstory: anypackage/dsc#12

Expected behavior

# DSC should ship `Reasons` type.

Actual behavior

# No Reasons type

Error details

No response

Environment data

7.2-preview 2

Version

2.0.6

Visuals

No response

[michaeltlombardi]

The long-term alternative to this (that I think is more idiomatic, because the implementation of Reasons inherently conflates Get and Test) is to add support for reporting how a DSC Resource is out-of-state via the Test method.

In the short-term, I've been updating the documentation¹² to recommend any module implementing Reasons use the module's name as a prefix in the class name.

Footnotes

1. https://learn.microsoft.com/powershell/dsc/concepts/class-based-resources#the-reasons-property ↩

2. https://learn.microsoft.com/powershell/dsc/tutorials/create-dsc-resource-machine-config#add-the-reasons-property ↩