https://github.com/macmade/xcodeformat

https://github.com/macmade/xcodeformat

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/macmade/xcodeformat
• Owner: macmade
• License: mit
• Created: 2022-10-03T15:42:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-24T10:29:30.000Z (over 3 years ago)
• Last Synced: 2025-07-22T21:46:04.840Z (11 months ago)
• Language: Swift
• Size: 3.37 MB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
XcodeFormat

===========

[![Build Status](https://img.shields.io/github/actions/workflow/status/macmade/XcodeFormat/ci-mac.yaml?label=macOS&logo=apple)](https://github.com/macmade/XcodeFormat/actions/workflows/ci-mac.yaml)

[![Issues](http://img.shields.io/github/issues/macmade/XcodeFormat.svg?logo=github)](https://github.com/macmade/XcodeFormat/issues)

![Status](https://img.shields.io/badge/status-active-brightgreen.svg?logo=git)

![License](https://img.shields.io/badge/license-mit-brightgreen.svg?logo=open-source-initiative)  

[![Contact](https://img.shields.io/badge/follow-@macmade-blue.svg?logo=twitter&style=social)](https://twitter.com/macmade)

[![Sponsor](https://img.shields.io/badge/sponsor-macmade-pink.svg?logo=github-sponsors&style=social)](https://github.com/sponsors/macmade)

### How to install

Quit Xcode.

Download the [latest release](https://github.com/macmade/XcodeFormat/releases/latest) and place the `.app` file in your `Applications` folder.  

Launch the application.

Open the `System Preferences`, navigate to the `Keyboard` section, and select `App Shortcuts` in the sidebar:

![Screenshot](Assets/Screenshots/1-Keyboard-Shortcuts.png "Keyboard Shortcuts")

Click the `+` button to add a new shortcut:

![Screenshot](Assets/Screenshots/2-Keyboard-Shortcuts-Add.png "Keyboard Shortcuts - Add")

Choose `Xcode` as application, type `XcodeFormat` in `Menu Title` field, and set the shortcut to `cmd-s`.

From the `System Preferences`, navigate to the `Security & Privacy` section, and select `Accessibility` in the sidebar.  

Add Xcode to the list of applications and ensure the checkbox next to it is selected.

![Screenshot](Assets/Screenshots/3-Security-Accessibility.png "Security Accessibility")

Open Xcode, go the the `Preferences` and navigate to the `Key Bindings` tab.  

Search for `Save`, and choose a different shortcut for the save action (such as `cmd-ctrl-s`):

![Screenshot](Assets/Screenshots/4-Xcode-KeyBindings.png "Xcode KeyBindings")

### How to use

From the `Xcode Format` application (menu bar app), you can create and select different configurations.  

Once a configuration is active, it will be used next time you save a file in Xcode:

![Screenshot](Assets/Screenshots/5-Configurations.png "Configurations")

It is advised to keep this application running (and set it to start at login), as it will periodically update the configuration files from the supplied URLs.

An automator workflow will run every time you use the `cmd-s` shortcut.  

The worklow will trigger the `Editor > Xcode Format Extension > Format Current File` and `File > Save` menu items.

License

-------

Project is released under the terms of the MIT License.

Repository Infos

----------------

    Owner:          Jean-David Gadina - XS-Labs

    Web:            www.xs-labs.com

    Blog:           www.noxeos.com

    Twitter:        @macmade

    GitHub:         github.com/macmade

    LinkedIn:       ch.linkedin.com/in/macmade/

    StackOverflow:  stackoverflow.com/users/182676/macmade