-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
8 additions
and
241 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,49 +3,5 @@ name: "Build and Test" | |
| on: ["push", "pull_request"] | ||
|
|
||
| jobs: | ||
| TestOnMacOS-Latest-x86_64: | ||
| runs-on: "macos-latest" | ||
| steps: | ||
| - uses: "actions/checkout@v4" | ||
| - name: "Run tests" | ||
| run: "swift test" | ||
| # TestOnUbuntu-20_04-ARM: | ||
| # runs-on: ubuntu-latest | ||
| # steps: | ||
| # - uses: actions/checkout@v2 | ||
| # - uses: uraimo/[email protected] | ||
| # with: | ||
| # arch: aarch64 | ||
| # distro: ubuntu20.04 | ||
| # githubToken: ${{ secrets.GITHUB_TOKEN }} | ||
| # run: | | ||
| # export DEBIAN_FRONTEND=noninteractive | ||
| # apt update -q | ||
| # apt install -yq curl sudo | ||
| # curl -s https://packagecloud.io/install/repositories/swift-arm/release/script.deb.sh | sudo bash | ||
| # apt install -yq swiftlang | ||
| # apt update -yq | ||
| # swift test | ||
| TestOnUbuntu-20_04-x86_64: | ||
| runs-on: "ubuntu-latest" | ||
| steps: | ||
| - uses: "actions/checkout@v4" | ||
| - name: "Run tests" | ||
| run: "swift test" | ||
| TestOnWindows10-x86_64: | ||
| runs-on: "windows-latest" | ||
| steps: | ||
| - uses: "actions/checkout@v4" | ||
| - uses: "seanmiddleditch/gha-setup-vsdevenv@master" | ||
| - uses: "compnerd/gha-setup-swift@main" | ||
| with: | ||
| branch: "swift-5.8-release" | ||
| tag: "5.8-RELEASE" | ||
| - name: "Test" | ||
| run: "swift test -Xcc -D_ALLOW_COMPILER_AND_STL_VERSION_MISMATCH -Xcxx -D_ALLOW_COMPILER_AND_STL_VERSION_MISMATCH" | ||
| TestBuildingOnMacOS-Latest-ARM64: | ||
| runs-on: "macos-latest" | ||
| steps: | ||
| - uses: "actions/checkout@v4" | ||
| - name: "Run tests" | ||
| run: "swift build --arch arm64" | ||
| "BuildAndTest": | ||
| uses: LebJe/SwiftWorkflows/.github/workflows/buildAndTest.yml@main | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,166 +1,3 @@ | ||
| # TOMLKit | ||
| # TestGAWorkflows | ||
|
|
||
| **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 | ||
|
|
||
| <!--ts--> | ||
|
|
||
| - [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) | ||
|
|
||
| <!-- Added by: lebje, at: Fri Apr 1 15:58:35 EDT 2022 --> | ||
|
|
||
| <!--te--> | ||
|
|
||
| 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). | ||
| This repository is used to test Github Actions Workflows. Releases may be created to test workflows that run only when a release is created. |