platyPS
platyPS copied to clipboard
New cmdlet Test-Markdown
Scenarios:
- Verify that markdown is compliant with schema
- Verify / report that all text fields are filled (i.e. NOTES, description placeholders)
Scenarios to consider:
- Verify markdown metadata keys. It's needed for a large scale pipelines, i.e. if MS adopts platyPS. Maybe create a Test-MarkdownMetadata instead?
Surely the verb should be Test?
I've yet to see Verify being used and it isn't listed on https://msdn.microsoft.com/en-us/library/ms714428(v=vs.85).aspx either
@kilasuit I was sure it's an approved verb, didn't check the list, thank you!
@vors Is this not available yet for use?
@sankethka no, I almost always close issues that have been implemented.
The features I am working on this this iteration:
- Check that conversion from MD to MD object works
- Check that conversion from MD object to MAML object works
- Check that fields are not blank / no placeholder content exists.
Microsoft.PowerShell.PlatyPS v1 contains two new cmdlets for testing.
- Compare-CommandHelp
- Test-MarkdownCommandHelp
More information will be available in the public release.