pester / Pester

Pester is the ubiquitous test and mock framework for PowerShell.
https://pester.dev/
Other
3.05k stars 469 forks source link

Improve descriptions for PesterConfiguration sections #2505

Closed fflaten closed 4 weeks ago

fflaten commented 1 month ago

PR Summary

Makes configuration section descriptions slightly more verbose to provide basic information.

Before:

PS > 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.

After:

PS > New-PesterConfiguration

Run          : General runtime options for Pester including tests containers to execute.
Filter       : Filter options to include/exclude tests and blocks in the targeted containers using tags, name or location. Include by default when no include filters are provided. Exclude filters take precedence.
CodeCoverage : Options to enable and configure Pester's code coverage feature.
TestResult   : Export options to output Pester's testresult to knwon file formats like NUnit and JUnit XML.
Should       : Options to control the behavior of the Pester's Should assertions.
Debug        : Debug configuration for Pester. ⚠ Use at your own risk!
Output       : Options to customize the console output generated by Pester.
TestDrive    : Options to configure the TestDrive feature.
TestRegistry : Options to configure the TestRegistry feature. TestRegistry is only available on Windows-systems.

Fix #2279 Related pester/docs#280 (comment)

PR Checklist