You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This Repo contains our common project setup files.
7
7
@@ -15,6 +15,7 @@ Helpers which can be added manually to the Xcode project which should be used:
15
15
Scripts which should be called during the build phase:
16
16
17
17
-[SwiftLint](#swiftlint)
18
+
-[DrSwift](#drswift)
18
19
-[Xcode version check](#xcode-version-check)
19
20
20
21
### Setup
@@ -166,13 +167,13 @@ Multiple `#if canImport(LifetimeTracker)` checks make sure that targets with Lif
166
167
167
168
Swiftlint is integrated in SMF-iOS-CommonProjectSetupFiles itself. The current version is 0.28.1.
168
169
169
-
### Integrate it into the project
170
+
####Integrate it into the project
170
171
171
-
**Make sure that `/.swiftlint.yml` is added to the gitignore file as the this default SwiftLint configuration file be automatically copied from the repo into the projects base folder.**
172
+
**Make sure that `/.swiftlint.yml` is added to the gitignore file as the default SwiftLint configuration file be automatically copied from the repo into the projects base folder.**
172
173
173
174
The Swiftlint configuration and lint call is integrated in the [setup script](#setup). If it shouldn't be used you can pass the flag `--no-swiftlint`.
174
175
175
-
#### Excluded files from litting
176
+
#####Excluded files from litting
176
177
177
178
You can declare excluded paths in the project specific swiftlint configuration file `.project-swiftlint.yml`. The file has to be placed in the same directoy as the copied `.swiftlint.yml` (usually the project root directory). The scripts *setup-common-project-files.sh* and *copy-and-run-swiftlint-config.sh* are automatically using the `.project-swiftlint.yml` file if it exists.
178
179
@@ -183,9 +184,19 @@ excluded:
183
184
- App/HiDrive/Generated
184
185
```
185
186
186
-
#### Optional: Call the SwiftLint script without using the setup script
187
+
#####Optional: Call the SwiftLint script without using the setup script
187
188
If you want to copy the SwiftLint configuration and lint the code without integrating the setup script you can call `Submodules/SMF-iOS-CommonProjectSetupFiles/SwiftLint/copy-and-run-swiftlint-config.sh` directly.
188
189
190
+
### DrSwift
191
+
192
+
[DrSwift](https://github.com/dduan/DrString) is integrated in SMF-iOS-CommonProjectSetupFiles itself. The current version is 0.4.2.
193
+
194
+
#### Integrate it into the project
195
+
196
+
DrString is configured to run when you execute `Submodules/SMF-iOS-CommonProjectSetupFiles/setup-common-project-files.sh` with [framework target configuration](#setup) parameters.
197
+
198
+
**Make sure that `/.drstring.toml` is added to the gitignore file as the DrSwift configuration file be automatically copied from the repo into the projects base folder.**
199
+
189
200
### Xcode version check
190
201
191
202
Building a project will trigger a Xcode version check to ensure you are working with the right Xcode version and an updated `smf.properties`. This script will look for the Xcode version specified in `smf.properties`. It will compare it to the Xcode version you are currently building the project and throw an error if it does not match.
0 commit comments