swiftformat-cli

Note: This repository is now archived and will no longer be maintained. I use Mise to manage tools like SwiftFormat now instead.

A script you can include in your projects that allows all team members to run the same version of SwiftFormat, without needing a package manager or building SwiftFormat from source.

Install

curl -Ls "https://raw.githubusercontent.com/lordcodes/swiftformat-cli/main/scripts/install.sh" | bash

Usage

./swiftformat.sh ARGUMENTS

Pass the same arguments you would have passed to SwiftFormat to the script instead, such as:

./swiftformat.sh . --report swiftformat.json

To update SwiftFormat, simple change the value for 'VERSION' at the top of the script.

How it works

You keep the script swiftformat.sh in your project such as in BuildTools/swiftformat.sh. You then call the shell script instead of the swiftformat executable and pass the same arguments you would have passed. The script downloads swiftformat as a binary and tells MacOS to let you execute it (will ask for your password to run this as sudo).

Benefits

• It will download the version specified in the script, so all team members and CI will be using the same version.
• The process is faster than running via SPM as it won't need to build SwiftFormat from source and retrieve all its build dependencies.
• It is versioned unlike using Homebrew.
• Xcode Command Plugins can only be ran from a CLI with pure-SPM projects.
• It is incredibly simple and requires just a single script in your project.
• If you use fastlane you can create a simple lane in Fastfile to run the script.

Fastlane

If you are a Fastlane user, you can add lanes as below to run SwiftFormat in Lint or Format mode across the whole project.

The below snippets use the environment variable BUILD_ARTIFACT_DIR for the output report location. This can be replaced with your preferred output location, or you could set it up in before_all such as using:

before_all do
    if Helper.ci?
        ENV["BUILD_ARTIFACT_DIR"] = Pathname.new(ENV["BITRISE_DEPLOY_DIR"]).to_s
    else
        ENV["BUILD_ARTIFACT_DIR"] = ("fastlane/output").to_s
    end
    sh("cd ../ && mkdir -p #{ENV["BUILD_ARTIFACT_DIR"]}")
end

The snippets also use a small Fastlane helper function to print a clickable file link in the console to the output report.

def output_directory_absolute_file_url
    directory = ENV["BUILD_ARTIFACT_DIR"].delete_prefix("fastlane/")
    absolute_path = File.expand_path(directory)
    "file://#{absolute_path}"
end

Format

desc "Run SwiftFormat in Format mode"
lane :format do
    begin
        sh("cd ../ && ./BuildTools/swiftformat.sh . --report #{ENV["BUILD_ARTIFACT_DIR"]}/swiftformat.json")
    rescue => ex
        UI.error("SwiftFormat failed")
        UI.error(ex)
        UI.error("#{output_directory_absolute_file_url}/swiftformat.json")
    end
end

Lint

desc "Run SwiftFormat in Lint mode"
lane :lint do
    begin
        sh("cd ../ && ./BuildTools/swiftformat.sh . --lint --report #{ENV["BUILD_ARTIFACT_DIR"]}/swiftformat.json")
    rescue => ex
        UI.error("SwiftFormat failed")
        UI.error(ex)
        UI.error("#{output_directory_absolute_file_url}/swiftformat.json")
    end
end