{"id":20040,"date":"2023-07-10T13:00:44","date_gmt":"2023-07-10T21:00:44","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/powershell\/?p=20040"},"modified":"2023-08-28T14:48:57","modified_gmt":"2023-08-28T22:48:57","slug":"json-adapter-feedback-provider","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/powershell\/json-adapter-feedback-provider\/","title":{"rendered":"JSON Adapter Feedback Provider"},"content":{"rendered":"

JSON Adapter Feedback Provider Release<\/h2>\n

<\/i>Caution<\/strong><\/p>This blog post is outdated, please see the updated blog, PowerShell Adapter Feedback Provider Blog<\/a><\/div><\/p>\n

 <\/p>\n

We are excited to announce the first release of our JSON Adapter Feedback Provider! If you are\nunfamiliar with what feedback providers are, check out this blog describing them, here<\/a>.<\/p>\n

<\/i>Note<\/strong><\/p>Feedback Providers are an experimental feature of 7.4-preview2+ and so you will be required to use one of the 7.4 previews for JSON Adapters to work.<\/div><\/p>\n

Installing JSON Adapter Feedback Provider<\/h2>\n

First to get the latest PowerShell preview for this to work on you can download them on our GitHub release page here<\/a>.<\/p>\n

The release is available from the PowerShell Gallery<\/a>.<\/p>\n

Use the following command to install JsonAdapter<\/strong> using PowerShellGet<\/strong> v2.x:<\/p>\n

Install-Module -Name Microsoft.PowerShell.JsonAdapter -AllowPrerelease <\/code><\/pre>\n
If you are using PSResourceGet<\/strong>, you can use the following command:<\/p>\n
Install-PSResource -Name Microsoft.PowerShell.JsonAdapter -PreRelease<\/code><\/pre>\n
To use it you will need to import the module into your session via:<\/p>\n
Import-Module Microsoft.PowerShell.JsonAdapter<\/code><\/pre>\n
We encourage you to include the import message in your $PROFILE<\/code> so it can persistently be loaded\nin every PowerShell session you start. If you have Visual Studio Code installed, type\ncode $PROFILE<\/code> to edit your profile or use your choice of editor.<\/p>\n
What are JSON Adapters?<\/h2>\n
A JSON adapter is a script that can parse the text output of a native executable and convert it to\nPowerShell Object. JSON adapters can be made for\nany command, it is just required to use the exact name of the command as the prefix to the script.\nThe script will have to be named like so <name of command>-json.ps1<\/code> to be identified by the JSON\nadapter utility. This script’s file location must also be added to your $env:PATH<\/code> variable to be\nfound.<\/p>\n
Creating a JSON Adapter<\/h2>\n
For example, say you are on a Mac and want to use the command vm_stat<\/code> like a PowerShell object. If\nyou add the following to a file called vm_stat-json.ps1<\/code> and add the location of this file to your\n$env:PATH<\/code> variable, the JSON Adapter feedback provider will identify it as a possible suggestion\nfor vm_stat<\/code>.<\/p>\n
[CmdletBinding()]\r\nparam ( [Parameter(ValueFromPipeline=$true)][string]$inputObject )\r\nBEGIN {\r\n    $h = @{}\r\n}\r\n\r\nPROCESS {\r\n    if ( $inputObject -match \"^Mach Virtual\") {\r\n        if ($inputObject -match \"page size of (\\d+) \") {\r\n            $h['PageSize'] = [int]$matches[1]\r\n        }\r\n    }\r\n    else {\r\n        $k,$v = $inputObject -split \":\"\r\n        $AdjustedK = ($k -replace \"[ -]\",\"_\").trim() -replace '\"'\r\n        $AdjustedV = \"$v\".Trim() -replace \"\\.$\"\r\n        $h[$AdjustedK] = [int64]$AdjustedV\r\n    }\r\n}\r\n\r\nEND {\r\n    [pscustomobject]$h\r\n}<\/code><\/pre>\n
 <\/p>\n
This is what the experience looks like in the shell.<\/p>\n
\"VM<\/p>\n
JC<\/h2>\n
JC or JSON Converter, is a command line utility that can convert text to JSON for variety of command\nline tools. You can find instructions on how to install jc<\/code> and a full list of supported commands\non the repo of jc<\/a>. It can be a great tool to use to convert the outputs without writing a JSON\nAdapter yourself. The JSON Adapter<\/code> module supports using jc<\/code> as a JSON Adapter if the user has it\ninstalled. This means if you have the jc<\/code> utility installed and use a command that is supported by JC, the JSON\nAdapter feedback provider will suggest using JC piped to ConvertFrom-JSON<\/code>.<\/p>\n
It is important to note that not all jc supported utilities are supported. The list of supported commands is:<\/p>\n
\"arp\", \"cksum\", \"crontab\", \"date\", \"df\", \"dig\", \"dir\", \"du\", \"file\", \"finger\",\r\n\"free\", \"hash\", \"id\", \"ifconfig\", \"iostat\", \"jobs\", \"lsof\", \"mount\", \"mpstat\",\r\n\"netstat\", \"route\", \"stat\", \"sysctl\", \"traceroute\", \"uname\", \"uptime\", \"w\", \"wc\",\r\n\"who\", \"zipinfo\"<\/code><\/pre>\n
Additionally, you will need to use the appropriate parameters that jc requires to work properly. For\nexample, if you want to use jc<\/code> with uname<\/code>, you will need to use uname -a<\/code> as that is what jc<\/code>\nrequires to properly convert the output to JSON.<\/p>\n
Predictive IntelliSense Support<\/h2>\n
We have also added predictive IntelliSense support for the JSON Adapter feedback provider. This\nmeans after a JSON Adapter feedback provider is triggered, as you type the command name again,\nPredictive Intellisense will suggest the feedback command to you. This is a great way to easily try\nthe suggestion after a JSON Adapter feedback provider is triggered.<\/p>\n
\"screenshot<\/p>\n
Feedback<\/h2>\n
As this is our very first release, we know there may be issues that arise. We definitely look\nforward to your feedback and suggestions! You can provide feedback on the repo for this project\nhere<\/a>. Many things are subject to change as we are in early development of this. Give it a try!<\/p>\n
Jim Truher and Steven Bucher<\/p>\n
PowerShell Team<\/p>\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
This blog outlines a new feedback provider developed by the PowerShell Team to inform users of native executables that can output `JSON`.<\/p>\n","protected":false},"author":98569,"featured_media":13641,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[3189,248],"class_list":["post-20040","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell","tag-feedback-providers","tag-powershell"],"acf":[],"blog_post_summary":"
This blog outlines a new feedback provider developed by the PowerShell Team to inform users of native executables that can output `JSON`.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/20040","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/users\/98569"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/comments?post=20040"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/20040\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media\/13641"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media?parent=20040"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/categories?post=20040"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/tags?post=20040"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}