0.0.4

.github/pull_request_template.md

@@ -1,28 +1,10 @@
-#### ✨ This PR Will:
-<!--- List new features, improvements, or fixes introduced in this PR. --->
-- <!--- add support for XYZ --->
-- <!--- improved performance of ABC --->
-- <!--- fix issue #123 where XYZ was not working --->
+## What
+<!-- What was changed -->
 
-#### 🎯 Purpose  
-<!--- Explain why this change is needed and what problem it solves. --->
-- <!--- This update enhances user experience by... --->
-- <!--- Fixes a bug that caused... --->
 
-#### 🧪 Unit Tests 
-<!--- Mention if unit tests were added. If not, briefly explain why. ---> 
-- <!--- added unit tests for XYZ functionality. --->
-- <!--- no new tests were needed because... --->
+## Why
+<!-- Why this change was needed -->
 
-#### 📸 Screenshots  
-<!--- Add screenshots or GIFs if relevant. --->
-- <!--- Before / After comparison screenshots --->
 
-#### 💻 Code Snippets  
-<!--- Include important code snippets if needed. --->
-<!--- ```swift --->
-<!--- // Example Swift code snippet --->
-<!--- func exampleFunction() { --->
-<!---     print("Hello, PR!") --->
-<!--- } --->
-<!--- ``` --->
+## Changes
+<!-- List affected files/modules -->

.github/workflows/run_tests.yml

@@ -1,85 +1,14 @@
-# This workflow will test a Swift project
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-swift
-
 name: Package Test
 
-env:
-    EXTRACT_COVERAGE: '.github/scripts/extract_coverage.sh'
-    CREATE_COMMENT: '.github/scripts/create_pr_comment.js'
-    COVERAGE_REPORT_PATH: './coverage/coverage.xcresult'
-    XCODE_VERSION: 'Xcode_16.2.app'
-    XCODE_PATH: '/Applications/Xcode_16.2.app/Contents/Developer'
-    COVERAGE_SUMMARY_FILE: 'pr_coverage_summary.txt'
-    BOT_COMMENT_HEADER: '### 🛡️ Code Coverage Report'
-
 on:
   push:
     branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
 
 jobs:
-  build:
+  coverage:
     runs-on: macos-latest
-
     steps:
-    - uses: actions/checkout@v4
-
-    - name: List Xcode Installations
-      run: sudo ls -1 /Applications | grep "Xcode"
-
-    - name: Select Xcode
-      run: sudo xcode-select -s ${{ env.XCODE_PATH }}
-
-    - name: Run Swift Tests with Coverage
-      run: |
-        swift test --enable-swift-testing --enable-code-coverage
-        CODECOV_PATH=$(swift test --enable-code-coverage --show-codecov-path)
-        echo "CODECOV_PATH=${CODECOV_PATH}" >> $GITHUB_ENV
-
-    - name: Run Coverage Extraction Script
-      run: bash ${{ env.EXTRACT_COVERAGE }}
-
-    - name: Comment on Pull Request
-      if: github.event_name == 'pull_request'
-      uses: actions/github-script@v6
-      with:
-        script: |
-          const fs = require('fs');
-          const coverageOutput = fs.readFileSync('${{ env.COVERAGE_SUMMARY_FILE }}', 'utf8');
-
-          const newComment = `
-          ${{ env.BOT_COMMENT_HEADER }}
-
-          ${coverageOutput}
-
-          _Generated by GitHub Actions._
-          `;
-
-          // Fetch existing comments
-          const comments = await github.rest.issues.listComments({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              issue_number: context.payload.pull_request.number,
-          });
-
-          // Identify and delete previous bot comments
-          const botComments = comments.data.filter(comment =>
-              comment.body.includes("${{ env.BOT_COMMENT_HEADER }}")
-          );
-
-          for (const botComment of botComments) {
-              await github.rest.issues.deleteComment({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              comment_id: botComment.id,
-              });
-          }
-
-          // Create a comment on the pull request
-          await github.rest.issues.createComment({
-              issue_number: context.payload.pull_request.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              body: newComment,
-          });
+      - uses: actions/checkout@v4
+      - uses: Snapp-Mobile/swift-coverage-action@v1.0.1

