Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xoofx/Tomlyn
Tomlyn is a TOML parser, validator and authoring library for .NET Framework and .NET Core
https://github.com/xoofx/Tomlyn
csharp dotnet dotnet-core toml toml-parser toml-validation
Last synced: 4 days ago
JSON representation
Tomlyn is a TOML parser, validator and authoring library for .NET Framework and .NET Core
- Host: GitHub
- URL: https://github.com/xoofx/Tomlyn
- Owner: xoofx
- License: bsd-2-clause
- Created: 2019-02-03T09:54:12.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-03-17T14:03:45.000Z (8 months ago)
- Last Synced: 2024-07-16T22:14:36.483Z (4 months ago)
- Topics: csharp, dotnet, dotnet-core, toml, toml-parser, toml-validation
- Language: C#
- Homepage:
- Size: 386 KB
- Stars: 396
- Watchers: 7
- Forks: 29
- Open Issues: 24
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Funding: .github/FUNDING.yml
- License: license.txt
Awesome Lists containing this project
README
# Tomlyn [](https://github.com/xoofx/Tomlyn/actions) [](https://coveralls.io/github/xoofx/Tomlyn?branch=main) [](https://www.nuget.org/packages/Tomlyn/)
Tomlyn is a [TOML](https://toml.io/en/) parser, validator and authoring library for .NET Framework and .NET Core.
## What is TOML?
> **_A config file format for humans._**
> _TOML aims to be a minimal configuration file format that's easy to read due to obvious semantics. TOML is designed to map unambiguously to a hash table. TOML should be easy to parse into data structures in a wide variety of languages._
- See the official website https://toml.io/en/ for more details.
- Example and specifications are available at [TOML v1.0.0](https://toml.io/en/v1.0.0)
## Features
- Very fast parser, GC friendly.
- Compatible with the latest [TOML v1.0.0 specs](https://toml.io/en/v1.0.0).
- Allow to map a TOML string to a default runtime model via `Toml.ToModel(string)`
- Allow to map a TOML string to a custom runtime model via `Toml.ToModel(string)`
- Very convenient for loading custom configurations for example.
- Allow to generate a TOML string from a runtime model via `string Toml.FromModel(object)`
- Preserve comments, by default with the default runtime model, or by implementing the `ITomlMetadataProvider`.
- Allow to parse to a `DocumentSyntax` via `Toml.Parse(string)`.
- Preserve all spaces, new line, comments but also invalid characters/tokens.
- Can roundtrip to text with exact representation.
- Provides a validator with the `Toml.Validate` method.
- Supports for .NET Standard 2.0+ and provides an API with nullable annotations.
## Documentation
See the [documentation](https://github.com/xoofx/Tomlyn/blob/main/doc/readme.md) for more details.
## Install
Tomlyn is delivered as a [NuGet Package](https://www.nuget.org/packages/Tomlyn/).
## Usage
```c#
var toml = @"global = ""this is a string""
# This is a comment of a table
[my_table]
key = 1 # Comment a key
value = true
list = [4, 5, 6]
";
// Parse the TOML string to the default runtime model `TomlTable`
var model = Toml.ToModel(toml);
// Fetch the string
var global = (string)model["global"]!;
// Prints: found global = "this is a string"
Console.WriteLine($"found global = \"{global}\"");
// Generates a TOML string from the model
var tomlOut = Toml.FromModel(model);
// Output the generated TOML
Console.WriteLine(tomlOut);
```
This will print the original TOML by preserving most the comments:
```toml
global = "this is a string"
# This is a comment of a table
[my_table]
key = 1 # Comment a key
value = true
list = [4, 5, 6]
```
> NOTICE: By default, when mapping to a custom model, Tomlyn is using the PascalToSnakeCase naming convention (e.g `ThisIsFine` to `this_is_fine`).
> This behavior can be changed by overriding the `TomlModelOptions.ConvertPropertyName` delegate.
## License
This software is released under the [BSD-Clause 2 license](https://opensource.org/licenses/BSD-2-Clause).
## Credits
Modified version of the logo `Thor` by [Mike Rowe](https://thenounproject.com/itsmikerowe/) from the Noun Project (Creative Commons)
## Author
Alexandre Mutel aka [xoofx](http://xoofx.github.io).