JsonPeek 1.0.2
See the version list below for details.
dotnet add package JsonPeek --version 1.0.2
NuGet\Install-Package JsonPeek -Version 1.0.2
<PackageReference Include="JsonPeek" Version="1.0.2" />
paket add JsonPeek --version 1.0.2
#r "nuget: JsonPeek, 1.0.2"
// Install JsonPeek as a Cake Addin #addin nuget:?package=JsonPeek&version=1.0.2 // Install JsonPeek as a Cake Tool #tool nuget:?package=JsonPeek&version=1.0.2
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
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
NuGet packages (3)
Showing the top 3 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 |
GitHub repositories
This package is not used by any popular GitHub repositories.