{"id":13496175,"url":"https://github.com/ruiaureliano/X-SwiftFormat","last_synced_at":"2025-03-28T18:31:50.782Z","repository":{"id":41413481,"uuid":"251015791","full_name":"ruiaureliano/X-SwiftFormat","owner":"ruiaureliano","description":"X-SwiftFormat extension for Xcode","archived":false,"fork":false,"pushed_at":"2024-06-04T14:06:59.000Z","size":214231,"stargazers_count":770,"open_issues_count":2,"forks_count":24,"subscribers_count":15,"default_branch":"main","last_synced_at":"2024-08-01T19:57:49.105Z","etag":null,"topics":["format","swift","xcode"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ruiaureliano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"ruiaureliano"}},"created_at":"2020-03-29T11:27:38.000Z","updated_at":"2024-07-27T05:31:54.000Z","dependencies_parsed_at":"2023-01-21T12:00:09.784Z","dependency_job_id":"6a171a76-27e3-4b49-9382-7096df2be448","html_url":"https://github.com/ruiaureliano/X-SwiftFormat","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruiaureliano%2FX-SwiftFormat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruiaureliano%2FX-SwiftFormat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruiaureliano%2FX-SwiftFormat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruiaureliano%2FX-SwiftFormat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ruiaureliano","download_url":"https://codeload.github.com/ruiaureliano/X-SwiftFormat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222403048,"owners_count":16978782,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["format","swift","xcode"],"created_at":"2024-07-31T19:01:43.387Z","updated_at":"2024-10-31T11:31:05.520Z","avatar_url":"https://github.com/ruiaureliano.png","language":"Swift","funding_links":["https://github.com/sponsors/ruiaureliano"],"categories":["Swift"],"sub_categories":[],"readme":"# 🛠 X-SwiftFormat\n\n[![](https://img.shields.io/badge/MIT-License-0f73b4.svg)](./LICENSE.md) [![](https://img.shields.io/badge/swift-6.0-0f73b4.svg)](https://swift.org/blog/swift-6.0-released/) [![](https://img.shields.io/badge/docs-2.0.1-0f73b4.svg)](./DOCS.md)\n\n![](./assets/readme/xsf-header.png)\n\n## Installation\n\n### Using Github\n\n[![](https://img.shields.io/badge/Download-2.0.1-0f73b4.svg?logo=github)](https://github.com/ruiaureliano/X-SwiftFormat/releases/download/2.0.1/x-swiftformat_2.0.1.zip)\n\n### Using Cask\n\n`brew install --cask x-swiftformat`\n\n## Usage\n\n### 1) Open X-SwiftFormat\n\n**X-SwiftFormat** works as Xcode Extension to format your swift code. You will need to open this once to activate it 👍\n\n![xsf-running-light](./assets/readme/xsf-running-light.png#gh-light-mode-only)\n![xsf-running-light](./assets/readme/xsf-running-dark.png#gh-dark-mode-only)\n\n**a)** You case use the **Preview** to see the format running in the app 💪\n\n![xsf-format-light](./assets/readme/xsf-format-light.png#gh-light-mode-only)\n![xsf-format-light](./assets/readme/xsf-format-dark.png#gh-dark-mode-only)\n\n**b)** You can export a configuration file ( `.swift-format` ) to use later 🖥\n\n### 2) Enable X-SwiftFormat\n\nOpen **System Preferences** ▸ **Privacy \u0026 Security** ▸ **Extensions** ▸ **Xcode Source Editor** and make sure **X-SwiftFormat** is selected ✅\n\n![xsf-extensions-light](./assets/readme/xsf-extensions-light.png#gh-light-mode-only)\n![xsf-extensions-light](./assets/readme/xsf-extensions-dark.png#gh-dark-mode-only)\n\n### 3) Use X-SwiftFormat\n\nOpen Xcode and use the **Format Swift Code** command in Xcode's **Editor** menu 🚀\n\n![xsf-usage-light](./assets/readme/xsf-usage-light.png#gh-light-mode-only)\n![xsf-usage-light](./assets/readme/xsf-usage-dark.png#gh-dark-mode-only)\n\n### 4) Add X-SwiftFormat Shortcut\n\nOpen **System Preferences** ▸ **PKeyboard** ▸ **Keyboard Shortcuts** ▸ **App Shortcuts**, then hit the \u003ckbd\u003e+\u003c/kbd\u003e button. Select **Xcode**, enter `Format Swift Code` and set your **Shortcut**.👏\n\n![xsf-shortcuts-light](./assets/readme/xsf-shortcuts-light.png#gh-light-mode-only)\n![xsf-shortcuts-light](./assets/readme/xsf-shortcuts-dark.png#gh-dark-mode-only)\n\n---\n\n# Installing [Apple Swift Format](https://github.com/apple/swift-format) (Xcode or Mint)\n\n## a) Using Xcode\n\nif you are using **Xcode 15 (Swift 6.0)**, you can check out and build swift-format using the following commands:\n\n```\ngit clone -b release/6.0 https://github.com/apple/swift-format.git\ncd swift-format\nswift build\n```\n\nYou should see this\n\n```\nBuild complete! (50.00s)\n```\n\n👍👍👍\n\n## b) Using Mint\n\nIf you did not have **Homebrew**, install [here](https://brew.sh)\n\n```\nbrew install mint\nmint install apple/swift-format@release/6.0\n```\n\nYou should see this\n\n```\n🌱 Cloning swift-format release/6.0\n🌱 Resolving package\n🌱 Building package\n🌱 Installed swift-format release/6.0\n🌱 Linked swift-format release/6.0\n```\n\n👍👍👍\n\n### Command Line Usage\n\n```\nswift-format -v\n600.0.0\n```\n\n| Command                      | Description                                 |\n| ---------------------------- | ------------------------------------------- |\n| `swift-format swift`         | Display formatted code                      |\n| `swift-format -i file.swift` | Overwrites formatted code                   |\n| `swift-format -r folder`     | Format all files in a folder                |\n| `swift-format -r -i folder`  | Format all files in a folder and overwrites |\n\nCheck more info here: [https://github.com/apple/swift-format](https://github.com/apple/swift-format)\n\n---\n\nI'm [Rui Aureliano](http://ruiaureliano.com), iOS and macOS Engineer at [Olá Brothers](https://theolabrothers.com). We make [Sip](https://sipapp.io) 🤓\n\n[Linkedin](https://www.linkedin.com/in/ruiaureliano) | [Twitter](https://twitter.com/ruiaureliano) | [Github](https://github.com/ruiaureliano) | [Stackoverflow](https://stackoverflow.com/users/881095/ruiaureliano)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruiaureliano%2FX-SwiftFormat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruiaureliano%2FX-SwiftFormat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruiaureliano%2FX-SwiftFormat/lists"}