SwiftKit

<p align="center"> <img width="750" src="https://raw.githubusercontent.com/SvenTiigi/SwiftKit/gh-pages/readMeAssets/SwiftKit.png" alt="SwiftKit Header Logo"> </p> <p align="center"> <a href="https://developer.apple.com/swift/"> <img src="https://img.shields.io/badge/Swift-5.1-orange.svg?style=flat" alt="Swift 5.1"> </a> <a href="https://github.com/SvenTiigi/SwiftKit/actions?query=workflow%3ACI"> <img src="https://github.com/SvenTiigi/SwiftKit/workflows/CI/badge.svg" alt="CI Status"> </a> <a href="https://github.com/SvenTiigi/SwiftKit/releases"> <img src="https://img.shields.io/github/release/SvenTiigi/SwiftKit.svg" alt="Version"> </a> <a href="https://sventiigi.github.io/SwiftKit"> <img src="https://github.com/SvenTiigi/SwiftKit/blob/gh-pages/badge.svg" alt="Documentation"> </a> <br/> <a href="https://github.com/yonaskolb/Mint"> <img src="https://img.shields.io/badge/Mint-compatible-brightgreen.svg" alt="Mint"> </a> <a href="https://brew.sh"> <img src="https://img.shields.io/badge/Homebrew-compatible-brightgreen.svg" alt="brew"> </a> <a href="https://twitter.com/SvenTiigi/"> <img src="https://img.shields.io/badge/Twitter-@SvenTiigi-blue.svg?style=flat" alt="Twitter"> </a> </p> <br/> <p align="center"> SwiftKit enables you to easily generate a cross platform Swift Framework from your command line.<br/> It is the best way to start your next Open-Source Swift Framework 📦.<br/> SwiftKit is inspired by <a href="https://github.com/JohnSundell/SwiftPlate">SwiftPlate</a> </p> <br/> <p align="center"> <img width="800" src="https://raw.githubusercontent.com/SvenTiigi/SwiftKit/gh-pages/readMeAssets/SwiftKitTerminalDemo.gif" alt="SwiftKit Terminal Demo"> </p>

Features

• [x] Generated Kit supports iOS, tvOS, watchOS and macOS
• [x] CocoaPods, Carthage and Swift Package Manager compatibility
• [x] README.md template
• [x] Fastlane already integrated for tests and release
• [x] Jazzy to generate documentation
• [x] SwiftLint Build-Phase integrated
• [x] CI-Service configuration templates included (GitHub, Travis, GitLab, Azure Pipelines)
• [x] Automatically checks if the Kit name is already taken on CocoaPods
• [x] GitHub issue templates for Bug reports and Feature requests

Installation

Mint 🌱

Mint is a package manager that installs and runs Swift command line tool packages.

$ mint install SvenTiigi/SwiftKit

Homebrew 🍺

Homebrew is a free and open-source software package management system that simplifies the installation of software on Apple's macOS operating system.

$ brew tap SvenTiigi/SwiftKit
$ brew install swiftkit

Update

To update SwiftKit to the latest version simply run:

$ swiftkit update

The update command will only work if SwiftKit is installed either via Mint 🌱 or Homebrew 🍺

Usage 👨‍💻

To create a new Kit simply run:

$ swiftkit new MyAwesomeKit

This will create a new folder in your current directory named by the name of your Kit

To create a Kit inside the current directory simply run:

$ swiftkit new

This will infer the Kit name based on your directory name

If you wish to open the Xcode project after your Kit has been generated simply run:

$ swiftkit new MyAwesomeKit --open

Head over to the Arguments section to learn more about the available arguments

In default SwiftKit will create a Kit that supports iOS, tvOS, watchOS, macOS. If you want to support only certain Targets simply run:

$ swiftkit new MyAwesomeKit --target iOS --target tvOS

This will create a Kit which only supports iOS and tvOS

Kit-Structure 📦

The upcoming sections will explain the structure of your generated Kit in detail.

<img style="float: right" align="right" width="100" src="https://raw.githubusercontent.com/SvenTiigi/SwiftKit/gh-pages/readMeAssets/xcode-logo.png" alt="Xcode Logo">

Xcode Project Structure

In the generated Xcode project you will find four important directories.

| Directory | Description | | --- | --- | | Sources | Where you place your Swift source files | | Tests | Place your Unit-Tests files | | Example | The iOS application example for your Kit | | Configs | All config files like Plist, Package.swift, Podspec, etc. |

