Swiftpack.co - Package - sersoft-gmbh/app-groups
Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.

App Groups

GitHub release Tests Codacy Badge codecov jazzy

A simple model for accessing app groups.

Installation

Add the following dependency to your Package.swift:

.package(url: "https://github.com/sersoft-gmbh/app-groups.git", from: "1.0.0"),

Or add it via Xcode (as of Xcode 11).

Usage

To use this package, simply create an AppGroup using the identifier of your app group (which you set up in Xcode's capabilities tab):

let appGroup = AppGroup(identifier: "group.your.app.group.identifier")

With that you can access the user defaults or file system:

let userDefaults = appGroup.userDefaults // `nil` if the app group is not valid.
let fileSystem = appGroup.fileSystem // `nil` if the app group is not valid.

The AppGroup.FileSystem object gives access to a few directories that are (usually) created when you access an app group.

Possible Features

While not yet integrated, the following features might provide added value and could make it into this package in the future:

  • Add an AppGroup.Existing model that has non-optional properties to make passing around easier.

Documentation

The API is documented using header doc. If you prefer to view the documentation as a webpage, there is an online version available for you.

Contributing

If you find a bug / like to see a new feature in this package there are a few ways of helping out:

  • If you can fix the bug / implement the feature yourself please do and open a PR.
  • If you know how to code (which you probably do), please add a (failing) test and open a PR. We'll try to get your test green ASAP.
  • If you can do neither, then open an issue. While this might be the easiest way, it will likely take the longest for the bug to be fixed / feature to be implemented.

License

See LICENSE file.

Github

link
Stars: 0

Releases

v1.0.0 - 2021-01-03T15:45:57

Initial Release