Contents

devkitorganization/devconfiguration

DevConfiguration is a type-safe configuration wrapper built on Apple’s swift-configuration library.

Development Requirements

DevConfiguration requires a Swift 6.2 toolchain to build. We only test on Apple platforms. We follow the [Swift API Design Guidelines][SwiftAPIDesignGuidelines]. We take pride in the fact that our public interfaces are fully documented and tested. We aim for overall test coverage over 99%. SwiftUI views do not currently have automated tests.

[SwiftAPIDesignGuidelines]: https://swift.org/documentation/api-design-guidelines/

Development Setup

To set up the development environment:

1. Run Scripts/install-git-hooks to install pre-push hooks that automatically check code formatting. 2. Use Scripts/lint to manually check code formatting at any time. 3. Use Scripts/format to automatically format code.

Bugs and Feature Requests

Find a bug? Want a new feature? Create a GitHub issue and we’ll take a look.

License

All code is licensed under the MIT license. Do with it as you will.

Package Metadata

Repository: devkitorganization/devconfiguration

Default branch: main

README: README.md