platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

New cmdlet Test-Markdown

Open vors opened this issue 9 years ago • 5 comments
trafficstars

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?

vors avatar May 14 '16 06:05 vors

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 avatar May 14 '16 18:05 kilasuit

@kilasuit I was sure it's an approved verb, didn't check the list, thank you!

vors avatar May 14 '16 19:05 vors

@vors Is this not available yet for use?

sankethka avatar Jun 14 '16 19:06 sankethka

@sankethka no, I almost always close issues that have been implemented.

vors avatar Jun 14 '16 19:06 vors

The features I am working on this this iteration:

  1. Check that conversion from MD to MD object works
  2. Check that conversion from MD object to MAML object works
  3. Check that fields are not blank / no placeholder content exists.

jongeller avatar Jul 12 '16 17:07 jongeller

Microsoft.PowerShell.PlatyPS v1 contains two new cmdlets for testing.

  • Compare-CommandHelp
  • Test-MarkdownCommandHelp

More information will be available in the public release.

sdwheeler avatar May 31 '24 15:05 sdwheeler