nucs.JsonSettings.Autosave.Fork 1.0.3

dotnet add package nucs.JsonSettings.Autosave.Fork --version 1.0.3
NuGet\Install-Package nucs.JsonSettings.Autosave.Fork -Version 1.0.3
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="nucs.JsonSettings.Autosave.Fork" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add nucs.JsonSettings.Autosave.Fork --version 1.0.3
#r "nuget: nucs.JsonSettings.Autosave.Fork, 1.0.3"
#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 nucs.JsonSettings.Autosave.Fork as a Cake Addin
#addin nuget:?package=nucs.JsonSettings.Autosave.Fork&version=1.0.3

// Install nucs.JsonSettings.Autosave.Fork as a Cake Tool
#tool nuget:?package=nucs.JsonSettings.Autosave.Fork&version=1.0.3

JsonSettings.AutoSave.Fork

Nuget downloads NuGet GitHub license

Easiest way you'll ever write settings for your app.

For .NetFramework4.8 .NET6 .NET8

  • Modular
  • One Liner
  • Abstract

Install

PM> Install-Package nucs.JsonSettings.Fork

Getting Started

See https://github.com/Nucs/JsonSettings/wiki/<br> Test project: https://github.com/Nucs/JsonSettings/tree/master/tests/nucs.JsonSettings.xTests<br> Blog Posts: http://blog.elibelash.com/2017/10/settings-file-in-your-project.html

JsonSettings is the base abstract class that inherits ISavable.<br> Here is a self explanatory quicky of to how and what:

  • I want a hardcoded settings file
//Step 1: create a class and inherit JsonSettings
class MySettings : JsonSettings {
    //Step 2: override a default FileName or keep it empty. Just make sure to specify it when calling Load!
    //This is used for default saving and loading so you won't have to specify the filename/path every time.
    //Putting just a filename without folder will put it inside the executing file's directory.
    public override string FileName { get; set; } = "TheDefaultFilename.extension"; //for loading and saving.

    #region Settings

    public string SomeProperty { get; set; }
    public int SomeNumberWithDefaultValue { get; set; } = 1;
    [JsonIgnore] public char ImIgnoredAndIWontBeSaved { get; set; }
    
    #endregion
    //Step 3: Override parent's constructors
    public MySettings() { }
    public MySettings(string fileName) : base(fileName) { }
}
//Step 4: Load
public MySettings Settings = JsonSettings.Load<MySettings>("config.json"); //relative path to executing file.
//or create a new empty
public MySettings Settings = JsonSettings.Construct<MySettings>("config.json");

//Step 5: Pwn.
Settings.SomeProperty = "ok";
Settings.Save();
  • I want a dynamic settings
    • Dynamic settings will automatically create new keys.
    • ValueTypes are returned as Nullable<Type>, therefore if a key doesn't exist - a null is returned.
//Step 1: Just load it, it'll be created if doesn't exist.
public SettingsBag Settings = JsonSettings.Load<SettingsBag>("config.json");
//Step 2: use!
Settings["key"]  = "dat value tho";
Settings["key2"] = 123; //dat number tho
dynamic dyn = Settings.AsDynamic();
if ((int?)dyn.key2==123)
    Console.WriteLine("explode");
dyn.Save(); /* or */ Settings.Save();
  • I want a encrypted settings file
    • Uses AES/Rijndael
    • Can be applied to any settings class because it is a module.
MySettings Settings = JsonSettings.Load<MySettings>("config.json", q=>q.WithEncryption("mysupersecretpassword"));
SettingsBag Settings = JsonSettings.Load<SettingsBag>("config.json", q=>q.WithEncryption("mysupersecretpassword"));
//or
MySettings Settings = JsonSettings.Configure<MySettings>("config.json")
                     .WithEncryption("mysupersecretpassword")
               //or: .WithModule<RijndaelModule>("pass");
                     .LoadNow();

SettingsBag Settings = JsonSettings.Configure<SettingsBag>("config.json")
                     .WithEncryption("mysupersecretpassword")
               //or: .WithModule<RijndaelModule>("pass");
                     .LoadNow();

  • I want dynamic settings to automatically save when changed
    • note: SettingsBag has it's own implementation of EnableAutosave().
//Step 1:
SettingsBag Settings = JsonSettings.Load<SettingsBag>("config.json").EnableAutosave();
//Unavailable for hardcoded settings yet! (ty netstandard2.0 for not being awesome on proxies)
//Step 2:
Settings.AsDynamic().key = "wow"; //BOOM! SAVED!
Settings["key"] = "wow two"; //BOOM! SAVED!
  • I want hardcoded settings to automatically save when changed
    • Requires package nucs.JsonSettings.Autosave that uses Castle.Core.
Settings x  = JsonSettings.Load<Settings>().EnableAutosave();
//or:
ISettings x = JsonSettings.Load<Settings>().EnableIAutosave<ISettings>(); //Settings implements interface ISettings

x.Property = "value"; //Booyah! SAVED!
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 is compatible.  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 Framework net48 is compatible.  net481 was computed. 
Compatible target framework(s)
Additional computed target framework(s)
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
1.0.3 174 12/15/2023
1.0.2 369 11/15/2021
1.0.1 476 12/13/2020