Add documentation for skipping individual PSModule framework tests#252
Merged
MariusStorhaug merged 4 commits intomainfrom Jan 7, 2026
Merged
Add documentation for skipping individual PSModule framework tests#252MariusStorhaug merged 4 commits intomainfrom
MariusStorhaug merged 4 commits intomainfrom
Conversation
Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>
Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>
…s in example Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add documentation for skipping framework tests
Add documentation for skipping individual PSModule framework tests
Jan 7, 2026
MariusStorhaug
approved these changes
Jan 7, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for skipping individual PSModule framework tests on a per-file basis. Users can now add #SkipTest:<TestID>:<Reason> comments to skip specific tests when framework rules don't apply to particular files.
- New documentation section with syntax, complete test reference table, and examples
- Documents 10 SourceCode test IDs with descriptions and skip comment examples
- Includes best practices and links to broader configuration options
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Test-PSModule framework runs style and standards tests against source code (e.g., enforcing one function per file, requiring CmdletBinding attributes). Users needed guidance on skipping specific tests per-file when framework rules don't apply.
Changes
#SkipTest:<TestID>:<Reason>comment at file topAvailable Test IDs
NumberOfProcessors[System.Environment]::ProcessorCountnot$env:NUMBER_OF_PROCESSORSVerbose-Verboseto commands (overrides user preference)OutNull$null = ...not| Out-NullFunctionCountFunctionNameCmdletBinding[CmdletBinding()]ParamBlockparam()blockFunctionTestExample
Based on analysis of Test-PSModule framework tests.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.