{"id":41904821,"url":"https://github.com/mattt/swift-configuration-toml","last_synced_at":"2026-02-01T12:20:31.738Z","repository":{"id":329733049,"uuid":"1118554660","full_name":"mattt/swift-configuration-toml","owner":"mattt","description":"A TOML provider for the Swift Configuration framework.","archived":false,"fork":false,"pushed_at":"2025-12-21T12:56:59.000Z","size":37,"stargazers_count":18,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-12-23T03:55:29.455Z","etag":null,"topics":["swift-configuration"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mattt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-17T23:59:10.000Z","updated_at":"2025-12-22T15:06:58.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mattt/swift-configuration-toml","commit_stats":null,"previous_names":["mattt/swift-configuration-toml"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/mattt/swift-configuration-toml","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattt%2Fswift-configuration-toml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattt%2Fswift-configuration-toml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattt%2Fswift-configuration-toml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattt%2Fswift-configuration-toml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mattt","download_url":"https://codeload.github.com/mattt/swift-configuration-toml/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattt%2Fswift-configuration-toml/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28754817,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T13:59:49.818Z","status":"ssl_error","status_checked_at":"2026-01-25T13:59:33.728Z","response_time":113,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["swift-configuration"],"created_at":"2026-01-25T15:14:55.078Z","updated_at":"2026-01-25T15:14:55.144Z","avatar_url":"https://github.com/mattt.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swift Configuration TOML\n\nA [TOML](https://toml.io) provider for the [Swift Configuration](https://github.com/apple/swift-configuration) framework,\nbuilt on [swift-toml](https://github.com/mattt/swift-toml) for spec-compliant parsing\n\n## Requirements\n\n- Swift 6.2+ / Xcode 26+\n- macOS 15.0+ / iOS 18.0+ / watchOS 11.0+ / tvOS 18.0+ / visionOS 2.0+\n\n## Installation\n\n### Swift Package Manager\n\nAdd the following to your `Package.swift` file:\n\n```swift\ndependencies: [\n    .package(url: \"https://github.com/apple/swift-configuration.git\", from: \"1.0.0\"),\n    .package(url: \"https://github.com/mattt/swift-configuration-toml.git\", from: \"1.0.0\")\n]\n```\n\nThen add the dependency to your target:\n\n```swift\n.target(\n    name: \"YourTarget\",\n    dependencies: [\n        .product(name: \"Configuration\", package: \"swift-configuration\"),\n        .product(name: \"ConfigurationTOML\", package: \"swift-configuration-toml\")\n    ],\n    swiftSettings: [\n        .interoperabilityMode(.Cxx)\n    ]\n)\n```\n\n## Usage\n\n### Basic Usage\n\n```swift\nimport Configuration\nimport ConfigurationTOML\n\n// Create a provider from a TOML file\nlet provider = try await TOMLProvider(filePath: \"/path/to/config.toml\")\nlet config = ConfigReader(provider: provider)\n\n// Read configuration values\nlet title = config.string(forKey: \"title\")\nlet port = config.int(forKey: \"port\", default: 8080)\nlet debug = config.bool(forKey: \"debug\", default: false)\n```\n\n### Nested Tables\n\n```swift\n// config.toml:\n// [server]\n// host = \"localhost\"\n// port = 8080\n//\n// [database]\n// url = \"postgres://localhost/mydb\"\n// maxConnections = 10\n\nlet provider = try await TOMLProvider(filePath: \"config.toml\")\nlet config = ConfigReader(provider: provider)\n\nlet host = config.string(forKey: \"server.host\")\nlet port = config.int(forKey: \"server.port\")\nlet dbUrl = config.string(forKey: \"database.url\")\nlet maxConn = config.int(forKey: \"database.maxConnections\")\n```\n\n### Arrays\n\n```swift\n// config.toml:\n// ports = [8001, 8002, 8003]\n// names = [\"alpha\", \"beta\", \"gamma\"]\n\nlet provider = try await TOMLProvider(filePath: \"config.toml\")\nlet config = ConfigReader(provider: provider)\n\nlet ports = config.intArray(forKey: \"ports\")\nlet names = config.stringArray(forKey: \"names\")\n```\n\n### Parsing Options (bytes + secrets)\n\n```swift\nimport Configuration\nimport ConfigurationTOML\n\nlet options = TOMLSnapshot.ParsingOptions(\n    bytesDecoder: .hex,\n    secretsSpecifier: .dynamic { key, _ in\n        key.lowercased().contains(\"password\") || key.lowercased().contains(\"token\")\n    }\n)\n\nlet provider = try await TOMLProvider(filePath: \"config.toml\", parsingOptions: options)\nlet config = ConfigReader(provider: provider)\n\nlet apiKeyBytes = config.bytes(forKey: \"api.key\")\n```\n\n### Using `FileProvider\u003cTOMLSnapshot\u003e`\n\n`TOMLSnapshot` conforms to `FileConfigSnapshot`, so it can be used with Swift Configuration’s file providers:\n\n```swift\nimport Configuration\nimport ConfigurationTOML\n\nlet provider = try await FileProvider\u003cTOMLSnapshot\u003e(\n    filePath: \"config.toml\",\n    parsingOptions: .default\n)\nlet config = ConfigReader(provider: provider)\n```\n\n### Reloading providers\n\n`ConfigurationTOML` includes a `Reloading` trait (disabled by default).\nEnable it to use `ReloadingTOMLProvider`.\n\nWhen enabled, this package also forwards the `Reloading` trait to its `swift-configuration`\ndependency automatically.\n\n```diff\n  dependencies: [\n      .package(\n          url: \"https://github.com/mattt/swift-configuration-toml.git\",\n          from: \"1.0.0\",\n+         traits: [.defaults, .trait(name: \"Reloading\")]\n      )\n  ]\n```\n\nWhen the `Reloading` trait is enabled, you can use `ReloadingTOMLProvider` inside a `ServiceGroup`\nto enable automatic reloading of your configuration file.\n\n```swift\nimport Configuration\nimport ConfigurationTOML\n\nlet provider = try await ReloadingTOMLProvider(filePath: \"config.toml\")\nlet config = ConfigReader(provider: provider)\n\nlet logger = Logger(label: \"config\")\nlet serviceGroup = ServiceGroup(services: [provider], logger: logger)\ntry await serviceGroup.run()\n```\n\n### Complex Configuration\n\n```swift\n// config.toml:\n// [server]\n// host = \"localhost\"\n// port = 8080\n//\n// [server.ssl]\n// enabled = true\n// certificate = \"/path/to/cert.pem\"\n\nlet provider = try await TOMLProvider(filePath: \"config.toml\")\nlet config = ConfigReader(provider: provider)\n\nlet host = config.string(forKey: \"server.host\")\nlet port = config.int(forKey: \"server.port\")\nlet sslEnabled = config.bool(forKey: \"server.ssl.enabled\")\nlet cert = config.string(forKey: \"server.ssl.certificate\")\n```\n\n## License\n\nThis project is available under the MIT license.\nSee the LICENSE file for more info.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattt%2Fswift-configuration-toml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmattt%2Fswift-configuration-toml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattt%2Fswift-configuration-toml/lists"}