ruiaureliano / X-SwiftFormat

X-SwiftFormat extension for Xcode

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

πŸ›  X-SwiftFormat

Installation

Using Github

Using Cask

brew install --cask x-swiftformat

Usage

1) Open X-SwiftFormat

X-SwiftFormat works as Xcode Extension to format your swift code. You will need to open this once to activate it πŸ‘

xsf-running-light xsf-running-light

a) You case use the Preview to see the format running in the app πŸ’ͺ

xsf-format-light xsf-format-light

b) You can export a configuration file ( .swift-format ) to use later πŸ–₯

2) Enable X-SwiftFormat

Open System Preferences β–Έ Privacy & Security β–Έ Extensions β–Έ Xcode Source Editor and make sure X-SwiftFormat is selected βœ…

xsf-extensions-light xsf-extensions-light

3) Use X-SwiftFormat

Open Xcode and use the Format Swift Code command in Xcode's Editor menu πŸš€

xsf-usage-light xsf-usage-light

4) Add X-SwiftFormat Shortcut

Open System Preferences β–Έ PKeyboard β–Έ Keyboard Shortcuts β–Έ App Shortcuts, then hit the + button. Select Xcode, enter Format Swift Code and set your Shortcut.πŸ‘

xsf-shortcuts-light xsf-shortcuts-light


Installing Apple Swift Format (Xcode or Mint)

a) Using Xcode

if you are using Xcode 15 (Swift 6.0), you can check out and build swift-format using the following commands:

git clone -b release/6.0 https://github.com/apple/swift-format.git
cd swift-format
swift build

You should see this

Build complete! (50.00s)

πŸ‘πŸ‘πŸ‘

b) Using Mint

If you did not have Homebrew, install here

brew install mint
mint install apple/swift-format@release/6.0

You should see this

🌱 Cloning swift-format release/6.0
🌱 Resolving package
🌱 Building package
🌱 Installed swift-format release/6.0
🌱 Linked swift-format release/6.0

πŸ‘πŸ‘πŸ‘

Command Line Usage

swift-format -v
600.0.0
Command Description
swift-format swift Display formatted code
swift-format -i file.swift Overwrites formatted code
swift-format -r folder Format all files in a folder
swift-format -r -i folder Format all files in a folder and overwrites

Check more info here: https://github.com/apple/swift-format


I'm Rui Aureliano, iOS and macOS Engineer at OlΓ‘ Brothers. We make Sip πŸ€“

Linkedin | Twitter | Github | Stackoverflow

About

X-SwiftFormat extension for Xcode

License:Other


Languages

Language:Swift 99.4%Language:Shell 0.6%