Skip to content

Commit 1bb2cac

Browse files
committed
Version 1.2
1 parent 75f57e2 commit 1bb2cac

27 files changed

+365
-209
lines changed

DOCS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 👨‍🏫 Docs
22

3-
[![](https://img.shields.io/badge/MIT-License-0f73b4.svg)](./LICENSE.md) [![](https://img.shields.io/badge/swift-5.5-0f73b4.svg)](https://swift.org/blog/swift-5-5-released/) [![](https://img.shields.io/badge/docs-1.1.3-0f73b4.svg)](./DOCS.md)
3+
[![](https://img.shields.io/badge/MIT-License-0f73b4.svg)](./LICENSE.md) [![](https://img.shields.io/badge/swift-5.6-0f73b4.svg)](https://swift.org/blog/swift-5-6-released/) [![](https://img.shields.io/badge/docs-1.2-0f73b4.svg)](./DOCS.md)
44

55
![](./assets/readme/xsf_header.png)
66

@@ -25,7 +25,7 @@ X-SwiftFormat is a Xcode Plugin built on top of two cool frameworks:
2525

2626
![](./assets/docs/3.png)
2727

28-
**4)** I will just change two options here, `Line Length = 120` and use `Tabs = 1`. We have more options to change.
28+
**4)** I will just change two options here, `Line Length = 120` and use `Tabs = 1` . We have more options to change.
2929

3030
![](./assets/docs/4.png)
3131

@@ -39,7 +39,7 @@ X-SwiftFormat is a Xcode Plugin built on top of two cool frameworks:
3939
1. `// swift-format-ignore: OrderedImports`
4040
1. `// swift-format-ignore: DoNotUseSemicolons`
4141

42-
Using those rules, imports will not be sorted, the block `[17-23]` will not be formatted and we can use semicolons on the block `[26-30]`.
42+
Using those rules, imports will not be sorted, the block `[17-23]` will not be formatted and we can use semicolons on the block `[26-30]` .
4343

4444
![](./assets/docs/6.png)
4545

LICENSE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# ⚖️ MIT License
22

3-
[![](https://img.shields.io/badge/MIT-License-0f73b4.svg)](https://opensource.org/licenses/MIT) [![](https://img.shields.io/badge/swift-5.5-0f73b4.svg)](https://swift.org/blog/swift-5-5-released/) [![](https://img.shields.io/badge/docs-1.1.3-0f73b4.svg)](./DOCS.md)
3+
[![](https://img.shields.io/badge/MIT-License-0f73b4.svg)](https://opensource.org/licenses/MIT) [![](https://img.shields.io/badge/swift-5.6-0f73b4.svg)](https://swift.org/blog/swift-5-6-released/) [![](https://img.shields.io/badge/docs-1.2-0f73b4.svg)](./DOCS.md)
44

55
![](./assets/readme/xsf_header.png)
66

77
---
88

9-
## Copyright (c) 2020 Rui Aureliano
9+
## Copyright (c) 2022 Rui Aureliano
1010

1111
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:
1212

README.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# 🛠 X-SwiftFormat
22

3-
[![](https://img.shields.io/badge/MIT-License-0f73b4.svg)](./LICENSE.md) [![](https://img.shields.io/badge/swift-5.5-0f73b4.svg)](https://swift.org/blog/swift-5-5-released/) [![](https://img.shields.io/badge/docs-1.1.3-0f73b4.svg)](./DOCS.md)
3+
[![](https://img.shields.io/badge/MIT-License-0f73b4.svg)](./LICENSE.md) [![](https://img.shields.io/badge/swift-5.6-0f73b4.svg)](https://swift.org/blog/swift-5-6-released/) [![](https://img.shields.io/badge/docs-1.2-0f73b4.svg)](./DOCS.md)
44

55
![](./assets/readme/xsf_header.png)
66

77
## Installation
88

99
### Using Github
1010

11-
[![](https://img.shields.io/badge/Download-1.1.3-0f73b4.svg?logo=github)](https://github.com/ruiaureliano/X-SwiftFormat/releases/download/1.1.3/x-swiftformat_1.1.3.zip)
11+
[![](https://img.shields.io/badge/Download-1.2-0f73b4.svg?logo=github)](https://github.com/ruiaureliano/X-SwiftFormat/releases/download/1.2/x-swiftformat_1.2.zip)
1212

1313
### Using Cask
1414

15-
`brew install --cask x-swiftformat`
15+
`brew install --cask x-swiftformat`
1616

1717
## Usage
1818

@@ -26,7 +26,7 @@
2626

2727
![](./assets/readme/xsf_format.png)
2828

29-
**b)** You can export a configuration file (`.swift-format`) to use later 🖥
29+
**b)** You can export a configuration file ( `.swift-format` ) to use later 🖥
3030

3131
### 2) Enable X-SwiftFormat
3232

@@ -51,17 +51,21 @@ Open **System Preferences**, click on **Keyboard** and switch to the **Shortcuts
5151
# Installing [Apple Swift Format](https://github.com/apple/swift-format) (Xcode or Mint)
5252

5353
## a) Using Xcode
54-
if you are using **Xcode 13 (Swift 5.5)**, you can check out and build swift-format using the following commands:
54+
55+
if you are using **Xcode 13.4 (Swift 5.6)**, you can check out and build swift-format using the following commands:
5556

5657
```
57-
git clone -b swift-5.5-branch https://github.com/apple/swift-format.git
58+
git clone -b release/5.6 https://github.com/apple/swift-format.git
5859
cd swift-format
5960
swift build
6061
```
62+
6163
You should see this
64+
6265
```
63-
[207/207] Linking swift-format
66+
Build complete! (51.82s)
6467
```
68+
6569
👍👍👍
6670

6771
## b) Using Mint
@@ -70,31 +74,34 @@ If you dint have **Homebrew**, install [here](https://brew.sh)
7074

7175
```
7276
brew install mint
73-
mint install apple/swift-format@swift-5.5-branch
77+
mint install apple/swift-format@release/5.6
7478
```
79+
7580
You should see this
81+
7682
```
77-
🌱 Cloning swift-format swift-5.5-branch
83+
🌱 Cloning swift-format release/5.6
7884
🌱 Resolving package
7985
🌱 Building package
80-
🌱 Installed swift-format swift-5.5-branch
81-
🌱 Linked swift-format swift-5.5-branch to /usr/local/bin
86+
🌱 Installed swift-format release/5.6
87+
🌱 Linked swift-format release/5.6
8288
```
89+
8390
👍👍👍
8491

8592
### Command Line Usage
8693

8794
```
8895
swift-format -v
89-
0.50300.0
96+
0.50600.1
9097
```
9198

9299
|Command | Description |
93100
|-|-|
94-
|`swift-format swift`|Display formatted code|
95-
|`swift-format -i file.swift`|Overwrites formatted code|
96-
|`swift-format -r folder`|Format all files in a folder|
97-
|`swift-format -r -i folder`|Format all files in a folder and overwrites|
101+
| `swift-format swift` |Display formatted code|
102+
| `swift-format -i file.swift` |Overwrites formatted code|
103+
| `swift-format -r folder` |Format all files in a folder|
104+
| `swift-format -r -i folder` |Format all files in a folder and overwrites|
98105

99106
Check more info here: [https://github.com/apple/swift-format](https://github.com/apple/swift-format)
100107

@@ -103,4 +110,3 @@ Check more info here: [https://github.com/apple/swift-format](https://github.com
103110
I'm [Rui Aureliano](http://ruiaureliano.com), iOS and macOS Engineer at [Olá Brothers](https://theolabrothers.com). We make [Sip](https://sipapp.io) 🤓
104111

105112
[Linkedin](https://www.linkedin.com/in/ruiaureliano) | [AngelList](https://angel.co/ruiaureliano) | [Twitter](https://twitter.com/ruiaureliano) | [Github](https://github.com/ruiaureliano) | [Medium](https://medium.com/@ruiaureliano) | [Stackoverflow](https://stackoverflow.com/users/881095/ruiaureliano)
106-

assets/docs/10.png

154 KB
Loading

assets/docs/3.png

136 KB
Loading

assets/docs/4.png

129 KB
Loading

assets/docs/7.png

140 KB
Loading

assets/docs/9.png

122 KB
Loading

assets/readme/xsf_extensions.png

30.9 KB
Loading

assets/readme/xsf_running.png

18.2 KB
Loading

0 commit comments

Comments
 (0)