Configs 2.0.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package Configs --version 2.0.1
NuGet\Install-Package Configs -Version 2.0.1
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="Configs" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Configs --version 2.0.1
#r "nuget: Configs, 2.0.1"
#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.
// Install Configs as a Cake Addin
#addin nuget:?package=Configs&version=2.0.1

// Install Configs as a Cake Tool
#tool nuget:?package=Configs&version=2.0.1

Configs icon

Configs

https://www.nuget.org/packages/Configs/

A simple way to save the configurations/settings of a C# app as a json file.

The json file(s) is saved in AppData/Local/{YourAppName} and there is currently no way to change that.

If you have any questions you can post them in the discussions section.

How to use

Before we start, install the package from NuGet.

This package uses Newtonsoft.Json and the idea is to make a class that's going to be used as the model for the configuration file.

Setup

Make a class that inherits from ConfigsTools. This class is the model for your configurations file, so it details how the json file is going to look like. Model example:

using Configs;
using Newtonsoft.Json;
using System.Collections.Generic;

namespace ConfigsTest
{
    class AppConfigs : ConfigsTools
    {
        public AppConfigs()
        {
            ImportantStuff = new List<ImportantThing>();
        }

        [JsonProperty("activated", Required = Required.AllowNull)]
        public bool Activated { get; set; }

        [JsonProperty("randomString", Required = Required.Default)]
        public string RandomString { get; set; }

        [JsonProperty("importantStuff", Required = Required.AllowNull)]
        public List<ImportantThing> ImportantStuff { get; set; }

        // You can add methods that you can use when loading the config file
        public void ChangeFirstThing()
        {
            ImportantStuff[0].OwnerName = "Slim Shady";
        }
    }
}

Pretty much anything supported by Newtonsoft.Json and is serializable can be used in this model. You can of course make multiple models to have multiple configurations files. By default the name of the json file is the name of model/class.

Usage

Getting the file's values

using Configs;

...

// Get the current app configurations from the json configurations file.
AppConfigs appConfigs = ConfigsTools.GetConfigs<AppConfigs>();
// Get a value from the configurations file.
bool appConfigActivated = appConfigs.Activated;

Editing and saving the file

using Configs;

...

// Get the current app configurations from the json configurations file.
AppConfigs appConfigs = ConfigsTools.GetConfigs<AppConfigs>();
// Change value.
appConfigs.RandomString = "this text is going to be saved in the json file";
// Add object to list.
appConfigs.ImportantStuff.Add(new ImportantThing("Elias Youssef"));
// Use methods that are inside the model
appConfigs.ChangeFirstThing();
// Save the file.
appConfigs.Save();

Result

{
  "activated": false,
  "randomString": "this text is going to be saved in the json file",
  "importantStuff": [
    {
      "OwnerName": "Slim Shady"
    }
  ]
}

Window Settings icon icon by Icons8

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. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.5 488 4/24/2022
2.0.4 402 4/23/2022
2.0.3 362 7/25/2021
2.0.2 417 4/11/2021
2.0.1 355 4/8/2021
1.0.4 328 4/1/2021
1.0.3 375 2/26/2021

Enabled "XML documentation file"