Skip to content

Commit 53f12fc

Browse files
committed
added DrString to README
1 parent 7f96b2f commit 53f12fc

2 files changed

Lines changed: 18 additions & 7 deletions

File tree

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# SMF-iOS-CommonProjectSetupFiles
22

3-
[![Language: Swift 3.1](https://img.shields.io/badge/Swift-3.1-orange.svg)](https://swift.org)
4-
[![Xcode: Xcode 8.3.3](https://img.shields.io/badge/Xcode-8.3.3-orange.svg)](https://swift.org)
3+
[![Language: Swift 5.3](https://img.shields.io/badge/Swift-5.2-orange.svg)](https://swift.org)
4+
[![Xcode: Xcode 11.7](https://img.shields.io/badge/Xcode-11.7-orange.svg)](https://developer.apple.com/xcode)
55

66
This Repo contains our common project setup files.
77

@@ -15,6 +15,7 @@ Helpers which can be added manually to the Xcode project which should be used:
1515
Scripts which should be called during the build phase:
1616

1717
- [SwiftLint](#swiftlint)
18+
- [DrSwift](#drswift)
1819
- [Xcode version check](#xcode-version-check)
1920

2021
### Setup
@@ -166,13 +167,13 @@ Multiple `#if canImport(LifetimeTracker)` checks make sure that targets with Lif
166167

167168
Swiftlint is integrated in SMF-iOS-CommonProjectSetupFiles itself. The current version is 0.28.1.
168169

169-
### Integrate it into the project
170+
#### Integrate it into the project
170171

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.**
172173

173174
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`.
174175

175-
#### Excluded files from litting
176+
##### Excluded files from litting
176177

177178
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.
178179

@@ -183,9 +184,19 @@ excluded:
183184
- App/HiDrive/Generated
184185
```
185186

186-
#### Optional: Call the SwiftLint script without using the setup script
187+
##### Optional: Call the SwiftLint script without using the setup script
187188
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.
188189

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+
189200
### Xcode version check
190201

191202
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.

SwiftLint/copy-and-run-swiftlint-config.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/bin/bash
2-
# Copies the Swiflint configuration to the projects base folder
2+
# Copies the Swiftlint configuration to the projects base folder
33
#
44
# Author Hans Seiffert
55
# Updated Kevin Delord

0 commit comments

Comments
 (0)