<img style="float: right" align="right" width="100" src="https://raw.githubusercontent.com/SvenTiigi/SwiftKit/gh-pages/readMeAssets/swift-file-logo.png" alt="Swift File Logo">

Kit.swift

In the aforementioned Sources directory you will find one Swift file which is named by your Kit.

// Include Foundation
@_exported import Foundation

This file is used to inherit the import of Foundation when importing your Kit.

<a href="https://fastlane.tools/"><img style="float: right" align="right" width="100" src="https://raw.githubusercontent.com/SvenTiigi/SwiftKit/gh-pages/readMeAssets/fastlane-logo.png" alt="Fastlane Logo"></a>

Fastlane

Every generated Kit will come along with a predefined Fastfile.

tests-Lane

The tests lane will run your Unit-Tests.

$ fastlane ios tests

compatibilityTests-Lane

The compatibilityTests lane will verify that your Kit is Carthage, CocoaPods and Swift Package Manager compatible.

$ fastlane ios compatibilityTests

release-lane

The release lane will allow you to automatically release a new version of your Kit.

$ fastlane ios release version:1.1.0

The lane verifies various aspects of your Kit.

| Step | Description | | --- | --- | | 1 | Ensure your are on a clean master branch | | 2 | Run compatibilityTests lane | | 3 | Run tests lane | | 4 | Increment version | | 5 | Add and push Git tag | | 6 | Pushes the Podspec via pod trunk push |

☝️ Please ensure you have registered your machine with pod trunk register in order to successfully push the Podspec to CocoaPods

ReadMe

<img style="float: right;" align="right" src="https://raw.githubusercontent.com/SvenTiigi/SwiftKit/gh-pages/readMeAssets/TemplateReadMe.png" width="30%" alt="Template ReadMe">

A README.md template file will be automatically created inside your Kit.

The README comes along with typical sections like:

<br/>

• Project description
• Example
• Installation
• Usage
• Contributing
• License

<br/>

Please feel free to update the ReadMe to your needs 👍

Environment-Configuration

You can place a JSON environment configuration file in your home directory ~/.swiftkit-env.json to provide default values for:

| Key | Description | | ----------- | ----------- | | authorName | The author name | | authorEmail | The author email address | | organizationName | The organization name | | organizationIdentifier | The organization identifier |

SwiftKit will use those values and skip the corresponding CLI questions when running swiftkit new.

{
    "authorName": "Sven Tiigi",
    "authorEmail": "sven.tiigi@gmail.com",
    "organizationName": "Sven Tiigi",
    "organizationIdentifier": "de.tiigi"   
}

Path: ~/.swiftkit-env.json

The environment config values will only be used if no argument for the corresponding value is present.

Arguments

Beside using the CLI inputs SwiftKit supports arguments when launched. The following arguments are supported:

| Long parameter | Short parameter | Description | ----------- | ----------- | -------------- | | --target | -t | The Target that should be included in your Kit 📱 | | --destination | -d | Where the generated Kit should be saved 💾 | | --kit-name | -k | The name of your Kit 📦 | | --name | -n | Your name 👨‍💻 | | --email | -e | Your email address 📫 | | --url | -u | The repository url 🌎 | | --ci-service | -c | The CI-Service 🛠 <br/> 1 = Travis CI - macOS only <br/> 2 = Travis CI - macOS & Linux <br/> 3 = GitLab CI <br/> 4 = Azure Pipelines <br/> 5 = GitHub CI | | --organization | -o | The name of your organization 🏢 | | --organization-identifier | -i | The organization identifier 🖋 | | --repository | -r | The SwiftKit template repository url 🌎 | | --force | -f | Generate the Kit without confirmation ✅ | | --open | -o | Open the Xcode project after your Kit has been generated 📂 |

Example with all arguments been set.

swiftkit new \
	--target iOS \
	--target tvOS \
	--target watchOS \
	--target macOS \
	--destination ~/Desktop/MyAwesomeKit \
	--kit-name MyAwesomeKit \
	--name SvenTiigi \
	--email sven.tiigi@gmail.com \
	--url https://github.com/SvenTiigi/MyAwesomeKit \
	--ci-service 1 \
	--organization SvenTiigi \
	--organization-identifier com.tiigi \
	--repository https://github.com/SvenTiigi/SwiftKit.git \
	--force \
	--open

Featured on

• Swift Weekly
• iOS Goodies
• Mybridge - Swift Open Source for the Past Month (v.May 2019)

Contributing

Contributions are very welcome 🙌 🤓

Credits

SwiftKit is inspired by [SwiftPlate](https://github.com/JohnSundell/SwiftPlate