Sharingan 1.0.4

Sharingan

Cross-Platform Local Settings Library for .NET

A robust, multi-process-safe, async-first settings library for managing application, user, and device settings locally.

✨ Features

• 🌍 Cross-Platform — Works on Windows, Linux, macOS, Android, and iOS
• 🔒 Multi-Process Safe — File locking and atomic writes prevent data corruption
• ⚡ Async-First — Full async/await support with CancellationToken
• 🔌 11 Pluggable Providers — JSON, Registry, INI, YAML, XML, TOML, SQLite, and more
• 🏗️ Composite Configuration — Chain multiple providers with priority-based resolution
• 🔐 Encryption Support — AES-256-GCM and DPAPI for sensitive settings
• 📦 Lightweight — Minimal dependencies, optimized for performance
• 🎯 Multi-Target — Supports .NET Framework 4.8+, .NET Standard 2.0+, and .NET 7-10
• 🔔 Change Notifications — Event-driven updates when settings change
• 💪 Strongly-Typed — Full generic support with type-safe access
• 🔗 DI Integration — Microsoft.Extensions.DependencyInjection support
• 🌐 Configuration Bridge — Works with Microsoft.Extensions.Configuration

📦 Installation

Core Package

dotnet add package Sharingan

Provider Packages

# Windows Registry support
dotnet add package Sharingan.Providers.Registry

# INI file support
dotnet add package Sharingan.Providers.Ini

# YAML file support
dotnet add package Sharingan.Providers.Yaml

# XML file support
dotnet add package Sharingan.Providers.Xml

# TOML file support
dotnet add package Sharingan.Providers.Toml

# SQLite database support
dotnet add package Sharingan.Providers.SQLite

# Encryption support
dotnet add package Sharingan.Providers.Encrypted

Extension Packages

# Dependency Injection integration
dotnet add package Sharingan.Extensions.DependencyInjection

# Microsoft.Extensions.Configuration bridge
dotnet add package Sharingan.Extensions.Configuration

🚀 Quick Start

Basic Usage

using Sharingan;

// Store settings
Settings.Default.Set("app.theme", "Dark");
Settings.Default.Set("app.fontSize", 14);
Settings.Default.Set("app.autoSave", true);

// Retrieve settings with type-safe access
string theme = Settings.Default.GetString("app.theme");
int fontSize = Settings.Default.GetInt("app.fontSize");
bool autoSave = Settings.Default.GetBool("app.autoSave");

// Or use generic Get<T>
var config = Settings.Default.Get<AppConfig>("app.config", new AppConfig());

Using the Builder Pattern

using Sharingan;
using Sharingan.Providers;

ISettingsStore settings = new SharinganBuilder()
    .WithApplicationName("MyApp")
    .WithOrganizationName("MyCompany")
    .UseEnvironmentVariables("MYAPP_", priority: 100)  // Highest priority
    .UseJsonFile("settings.json", SettingsScope.User, priority: 50)
    .UseInMemory(priority: 10)  // Fallback
    .Build();

// Environment variables override JSON file settings
settings.Set("database.host", "localhost");
string host = settings.GetString("database.host");

Dependency Injection

using Sharingan.Extensions.DependencyInjection;

services.AddSharingan(builder => builder
    .WithApplicationName("MyApp")
    .UseJsonFile("settings.json")
);

// Inject anywhere
public class MyService(ISettingsStore settings)
{
    public string GetTheme() => settings.GetString("theme", "Light");
}

🔧 Providers

🎯 Target Frameworks

🌐 Supported Platforms

📄 License

This project is licensed under the MIT License.

🔗 Links

• GitHub Repository
• Issue Tracker
• Changelog