CSV file storage provider for OutWit.Common.Settings. Enables storing settings in tabular CSV format, ideal for spreadsheet editing and external tool processing.
Get Started
$ dotnet add package OutWit.Common.Settings.CsvReadme
OutWit.Common.Settings.Csv
Overview
OutWit.Common.Settings.Csv is a CSV file storage provider for the OutWit.Common.Settings framework. It enables storing and loading application settings in tabular CSV format, ideal for scenarios where settings need to be easily editable in spreadsheet applications or processed by external tools.
Features
1. Simple Integration
Use the UseCsv() extension method to configure CSV storage with conventional defaults:
var manager = new SettingsBuilder()
.UseCsv() // Uses {AppContext.BaseDirectory}/Resources/settings.csv
.RegisterContainer<NetworkSettings>()
.Build();
manager.Merge();
manager.Load();
2. Custom File Paths
Specify custom paths for defaults and scope-specific files:
var manager = new SettingsBuilder()
.UseCsv("path/to/defaults.csv")
.Build();
Or add individual CSV files for specific scopes:
builder.UseCsvFile("config/global-settings.csv", SettingsScope.Global);
builder.UseCsvFile("config/user-settings.csv", SettingsScope.User);
3. CSV File Format
Settings are stored in a simple tabular format with the following columns:
Group,Key,Value,ValueKind,Tag,Hidden
NetworkSettings,ApiEndpoint,http://localhost:5000,ServiceUrl,,False
NetworkSettings,ProxyUrl,,Url,,False
NetworkSettings,ConnectionTimeout,00:00:30,TimeSpan,,False
NetworkSettings,MaxRetries,3,Integer,,False
Columns:
Group- Settings group nameKey- Setting key/property nameValue- Serialized valueValueKind- Type identifier for deserializationTag- Optional metadata (e.g., enum type for Enum values)Hidden- Whether to hide from UI
4. Group Metadata
Group metadata can be stored in a separate file ():