Merge pull request #114 from smartmobilefactory/drstring-integration

Drstring integration

Author: Tomusm

DrString/copy-and-run-DrString-config.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+# Copies the DrString configuration to the projects base folder
+#
+# Author Pierre Rothmaler
+#
+# Last revised 23/09/2020
+
+#
+# Constants
+#
+
+readonly scriptBaseFolderPath="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+#
+# Variables
+#
+
+projectDir="$1"
+
+#
+# Check requirements
+#
+
+# Check if project directory is provided. If not: Use the scripts base directory.
+if [  -z "$1" ]; then
+	projectDir="$scriptBaseFolderPath"
+fi
+
+#
+# Logic
+#
+
+# Go the folder which contains this script
+cd "$scriptBaseFolderPath"
+
+# Copy the DrString file to the projects base folder
+cp "drstring.toml" "$projectDir/.drstring.toml"
+
+# Go to the project folder and run DrString from there
+cd "$projectDir"
+
+DRSTRING_EXECUTABLE="$scriptBaseFolderPath/drstring"
+
+if [ -f "$DRSTRING_EXECUTABLE" ]; then
+	"$DRSTRING_EXECUTABLE" check --config-file $projectDir/.drstring.toml || true
+else
+	echo "warning: DrString not installed."
+	exit 1
+fi

DrString/drstring

@@ -0,0 +1,6 @@
+include = [
+    'Core/**/*.swift',
+]
+
+ignore-throws = true
+ignore-returns = true

DrString/drstring.toml

@@ -1,7 +1,7 @@
 # SMF-iOS-CommonProjectSetupFiles
 
-[![Language: Swift 3.1](https://img.shields.io/badge/Swift-3.1-orange.svg)](https://swift.org)
-[![Xcode: Xcode 8.3.3](https://img.shields.io/badge/Xcode-8.3.3-orange.svg)](https://swift.org)
+[![Language: Swift 5.3](https://img.shields.io/badge/Swift-5.2-orange.svg)](https://swift.org)
+[![Xcode: Xcode 11.7](https://img.shields.io/badge/Xcode-11.7-orange.svg)](https://developer.apple.com/xcode)
 
 This Repo contains our common project setup files.
 
@@ -15,6 +15,7 @@ Helpers which can be added manually to the Xcode project which should be used:
 Scripts which should be called during the build phase:
 
 - [SwiftLint](#swiftlint)
+- [DrSwift](#drswift)
 - [Xcode version check](#xcode-version-check)
 
 ### Setup
@@ -166,13 +167,13 @@ Multiple `#if canImport(LifetimeTracker)` checks make sure that targets with Lif
 
 Swiftlint is integrated in SMF-iOS-CommonProjectSetupFiles itself. The current version is 0.28.1.
 
-### Integrate it into the project
+#### Integrate it into the project
 
-**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.**
+**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.**
 
 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`.
 
-#### Excluded files from litting
+##### Excluded files from litting
 
 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.
 
@@ -183,9 +184,19 @@ excluded:
 - App/HiDrive/Generated
 ```
 
-#### Optional: Call the SwiftLint script without using the setup script
+##### Optional: Call the SwiftLint script without using the setup script
 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.
 
+### DrSwift
+
+[DrSwift](https://github.com/dduan/DrString) is integrated in SMF-iOS-CommonProjectSetupFiles itself. The current version is 0.4.2.
+
+#### Integrate it into the project
+
+DrString is configured to run when you execute `Submodules/SMF-iOS-CommonProjectSetupFiles/setup-common-project-files.sh` with [framework target configuration](#setup) parameters.
+
+**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.**
+
 ### Xcode version check
 
 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.

README.md

@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copies the Swiflint configuration to the projects base folder
+# Copies the Swiftlint configuration to the projects base folder
 #
 # Author Hans Seiffert
 # Updated Kevin Delord

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

@@ -130,6 +130,10 @@ if [ $callSwiftlint = true ]; then
 	./SwiftLint/copy-and-run-swiftlint-config.sh "$projectDir" $isFramework $isSwiftUIProject || exit 1;
 fi
 
+if [ $isFramework = true ]; then
+	./DrString/copy-and-run-DrString-config.sh "$projectDir" || exit 1;
+fi
+
 if [ $copyPRTemplate = true ]; then
 
 	mkdir -p "$projectDir/.github"