Package.swift

@@ -1,5 +1,4 @@
 // swift-tools-version: 6.0
-// The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
 
@@ -10,26 +9,29 @@ let package = Package(
         .macOS(.v13),
     ],
     products: [
-        // Products define the executables and libraries a package produces, making them visible to other packages.
         .library(
             name: "SnappThemingSVGSupport",
-            targets: ["SnappThemingSVGSupport"])
+            targets: ["SnappThemingSVGSupport"]
+        ),
+        .executable(
+            name: "ExampleApp",
+            targets: ["ExampleApp"]
+        ),
     ],
     dependencies: [
         .package(url: "https://github.com/SVGKit/SVGKit.git", from: "3.0.0"),
-        .package(url: "https://github.com/Snapp-Mobile/SnappTheming", from: "0.1.2"),
+        .package(url: "https://github.com/Snapp-Mobile/SnappTheming", exact: "0.1.3"),
+        .package(url: "https://github.com/Snapp-Mobile/SwiftFormatLintPlugin.git", exact: "1.0.4"),
     ],
     targets: [
-        // Targets are the basic building blocks of a package, defining a module or a test suite.
-        // Targets can depend on other targets in this package and products from dependencies.
         .target(
             name: "SnappThemingSVGSupport",
             dependencies: [
                 "SVGKit",
                 "SnappTheming",
             ],
             plugins: [
-                .plugin(name: "SnappThemingSVGSupportSwiftFormatPlugin")
+                .plugin(name: "Lint", package: "SwiftFormatLintPlugin")
             ]
         ),
         .testTarget(
@@ -43,11 +45,17 @@ let package = Package(
                 .copy("Resources/images.json")
             ]
         ),
-        .plugin(
-            name: "SnappThemingSVGSupportSwiftFormatPlugin",
-            capability: .buildTool(),
-            path: "Plugins/SnappThemingSVGSupportSwiftFormatPlugin"
+        .executableTarget(
+            name: "ExampleApp",
+            dependencies: [
+                "SnappThemingSVGSupport",
+                "SnappTheming",
+            ],
+            resources: [
+                .copy("ExampleApp/Resources/light.json"),
+                .copy("ExampleApp/Resources/dark.json"),
+                .copy("ExampleApp/Resources/pink.json"),
+            ]
         ),
-
     ]
 )

README.md

@@ -1,15 +1,16 @@
 # SnappThemingSVGSupport
 
 <p align="center">
-    <img src="Sources/SnappThemingSVGSupport/SnappThemingSVGSupport.docc/Resources/logo%402x.png">
+    <img src="Sources/SnappThemingSVGSupport/SnappThemingSVGSupport.docc/Resources/logo.png">
     <br /><br />
     <a href="https://github.com/Snapp-Mobile/SnappThemingSVGSupport/tags" target="_blank"><img src="https://img.shields.io/github/v/tag/Snapp-Mobile/SnappThemingSVGSupport?color=yellow&label=version" alt="Latest Version"></a>
     <a href="https://github.com/Snapp-Mobile/SnappThemingSVGSupport/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Snapp-Mobile/SnappThemingSVGSupport" alt="License Badge"></a>
     <br />
     <a href="https://img.shields.io/badge/swift--tools--version-6.0-red" target="_blank"><img src="https://img.shields.io/badge/swift--tools--version-6.0-red" alt="Swift Tools Version 6.0"></a>
     <a href="https://img.shields.io/badge/Platforms-_iOS_|_macOS_|_tvOS_-green" target="_blank"><img src="https://img.shields.io/badge/Platforms-_iOS_|_macOS_|_tvOS_-green" alt="Supported Platforms"></a>
 <p/>
-`SnappThemingSVGSupport` is a library that enables support for SVG asset handling in `SnappTheming`
+
+This library enables support for SVG asset handling in **SnappTheming**
 
 Enabling the SVG support is as easy as adding one line to your codebase.