StronglyTypedJsonKeys 1.0.5

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package StronglyTypedJsonKeys --version 1.0.5
                    


                    

                
NuGet\Install-Package StronglyTypedJsonKeys -Version 1.0.5
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="StronglyTypedJsonKeys" Version="1.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="StronglyTypedJsonKeys" Version="1.0.5" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="StronglyTypedJsonKeys" />
                    


                            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 StronglyTypedJsonKeys --version 1.0.5
                    


                    

                
#r "nuget: StronglyTypedJsonKeys, 1.0.5"
#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. 
#:package StronglyTypedJsonKeys@1.0.5
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=StronglyTypedJsonKeys&version=1.0.5
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=StronglyTypedJsonKeys&version=1.0.5
                    


                            Install as a Cake Tool

Strongly Typed JSON Keys

Strongly Typed JSON Keys is a .NET Roslyn source generator that reads JSON files at build time and generates static classes containing const string fields for each JSON key (including nested).

The goal is to eliminate hard-coded string keys when working with JSON-based data such as configuration files, localization resources, or structured payloads.

Why use this?

Hard-coding JSON keys as strings can lead to:

  • Typos that only fail at runtime;
  • Painful refactors when keys change;
  • Poor discoverability and IntelliSense support.

This source generator solves those problems by:

  • Generating compile-time constants for JSON keys;
  • Making key usage refactor-safe;
  • Providing IntelliSense and compile-time checking.

What it does

Given one or more JSON files, the generator:

  • Parses their keys at compile time;
  • Generates static classes with const string fields each containing the full key path;
  • Keeps your code in sync with your JSON structure.

How do I use it

Just include your JSON files in your project as AdditionalFiles like this:



  <ItemGroup>
    <AdditionalFiles Include="json_files/example.json">
      <GenerateKeys>true</GenerateKeys>
      <ClassName>ExampleKeys</ClassName>
    </AdditionalFiles>
  </ItemGroup>

The GenerateKeys tag is required for the generator to process your JSON files.

Options

You can configure the generation of each file to your liking with these options:

Name Description Type
RootKeyPath Limits key generation to a nested JSON object instead of the entire file. string
KeysPrefix Prefixes all generated keys with a specified value. string
ClassName The name of the generated class. Defaults to the JSON file name. string
CapitalizeGeneratedKeys Capitalizes generated field names to avoid conflicts with C# keywords. bool

License: MIT

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.