Shortcut Foundation

Contains common utility functions and extensions.

Features

[List is not complete]

Dependency Injection

Requirements

iOS 13+
Xcode 11+
Jazzy [sudo] gem install jazzy
Brew /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Make brew install make
Swiftlint brew install swiftlint

Style Guide

Following our style guide should:

Make it easier to read and begin understanding the unfamiliar code.
Make code easier to maintain.
Reduce simple programmer errors.
Reduce cognitive load while coding.
Keep discussions on diffs focused on the code's logic rather than its style.

Note that brevity is not a primary goal.

Official Style Guide

Installation

Using as a dependency

// swift-tools-version:5.1

import PackageDescription

let package = Package(
  name: "YourTestProject",
  dependencies: [
    .package(url: "git@github.com:shortcut/shortcut-foundation-ios.git", from: "1.0.2")
  ],
  targets: [
    .target(name: "YourTestProject", dependencies: ["ShortcutFoundation"])
  ]
)

And then import wherever needed: import ShortcutFoundation

Adding it to an existing iOS Project via Swift Package Manager

Using Xcode 11 or greater go to File > Swift Packages > Add Package Dependency
Paste the project URL: git@github.com:shortcut/shortcut-foundation-ios.git
Click on next and select the project target

If you want to know more, please check the following links:

How to use
Creating Swift Packages

After successfully retrieved the package and added it to your project, just import ShortcutFoundation and you can get the full benefits of it.

Usage example

import ShortcutFoundation

...

Contributing to the library

Clone the repository
Create your feature branch
Open the Package.swift file
Perform your changes, debug, run the unit tests
Make sure that all the tests pass and there are no Xcode warnings or lint issues
Open a pull request

We have added a few helpers to make your life easier:

make build to build the project via command line
make test to test the project via command line
make jazzy to generate the documentation and output to the Docs folder
make lint to execute Swiftlint
make fix-lint to auto-correct Swiftlint warnings

gabrielPeart / shortcut-foundation-ios