Merge pull request #4 from arde02/main

Add Unused Dependencies Check

Author: Nikoloutsos

Plugins/explicitDependencyImportCheckPlugin/ExplicitDependencyImportCheckPlugin.swift

@@ -4,18 +4,30 @@ import PackagePlugin
 @main
 struct ExplicitDependencyImportCheckPlugin: BuildToolPlugin {
     func createBuildCommands(context: PluginContext, target: any Target) async throws -> [Command] {
-        let dependeniesNames = findSpmTargetDependencies(fromTarget: target)
-        let sitrepResponse = try findImportsUsedInCode(context: context, path: target.directory.string)
-        let transitiveDependencies = sitrepResponse.subtracting(dependeniesNames)
-        let transitiveDependenciesWithoutCommon = transitiveDependencies.subtracting(systemLibraries)
-        guard transitiveDependenciesWithoutCommon.isEmpty == false else { return [] }
-        return [
-            try exportTransitiveDependenciesAsErrors(
-                transitiveDeps: transitiveDependenciesWithoutCommon,
-                forTarget: target,
-                inContext: context
-            )
-        ]
+        let targetDependencies = findSpmTargetDependencies(fromTarget: target)
+        let importsInCode = try findImportsUsedInCode(context: context, path: target.directory.string)
+        let transitiveDependencies = findTransitiveDependencies(imports: importsInCode, targetDependencies: targetDependencies)
+        let unusedTargetDependencies = findUnusedTargetDependencies(imports: importsInCode, targetDependencies: targetDependencies)
+
+        return (try exportTransitiveDependenciesAsErrors(
+                   transitiveDeps: transitiveDependencies,
+                   forTarget: target,
+                   inContext: context
+                )) +
+                (try exportUnusedDependenciesAsWarnings(
+                   unusedDependencies: unusedTargetDependencies,
+                   forTarget: target,
+                   inContext: context
+                ))
+    }
+
+    func findTransitiveDependencies(imports: Set<String>, targetDependencies: Set<String>) -> Set<String> {
+        return imports.subtracting(targetDependencies)
+                      .subtracting(systemLibraries)
+    }
+
+    func findUnusedTargetDependencies(imports: Set<String>, targetDependencies: Set<String>) -> Set<String> {
+        return targetDependencies.subtracting(imports)
     }
 }
 
@@ -25,20 +37,40 @@ extension ExplicitDependencyImportCheckPlugin {
         transitiveDeps: Set<String>,
         forTarget target: Target,
         inContext context: PluginContext
-    ) throws -> Command {
-        var transitiveDependenciesErrorText = "error: \(transitiveDeps.count) Transitive dependencies found for \(target.name) 🚨🚨🚨"
-        for transitiveDep in transitiveDeps {
-            transitiveDependenciesErrorText += "\n"
-            transitiveDependenciesErrorText += "👉 \(transitiveDep) is a transitive dependency"
-        }
+    ) throws -> [Command] {
+        guard !transitiveDeps.isEmpty else { return [] }
+
+        var transitiveDependenciesErrorText = "error: \(transitiveDeps.count) Transitive dependencies found for \(target.name) 🚨🚨🚨\n"
+        transitiveDependenciesErrorText += transitiveDeps.map { "👉 \($0) is a transitive dependency" }
+                                                         .joined(separator: "\n")
+
         let echoTool = try context.tool(named: "echo")
-        return .buildCommand(
+        return [.buildCommand(
             displayName: "Transitive Dependencies Report",
             executable: echoTool.path,
             arguments: [transitiveDependenciesErrorText],
             environment: [:]
-       )
-        
+       )]
+    }
+
+    func exportUnusedDependenciesAsWarnings(
+        unusedDependencies: Set<String>,
+        forTarget target: Target,
+        inContext context: PluginContext
+    ) throws -> [Command] {
+        guard !unusedDependencies.isEmpty else { return [] }
+
+        var warningText = "warning: \(unusedDependencies.count) Extraneous dependencies found for \(target.name) ⚠️⚠️\n"
+        warningText += unusedDependencies.map { "👉 \($0) is an extraneous dependency" }
+                                         .joined(separator: "\n")
+
+        let echoTool = try context.tool(named: "echo")
+        return [.buildCommand(
+            displayName: "Extraneous Dependencies Report",
+            executable: echoTool.path,
+            arguments: [warningText],
+            environment: [:]
+        )]
     }
 }
 

README.md

@@ -2,9 +2,12 @@
 
 **explicitDependencyImportCheck** is a Swift build plugin designed to help you enforce clean dependency management by ensuring that only explicitly declared dependencies are imported. Transitive dependencies can cause a range of problems, from bloated builds to fragile code. Swift provides the `--explicit-target-dependency-import-check` flag for this purpose, but it doesn’t work consistently with **XcodeBuild** – and that’s where this plugin steps in! 🚀
 
+This plugin also helps identify module dependencies that are unused and that can be removed from your Package.swift to speed up your builds even more! 
+
 ## 🌟 Features
 
 - **No More Transitive Dependencies**: Catch unwanted transitive imports and keep your code cleaner, faster, and more modular.
+- **No More Unused Dependencies**: Catch dependencies to modules that are unused and unnecessary.
 - **Swift Build Plugin**: Runs automatically during the Swift build process.
 - **Easy Integration**: Just add it to your project to start using!