SwiftKit enables you to easily generate a cross platform Swift Framework from your command line.
It is the best way to start your next Open-Source Swift Framework
SwiftKit is inspired by SwiftPlate
- Generated Kit supports
Swift Package Managercompatibility
- Fastlane already integrated for
Jazzyto generate documentation
CI-Serviceconfiguration templates included (Travis, GitLab)
- Automatically checks if the Kit name is already taken on
Mint is a package manager that installs and runs Swift command line tool packages.
$ mint install SvenTiigi/SwiftKit
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
To update SwiftKit to the latest version simply run:
$ swiftkit update
updatecommand will only work if SwiftKit is installed via either Mint
🌱or Homebrew 🍺
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
Argumentssection to learn more about the available arguments
In default SwiftKit will create a Kit that supports
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
The upcoming sections will explain the structure of your generated Kit in detail.
Xcode Project Structure
In the generated Xcode project you will find four important directories.
||Where you place your Swift source files|
||Place your Unit-Tests files|
||The iOS application example for your Kit|
||All config files like Plist, Package.swift, Podspec, etc.|
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
Foundationwhen importing your Kit.
Every generated Kit will come along with a predefined
tests lane will run your Unit-Tests and verify that your Kit is
$ fastlane ios tests
release lane will allow you to automatically release a new version of your Kit for
$ fastlane ios release version:1.1.0
The lane verifies various aspects of your Kit.
|1||Ensure your are on a clean master branch|
|4||Add and push Git tag|
|5||Pushes the Podspec via
☝️Please ensure you have registered your machine with
pod trunk registerin order to successfully push the Podspec to CocoaPods
README.md template will be automatically created inside your Kit. It contains default sections like
Usage. Please feel free to update the ReadMe to your needs.
SwiftKit supports arguments when launched. Following arguments are supported:
|Long parameter||Short parameter||Description|
||The Target that should be included in your Kit
||Where the generated Kit should be saved
||The name of your Kit
||Your email address
||The repository url
||The name of your organization
||The organization identifier
||Generate the Kit without confirmation
||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 email@example.com \ --url https://github.com/SvenTiigi/MyAwesomeKit \ --ci-service 1 \ --organization SvenTiigi \ --organization-identifier de.tiigi \ --force \ --open
Contributions are very welcome
SwiftKit Copyright (c) 2019 Sven Tiigi <firstname.lastname@example.org> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.