Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salaros/config-parser
A slim, fully managed C# library for reading/writing .ini, .conf, .cfg etc configuration files.
https://github.com/salaros/config-parser
cfg conf config configs configuration configuration-file configuration-files cross-platform csharp dotnet file ini managed mono
Last synced: about 11 hours ago
JSON representation
A slim, fully managed C# library for reading/writing .ini, .conf, .cfg etc configuration files.
- Host: GitHub
- URL: https://github.com/salaros/config-parser
- Owner: salaros
- License: mit
- Created: 2015-07-18T09:10:06.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-08-08T16:45:02.000Z (over 2 years ago)
- Last Synced: 2024-11-02T09:39:29.971Z (12 days ago)
- Topics: cfg, conf, config, configs, configuration, configuration-file, configuration-files, cross-platform, csharp, dotnet, file, ini, managed, mono
- Language: C#
- Homepage: https://salaros.com
- Size: 324 KB
- Stars: 112
- Watchers: 2
- Forks: 18
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
ο»ΏConfigParser
[](https://ci.appveyor.com/project/salaros/configparser)
[](https://ci.appveyor.com/project/salaros/configparser/build/tests)
[](https://coveralls.io/github/salaros/config-parser?branch=master)
=============
[](https://en.wikipedia.org/wiki/Cross-platform)
[](https://social.msdn.microsoft.com/Forums/vstudio/en-US/7035edc6-97fc-49ee-8eee-2fa4d040a63b/)
[](https://social.msdn.microsoft.com/Forums/vstudio/en-US/7035edc6-97fc-49ee-8eee-2fa4d040a63b/)
[](https://github.com/salaros/configparser/blob/master/LICENSE)
[](https://www.nuget.org/packages/Salaros.ConfigParser)
[](https://www.nuget.org/packages/Salaros.ConfigParser)
[](https://www.nuget.org/packages/Salaros.ConfigParser)
[](https://www.patreon.com/salaros/)
[](https://paypal.me/salarosIT)
[](https://liberapay.com/salaros/)
**ConfigParser** - is a slim, cross-platform, fully managed C# library for reading and writing .ini, .conf, .cfg etc configuration files.
You could use it in your [Unity 3D](https://unity3d.com/), [Xamarin](http://xamarin.com) (iOS & Android), .NET Framework applications (even with old 4.0/4.5), .NET Core CLI and ASP.NET Core applications, [Mono](https://www.mono-project.com/) etc
Features
========
## Customization
- [x] customizable encoding (most encodings can be auto-detected)
- [x] customizable culture
- [x] customizable number styles (e.g. currencies, exponential notation etc)
- [x] customizable line endings (usually auto-detected)
- [x] customizable true and false (e.g. "verum" / "falsum" )
- [x] customizable comment characters
- [x] customizable key/value separator (defaults to '=')
## Read and preserved
- [x] file header comments
- [x] config files with no sections (like in this [SectionName]) or even mixed: first section has no header, just keys
- [x] comments in general
- [x] section comments
- [x] empty lines
- [x] indented sections
- [x] indented keys
- [x] indented values
## Values
- [x] default values
- [x] multi-line values (both quoted and not)
- [x] quoted values
- [x] null values (value-less keys)
- [x] array values
- [x] fancy float / double
- [x] byte-encoded values
- [x] smart boolean values (0/1, on/off, enabled/disabled work of the box)
and more...
## πππ Support this project πππ
You can support us in a small way, please consider starring and sharing this repo! It helps us getting known and grow the community.
Installation
============
**Config Parser** can be installed via [NuGet](https://www.nuget.org/packages/Salaros.ConfigParser)
by using Package Manager in your IDE, `dotnet` binary or Package Console
```bash
# Add the Salaros.ConfigParser package to a project named []
dotnet add [] package Salaros.ConfigParser
```
or Visual Studio's Package Console
```powershell
# Add the Salaros.ConfigParser package to the default project
Install-Package Salaros.ConfigParser
# Add the Salaros.ConfigParser package to a project named []
Install-Package Salaros.ConfigParser -ProjectName []
```
Usage
=====
```csharp
// Initialize config file instance from file
var configFileFromPath = new ConfigParser(@"path\to\configfile.cnf");
// Parse text
var configFileFromString = new ConfigParser(@"
[Strings]
canBeIndented = value
andQuoted = ""quotes will be stripped""
[Numbers]
withD = 0.6D
dollars = $2,999
[boolean]
numericTrue = 1
textFalse = true
yesWorks = yes
upperCaseWorks = on
worksAsWell = Enabled
[Advanced]
arrayWorkToo =
arrayElement1
arrayElement2
valueLessKey",
new ConfigParserSettings
{
MultiLineValues = MultiLineValues.Simple | MultiLineValues.AllowValuelessKeys | MultiLineValues.QuoteDelimitedValues,
Culture = new CultureInfo("en-US")
}
);
configFileFromString.GetValue("Strings", "canBeIndented"); // value
configFileFromString["Strings"]["canBeIndented"]; // returns 'value' too
configFileFromString.GetValue("Strings", "andQuoted"); // quotes will be stripped
configFileFromString.GetValue("Numbers", "withD", 0D); // 0,6
configFileFromString.GetValue("Numbers", "dollars", 0D, // 2999
NumberStyles.AllowCurrencySymbol);
configFileFromString.GetValue("Numbers", "dollars"); // $2,999
configFileFromString.GetValue("boolean", "numericTrue", false); // True
configFileFromString.GetValue("boolean", "textFalse", false); // True
configFileFromString.GetValue("boolean", "yesWorks", false); // True
configFileFromString.GetValue("boolean", "upperCaseWorks", false); // True
configFileFromString.GetValue("boolean", "worksAsWell", false); // True
configFileFromString.GetArrayValue("Advanced", "arraysWorkToo"); // ["arrayElement1","arrayElement2"]
configFileFromString.GetValue("Advanced", "valueLessKey"); //
```
How to build
============
You need Git and [.NET Core SDK](https://www.microsoft.com/net/download/)
```bash
git clone https://github.com/salaros/ConfigParser
cd ConfigParser
dotnet build
```
How to test
===========
**ConfigParser** uses [xUnit.net](https://xunit.github.io/), so you can run unit tests by simply using the following command:
```bash
dotnet test tests
```
License
=======
**ConfigParser** is distributed under the [MIT license](LICENSE), which grants you
- [x] Private use
- [x] Commercial use
- [x] Modification
- [x] Distribution
However you have to include the content of [license](LICENSE) file in your source code (if you distribute your Software in text form), otherwise include it in your own LICENSE file or to some sort of **About -> Open-source libraries** section if you distribute your Software as a compiled library / binary.
Here is why (part of [MIT license](LICENSE)):
```
The above copyright notice and this permission notice
shall be included in all copies or substantial portions of the Software.
```