-
Notifications
You must be signed in to change notification settings - Fork 75
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
Bump command reference and fix PowerShell casing #212
Conversation
We can fix those in source. Guessing it's mostly examples since they won't get formatted by VSCode to follow our |
Thanks, I would prefer not to touch the Pester repo to be honest so if you could.. awesome 💃 |
Pester is hands on the best test suite for my module 👍 I think all fixes have been resolved except for:
|
It think we should merge this, then take it from there. @fflaten you ok with that? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken indentation = new linebreaks in the middle of line. Ready to merge after.
SkipRun: Runs the discovery phase but skips run. | ||
Use it with PassThru to get object populated with all tests. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken indentation
Throw: Throw an exception when test run fails. | ||
When used together with Exit, throwing an exception is preferred. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken indentation
Exit: Exit with non-zero exit code when the test run fails. | ||
When used together with Throw, throwing an exception is preferred. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken indentation
Line: Filter by file and scriptblock start line, useful to run parsed tests programmatically to avoid problems with expanded names. | ||
Example: 'C:\tests\file1.Tests.ps1:37' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken indentation
FullName: Full name of test with -like wildcards, joined by dot. | ||
Example: '*.describe Get-Item.test1' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken indentation
ExcludeTests: Exclude tests from code coverage. | ||
This uses the TestFilter from general configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken indentation
OutputFormat: Format to use for test result report. | ||
Possible values: NUnitXml, NUnit2.5 or JUnitXml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken indentation
ErrorAction: Controls if Should throws on error. | ||
Use 'Stop' to throw on error, or 'Continue' to fail at the end of the test. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken indentation
WriteDebugMessagesFrom: Write Debug messages from a given source, WriteDebugMessages must be set to true for this to work. | ||
You can use like wildcards to get messages from multiple sources, as well as * to get everything. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken indentation
ReturnRawResultObject: Returns unfiltered result object, this is for development only. | ||
Do not rely on this object for additional properties, non-public properties will be renamed without previous notice. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken indentation
Yeah man, see this comment earlier #212 (comment). One of the two points I think we should just accept for now. |
Merging as discussed. Will release a new version of the Alt3 module the coming days so we can start (and start debugging) from this point. |
This fixes:
PowerShell
keyword in mdx front matter is coming from the-MetaKeywords
parameter used by thegenerate-command-reference.ps1
in this repo@fflaten:
Looks good to me💃