Sake - Swift Make

Sake is a Swift command line tool that helps you automate tasks in your projects. It's heavily inspired by Makefile and Rake.

Motivation 💅

Why automating tasks using shell scripting or Ruby when you can do it in Swift, a language you are already familiar with? Sake aims to provide a command line tool and the foundation to automate your tasks in Swift.

Installation 🥑

You can easily install rake using Homebrew:

brew tap xcodeswift/sake git@github.com:xcodeswift/sake.git
brew install sake

Setup ⚒

Git clone the project git clone git@github.com:xcodeswift/sake.git.
Build swift build.

Sakefile

Sakefile is the file that defines your project tasks:

// Sakefile
import SakefileDescription
import SakefileUtils

enum Task: String, CustomStringConvertible {
  case build
  var description: String {
    switch self {
      case .build:
        return "Builds the project"
    }
  }
}

Sake<Task> {
  $0.task(.build) { (utils) in
    // Here is where you define your build task
  }
}.run()

Usage 👩🏻‍💻

Creating a Sakefile.swift 📝

You can create an empty Sakefile.swift running the following command:

sake init

Working on the Sakefile.swift 💼

You can edit the Sakefile.swift using any text editor. Nonetheless, we recommend you to use Xcode since you'll get syntax highlighting and code autocompletion for free. Sake provides a command to generate the Xcode project where you can edit the Sakefile.swift. You can generate the command by running:

sake generate-xcodeproj

⚠️ Note: Xcode can only run Swift code in a main.swift file. Since the name of the file is Sakefile.swift you'll get some Xcode warnings. Ignore them!

Tasks ✅

Run a task

sake task name_of_the_task

List all the tasks

sake tasks

Sakefile Guidelines 🎨

The Swift code written in the Sakefile.swift file should meet the following guidelines:

It shouldn't fail the execution either using fatalError or force unwrapping nil values. Failing the execution causes the tool to print the stack trace in the console. Instead throw errors that are handled by Sake and nicely printed into th console.
Code should be synchronous and tasks should be completed by the time the closre execution ends.

License

MIT License

Copyright (c) 2017 xcode.swift

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.

rahul-malik / sake