Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lebje/tomlkit
A small, simple TOML parser and serializer for Swift. Powered by toml++.
https://github.com/lebje/tomlkit
linux macos parser serializer swift swift-package swift5 toml toml-parser toml-parsing toml-serializer tomlplusplus windows windows-10
Last synced: about 1 month ago
JSON representation
A small, simple TOML parser and serializer for Swift. Powered by toml++.
- Host: GitHub
- URL: https://github.com/lebje/tomlkit
- Owner: LebJe
- License: mit
- Created: 2021-05-21T21:52:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-10T20:54:12.000Z (8 months ago)
- Last Synced: 2024-11-16T07:34:22.058Z (about 2 months ago)
- Topics: linux, macos, parser, serializer, swift, swift-package, swift5, toml, toml-parser, toml-parsing, toml-serializer, tomlplusplus, windows, windows-10
- Language: C++
- Homepage: https://lebje.github.io/TOMLKit/documentation/tomlkit
- Size: 5.65 MB
- Stars: 35
- Watchers: 1
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# TOMLKit
**A small, simple TOML parser and serializer for Swift. Powered by [toml++](https://github.com/marzer/tomlplusplus/).**
[](https://swift.org)
[](https://swift.org/package-manager)
[](https://github.com/LebJe/TOMLKit/releases)
[](https://github.com/LebJe/TOMLKit/actions?query=workflow%3A%22Build+and+Test%22)
[](https://swiftpackageindex.com/LebJe/TOMLKit)
[](https://swiftpackageindex.com/LebJe/TOMLKit)
TOMLKit is a [Swift](https://swift.org) wrapper around [toml++](https://github.com/marzer/tomlplusplus/), allowing you to parse and serialize [TOML](https://toml.io) files in Swift.
## Table of Contents
- [TOMLKit](#tomlkit)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Swift Package Manager](#swift-package-manager)
- [Quick Start](#quick-start)
- [Full Documentation](#full-documentation)
- [Dependencies](#dependencies)
- [Licenses](#licenses)
- [Contributing](#contributing)
Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
## Installation
### Swift Package Manager
Add this to the `dependencies` array in `Package.swift`:
```swift
.package(url: "https://github.com/LebJe/TOMLKit.git", from: "0.5.0")
```
Also add this to the `targets` array in the aforementioned file:
```swift
.product(name: "TOMLKit", package: "TOMLKit")
```
## Quick Start
```swift
import TOMLKit
import struct Foundation.Date
let toml = """
string = "Hello, World!"
int = 523053
double = 3250.34
"""
struct Test: Codable {
let string: String
let int: Int
let double: Double
}
do {
let table = try TOMLTable(string: toml)
table.remove(at: "double")
table["dateTime"] = TOMLDateTime(date: Foundation.Date())
table.insert(
TOMLArray([1, 2, "3", TOMLTable(["time": TOMLTime(hour: 10, minute: 26, second: 49, nanoSecond: 203)])]),
at: "array"
)
let test = Test(string: "Goodbye, World!", int: 24598, double: 18.247)
let encodedTest: TOMLTable = try TOMLEncoder().encode(test)
let decodedTest = try TOMLDecoder().decode(Test.self, from: encodedTest)
print("----Encoding & Decoding----\n")
print("Encoded Test: \n\(encodedTest)\n")
print("Decoded Test: \(decodedTest)")
print("\n----Conversion----\n")
print("TOML:\n\(table.convert(to: .toml))\n")
print("JSON:\n\(table.convert(to: .json))\n")
print("YAML:\n\(table.convert(to: .yaml))")
} catch let error as TOMLParseError {
// TOMLParseError occurs when the TOML document is invalid.
// `error.source.begin` contains the line and column where the error started,
// and `error.source.end` contains the line where the error ended.
print(error.source.begin)
print(error.source.end)
}
// ----Encoding & Decoding----
//
// Encoded Test:
// double = 18.247
// int = 24598
// string = 'Goodbye, World!'
//
// Decoded Test: Test(string: "Goodbye, World!", int: 24598, double: 18.247)
//
// ----Conversion----
//
// TOML:
// array = [ 1, 2, '3', { time = 10:26:49.000000203 } ]
// dateTime = 2022-03-31T12:19:38.160653948Z
// int = 523053
// string = 'Hello, World!'
//
// JSON:
// {
// "array" : [
// 1,
// 2,
// "3",
// {
// "time" : "10:26:49.000000203"
// }
// ],
// "dateTime" : "2022-03-31T12:19:38.160653948Z",
// "int" : 523053,
// "string" : "Hello, World!"
// }
//
// YAML:
// array:
// - 1
// - 2
// - 3
// - time: '10:26:49.000000203'
// dateTime: '2022-03-31T12:19:38.160653948Z'
// int: 523053
// string: 'Hello, World!'
```
### Full Documentation
Full documentation is available [here](https://lebje.github.io/TOMLKit/documentation/tomlkit/).
## Dependencies
- [toml++](https://github.com/marzer/tomlplusplus/)
## Licenses
The [toml++](https://github.com/marzer/tomlplusplus/) license is available in the `tomlplusplus` directory in the `LICENSE` file.
## Contributing
Before committing, please install [pre-commit](https://pre-commit.com), [swift-format](https://github.com/nicklockwood/SwiftFormat), [clang-format](https://clang.llvm.org/docs/ClangFormat.html), and [Prettier](https://prettier.io), then install the pre-commit hook:
```bash
$ brew bundle # install the packages specified in Brewfile
$ pre-commit install
# Commit your changes.
```
To install pre-commit on other platforms, refer to the [documentation](https://pre-commit.com/#install).