[Code Proposal] Strongly Type Vale Prose Metrics

[michaeltlombardi]

Summary

As a maintainer of Documentarian.Vale, I want the output of the Get-ProseMetric function to be a defined type instead of simply a converted JSON blob so I can extend and munge the data for my users.

As a documentation author, I want the output of the Get-ProseMetric function to be a defined type so that I can use intellisense in the pipeline and default views in the console.

Details

The Documentarian.Vale module should have a new class, ValeProseMetrics that has the following properties:

• BlockQuotes
• Characters
• ComplexWords - The number of polysyllabic words without common suffiexes (es, ed, ing)
• Headings with the sub-properties H1 through H6
• ListCount - the number of ordered and unordered lists
• LongWords - the number of words with more than 6 characters
• Paragraphs
• PolysyllabicWords - The number of words with more than 2 syllables
• CodeSnippets - The number of inline and block code usages
• Sentences
• Syllables
• Words
• FileInfo