JsonPeek 1.0.2

There is a newer version of this package available.
See the version list below for details. 
dotnet add package JsonPeek --version 1.0.2
                    


                    

                
NuGet\Install-Package JsonPeek -Version 1.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="JsonPeek" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="JsonPeek" Version="1.0.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="JsonPeek" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add JsonPeek --version 1.0.2
                    


                    

                
#r "nuget: JsonPeek, 1.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=JsonPeek&version=1.0.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=JsonPeek&version=1.0.2
                    


                            Install as a Cake Tool

Version Downloads License Build

Usage:

  <JsonPeek ContentPath="[JSON_FILE]" Query="[JSONPath]">
    <Output TaskParameter="Result" PropertyName="Value" />
  </JsonPeek>
  <JsonPeek Content="[JSON]" Query="[JSONPath]">
    <Output TaskParameter="Result" ItemName="Values" />
  </JsonPeek>

You can either provide the path to a JSON file via ContentPath or provide the straight JSON content to Content. The Query is a JSONPath expression that is evaluated and returned via the Result task parameter. You can assign the resulting value to either a property (i.e. for a single value) or an item name (i.e. for multiple results).

JSON object properties are automatically projected as item metadata when assigning the resulting value to an item. For example, given the following JSON:

{
  "http": {
    "host": "localhost",
    "port": 80,
    "ssl": true
  }
}

You can read the entire http value as an item with each property as a metadata value with:

<JsonPeek ContentPath="host.json" Query="$.http">
  <Output TaskParameter="Result" ItemName="Http" />
</JsonPeek>

The Http item will have the following values (if it were declared in MSBuild):

<ItemGroup>
  <Http Include="[item raw json]">
    <host>localhost</host>
    <port>80</port>
    <ssl>true</ssl>
  </Http>
</ItemGroup>

These item metadata values could be read as MSBuild properties as follows, for example:

<PropertyGroup>
  <Host>@(Http -> '%(host)')</Host>
  <Port>@(Http -> '%(port)')</Port>
  <Ssl>@(Http -> '%(ssl)')</Ssl>
</PropertyGroup>

In addition to the explicitly opted in object properties, the entire node is available as raw JSON via the special _ (single underscore) metadata item.

Parameters

Parameter Description
Content Optional string parameter.<br/>Specifies the JSON input as a string.
ContentPath Optional ITaskItem parameter.<br/>Specifies the JSON input as a file path.
Query Required string parameter.<br/>Specifies the JSONPath expression.
Result Output ITaskItem[] parameter.<br/>Contains the results that are returned by the task.

Sponsors

sponsored clariusclarius

get mentioned here too!

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on JsonPeek:

Package Downloads
Devlooped.Azure.Functions.OpenApi

OpenAPI/Swagger Source Generator for C# Azure Functions Built from https://github.com/devlooped/Azure.Functions.OpenApi/tree/027ade84f
NoeticTools.Git2SemVer.Core

Package Description
NoeticTools.Git2SemVer.Testing.Core

Package Description
NoeticTools.Git2SemVer.Framework

Framework to generate Semantic Versioning from Git repository and conventional commits. Used by other Git2SemVer projects.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on JsonPeek:

Repository Stars
dotnet/maui
.NET MAUI is the .NET Multi-platform App UI, a framework for building native device applications spanning mobile, tablet, and desktop.
Version Downloads Last Updated
1.2.0 71,508 11/28/2022
1.1.9 10,059 9/23/2022
1.1.8 425 9/23/2022
1.1.7 510 9/1/2022
1.1.6 707 8/5/2022
1.1.5 434 8/5/2022
1.1.0 1,645 2/3/2022
1.0.3 1,057 9/30/2021
1.0.2 399 9/15/2021

https://github.com/devlooped/json/blob/main/changelog.md