This project is a standard Swift package.
The only special thing you might need besides Xcode is swiftformat.
We use it to automatically handle basic formatting and to linting
so the code has a standard style.
Check out the swiftformat Install Guide to add swiftformat to your machine. Once installed, you can autoformat code using the command:
swiftformat .Swiftformat can occasionally poorly resolve a formatting issue (e.g. when you've already line-broken a large comment). Issues like this are typically easy to manually correct.
This package is structured into a few targets. InternalUtils is pretty much what it says. MapLibreSwiftDSL and
MapLibreSwiftUI are published products, and make up the bulk of the project. Finally, Examples is a collection of
SwiftUI previews.
The DSL provides a more Swift-y layer on top of the lower level MapLibre APIs, and features a number of result builders which enable more modern expressive APIs.
The SwiftUI layer publishes a SwiftUI view with the end goal of being a universal view that can be adapted to a wide variety of use cases, much like MapKit's SwiftUI views.
We do not currently have full UI tests. These are a bit tricky due to the async nature of MapLibre and integrating this into an Xcode UI test is challenging. If you have any suggestions, we welcome them!
If you're using this project and want to improve it, send us a PR! We have a checklist in our PR template to help reviews go smoothly.
NOTE: If possible, enable maintainer edits when you open PRs. If your PR is good and just needs a few minor edits to get merged, we can often put those finishing touches on for you. In order to allow maintainer edits, you need to send PRs from a personal fork (org-owned ones have funky auth).