Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nmdias/infokit
Strongly Typed access to the Info.plist for iOS, macOS and tvOS.
https://github.com/nmdias/infokit
ios macos plist plist-files swift swift4 tvos
Last synced: 5 days ago
JSON representation
Strongly Typed access to the Info.plist for iOS, macOS and tvOS.
- Host: GitHub
- URL: https://github.com/nmdias/infokit
- Owner: nmdias
- License: mit
- Created: 2017-09-24T12:57:17.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-11T07:41:41.000Z (over 5 years ago)
- Last Synced: 2024-11-24T01:52:28.414Z (29 days ago)
- Topics: ios, macos, plist, plist-files, swift, swift4, tvos
- Language: Swift
- Homepage:
- Size: 40 KB
- Stars: 280
- Watchers: 1
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://cocoapods.org/pods/InfoKit)
[](https://github.com/Carthage/Carthage)
[](https://swift.org)
[](https://github.com/nmdias/InfoKit/releases)
[įŽäŊä¸æ](README.zh-CN.md)
InfoKit provides **Strongly Typed** access to the **Info.plist** with less than 60 lines of code, while leveraging **Swift 4**'s powerful [Codable](https://developer.apple.com/documentation/swift/codable) capabilities.
Installation >> [`instructions`](https://github.com/nmdias/InfoKit/blob/master/INSTALL.md) <<
## Usage
Define a [Codable](https://developer.apple.com/documentation/swift/codable) with the properties you wish to access from the project's bundle **Info.plist** file.
```swift
struct Info: Codable {
let baseUrl: String
let staticUrl: String
}
```
And read the Info.plist into the `Info` struct:
```swift
// Define a Plist
let plist = Plist()
// Decode it
let info = plist.decode()
// Then access it's properties
info?.baseUrl // http://debug.InfoKit.local
info?.staticUrl // http://debug.static.InfoKit.local
```
### Custom .plist
For convenience, `InfoKit` will also provide access to custom .plist files. Let's say you included a **ProductIDs.plist** file. Start by defining the struct with it's respective properties.
```swift
struct Products: Codable {
let foo: String
let bar: String
}
```
Define a `Plist`, and this time, **specify the resource name**. e.g. `ProductIDs`
```swift
let plist = Plist("ProductIDs") // Reads `ProductIDs.plist`
let products = plist.decode()
products?.foo // com.InfoKit.foo
products?.bar // com.InfoKit.bar
```
> Remember, user provided property lists must be copied into the bundle, so make sure to set it's `Target Membership`.
### Specify a Bundle
InfoKit will default to the [Main Bundle](https://developer.apple.com/documentation/foundation/bundle/1410786-main), however, you can **specify the bundle**, if needed:
```swift
Plist("ProductIDs", in: bundle)
```
### Build Configurations
If **no resource or bundle is specified** in the initializer of the `Plist` class, like so:
```swift
Plist()
```
...then, `InfoKit` will default to the Main Bundle's Info.plist file defined in the Project's Build Settings.
Because of this, you can provide **multiple Info.plist** files for **different configurations** and still get the desired results.
See the iOS Example project in action by choosing between the **debug**, **staging** and **release** configurations.
## License
InfoKit is released under the MIT license. See [LICENSE](https://github.com/nmdias/InfoKit/blob/master/LICENSE) for details.
### Help Wanted
#### Review/Translate [README.zh-CN.md](README.zh-CN.md) to Chinese
Chinese is the #1 spoken language in the world and I'd love to have InfoKit be more inclusive, unfortunately I don't speak Chinese. If you know chinese, and would like to help out, please see [issue #1](https://github.com/nmdias/InfoKit/issues/1)
Thank you đ