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

Improve descriptions in configuration object #2279

Closed
fflaten opened this issue Dec 26, 2022 · 1 comment · Fixed by #2505
Closed

Improve descriptions in configuration object #2279

fflaten opened this issue Dec 26, 2022 · 1 comment · Fixed by #2505

Comments

@fflaten
Copy link
Collaborator

fflaten commented Dec 26, 2022

The configuration object should probably provide better descriptions than xyz configuration. It currently shows this:

New-PesterConfiguration

Run          : Run configuration.
Filter       : Filter configuration
CodeCoverage : CodeCoverage configuration.
TestResult   : TestResult configuration.
Should       : Should configuration.
Debug        : Debug configuration for Pester. ⚠ Use at your own risk!
Output       : Output configuration
TestDrive    : TestDrive configuration.
TestRegistry : TestRegistry configuration.

This is a missed opportunity to ex. quickly mention how Filters work (exclude/include priority, union behavior etc) or as a minimum link to website for more details.

Inspiration:

It creates a union of two filters so all the tests specified in $configuration.Filter.FullName will be launched as well as all the tests having $configuration.Filter.Tag tags.

If that's the strategy we expect from Pester, maybe we could mention this behavior it in the New-PesterConfiguration Filter documentation.

Originally posted by @tempora-mutantur in #2278 (comment)

Related pester/docs#242

@fflaten
Copy link
Collaborator Author

fflaten commented Dec 26, 2022

Filter RFC: #1442

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant