microsoft/formatpowershelltomarkdowntable

Format PowerShell object to Markdown table

FormatMarkdownTable PowerShell Module

FormatMarkdownTable is a PowerShell module which contains Format-MarkdownTableListStyle cmdlet and Format-MarkdownTableTableStyle cmdlet.

Installing the FormatMarkdownTable PowerShell Module

The module is published on the PowerShell Gallery.

Install-Module FormatMarkdownTable

Example

Get-ChildItem c:\ | Format-MarkdownTableListStyle Name, LastWriteTime, Mode

This example returns a summary of the child items in C drive, and markdown text will be copied to the clipboard. Each property is displayed on a separate row.

Get-ChildItem c:\ | Format-MarkdownTableTableStyle Name, LastWriteTime, Mode

This example returns a summary of the child items in C drive, and markdown text will be copied to the clipboard. Each property is displayed on a separate col.

Alias

You can also refer to Format-MarkdownTableListStyle by its built-in alias, FML.

You can also refer to Format-MarkdownTableTableStyle by its built-in alias, FMT.

If FML and FMT are not recognized, try Import-Module FormatMarkdownTable once to load the module explicitly.

Switch

Get-ChildItem c:\ | fml Name, LastWriteTime, Mode -HideStandardOutput

HideStandardOutput indicates that the cmdlet hides the standard output.

Get-ChildItem c:\ | fml Name, LastWriteTime, Mode -HideStandardOutput -ShowMarkdown

ShowMarkdown indicates that the cmdlet outputs the markdown text to the console.

Get-ChildItem c:\ | fml Name, LastWriteTime, Mode -HideStandardOutput -ShowMarkdown -DoNotCopyToClipboard

DoNotCopyToClipboard indicates the the cmdlet does not copy the markdown text to the clipboard.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

formatpowershelltomarkdowntable's Issues

Formatting table with all properties loses original property order

Formatting table with all properties loses original property order. This is because here all ("*") properties are enumerated using get-member, which does not preserve order.

Example:

$data=@([pscustomobject]@{X=1;Z=2;Y=3},[pscustomobject]@{X=4;Z=5;Y=6},[pscustomobject]@{X=7;Z=8;Y=9})
# format table shows in original order of first instance properties
$data|format-table
# format markdown table uses property alphabetical order
$data|format-markdowntabletablestyle -showmarkdown -hidestandardoutput -donotcopytoclipboard
# this is because the implementation is doing get-member * which is not order preserving
$data[0]|get-member -name @('*') -membertype property,noteproperty
# psobject.properties.name is order preserving
$data[0].psobject.properties.name

Install failing

Can't install:

incorrect output on Get-Command?

PS >powershell -c Get-Command -Module Microsoft.PowerShell.Management New-EventLog | Format-MarkdownTableListStyle CommandType, Name, Version, Source

actual output

powershell -c Get-Command -Module Microsoft.PowerShell.Management New-EventLog | Format-MarkdownTableListStyle CommandType, Name, Version, Source

CommandType Name Version Source
----------- ---- ------- ------
Cmdlet New-EventLog 3.1.0.0 Microsoft.PowerShell.Management

---

maybe I need the first command to output an object & then this tool will work? 🤔