Enable customization of arguments in Xcode package plugin #149

dfed · 2025-01-16T17:24:32Z

Also enable the Xcode package plugin to run a Release binary.

Addresses #147

Also enable the Xcode package plugin to run a Release binary. WIP. Still needs documentation.

Plugins/Shared.swift

codecov · 2025-01-16T19:04:13Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.91%. Comparing base (9f91eb3) to head (192a418).
Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #149   +/-   ##
=======================================
  Coverage   99.91%   99.91%           
=======================================
  Files          32       32           
  Lines        3467     3485   +18     
=======================================
+ Hits         3464     3482   +18     
  Misses          3        3

Files with missing lines	Coverage Δ
Sources/SafeDITool/SafeDITool.swift	`99.61% <100.00%> (+0.02%)`	⬆️

dfed · 2025-01-16T21:40:50Z

Plugins/InstallSafeDITool/InstallCLIPluginCommand.swift

+            // Force the command to wait until the async work is done.
+            dispatchGroup.wait()


this is nuts, but since the method is not async (unlike the plugin for Package.swift files), we have to pull this trick to ensure that the main method here only exits after all our work is done.

dfed · 2025-01-16T21:42:21Z

Plugins/InstallSafeDITool/InstallCLIPluginCommand.swift

+        func performCommand(
+            context: XcodeProjectPlugin.XcodePluginContext,
+            arguments _: [String]
+        ) throws {


this is quite similar to the above func performCommand(context: PackagePlugin.PluginContext, arguments _: [String]) async throws, except our context is different and we aren't async.

dfed · 2025-01-16T21:42:58Z

Plugins/InstallSafeDITool/Shared.swift

@@ -0,0 +1 @@
+../Shared.swift


this is how I'm sharing code between Plugins, which can't have shared dependencies.

dfed · 2025-01-16T21:44:39Z

Plugins/SafeDIGenerator/SafeDIGenerateDependencyTree.swift

-        if context.hasSafeDIFolder, let safeDIVersion, downloadedToolLocation == nil {
-            Diagnostics.error("""
-            \(context.safediFolder.path()) exists, but contains no SafeDITool binary for version \(safeDIVersion).
-
-            To install the release SafeDITool binary for version \(safeDIVersion), run:
-            \tswift package --package-path \(context.package.directoryURL.path()) --allow-network-connections all --allow-writing-to-package-directory safedi-release-install
-
-            To use a debug SafeDITool binary instead, remove previous installs by running:
-            \trm -rf \(context.safediFolder.path())
-            """)


we used to error if you previously installed the release version and then changed versions. I'm deleting that code path because:

I'm not convinced it's super helpful. We still have the warnings

It's harder (not impossible) to tell whether the folder exists because we've downloaded a release binary in the past now that we're reusing this folder for configuration setting

dfed · 2025-01-16T21:45:37Z

Examples/ExampleMultiProjectIntegration/.safedi/configuration/include.csv

@@ -0,0 +1 @@
+Subproject


Examples/ExampleMultiProjectIntegration/ExampleMultiProjectIntegration is already scanned because it's the root module. We just need to list the paths to the other module(s) in this file.

dfed · 2025-01-16T21:46:16Z

Examples/ExampleMultiProjectIntegration/ExampleMultiProjectIntegration/SafeDI.swift

-// This file was generated by the SafeDIGenerateDependencyTree build tool plugin.
-// Any modifications made to this file will be overwritten on subsequent builds.
-// Please refrain from editing this file directly.


this file is now in derived data! much nicer

dfed · 2025-01-16T21:48:14Z

...ples/ExampleMultiProjectIntegration/ExampleMultiProjectIntegration.xcodeproj/project.pbxproj

@@ -321,6 +294,10 @@
 			target = 3289B4002BF955710053F2E4 /* Subproject */;
 			targetProxy = 3289B4052BF955720053F2E4 /* PBXContainerItemProxy */;
 		};
+		32B72E1D2D39765B00F5EB6F /* PBXTargetDependency */ = {
+			isa = PBXTargetDependency;
+			productRef = 32B72E1C2D39765B00F5EB6F /* SafeDIGenerator */;


we're now using the plugin instead of a build script phase

dfed · 2025-01-16T21:50:08Z

Plugins/InstallSafeDITool/InstallCLIPluginCommand.swift

-            // As of Xcode 16.0 Beta 6, the display version is of the form "Optional(version)".
-            // This regular expression is duplicated by SafeDIGenerateDependencyTree since plugins can not share code.
-            guard let versionMatch = try /Optional\((.*?)\)|^(.*?)$/.firstMatch(in: displayVersion),
-                  let versionSubstring = versionMatch.output.1 ?? versionMatch.output.2
-            else {
-                Diagnostics.error("Could not extract version for SafeDI")
-                exit(1)
-            }
-            let version = String(versionSubstring)
-            let safediFolder = context.package.directoryURL.appending(
-                component: ".safedi"
-            )
-            let expectedToolFolder = safediFolder.appending(
-                component: version
-            )
-            let expectedToolLocation = expectedToolFolder.appending(component: "safeditool")


this code is mostly in Shared.swift now

dfed · 2025-01-16T21:52:23Z

Plugins/SafeDIGenerator/SafeDIGenerateDependencyTree.swift

-    fileprivate func write(toPath filePath: String) throws {
-        #if os(Linux)
-            try write(to: URL(fileURLWithPath: filePath))
-        #else
-            guard #available(macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0, *) else {
-                try write(to: URL(fileURLWithPath: filePath))
-            }
-            try write(to: URL(filePath: filePath))
-        #endif
-    }


no longer used

dfed · 2025-01-16T21:52:38Z

Plugins/SafeDIGenerator/SafeDIGenerateDependencyTree.swift

-    }
-}
-
-extension PackagePlugin.PluginContext {


the below was moved to Shared.swift

dfed · 2025-01-16T21:53:18Z

Sources/SafeDITool/SafeDITool.swift

-    @Option(help: "The desired output location of a file a SafeDI representation of this module. Only include this option when running on a project‘s non-root module. Must have a `.safedi` suffix") var moduleInfoOutput: String?
+    @Option(help: "A path to a CSV file comprising the names of modules to import in the generated dependency tree. This list is in addition to the import statements found in files that declare @Instantiable types.") var additionalImportedModulesFilePath: String?
+
+    @Option(help: "The desired output location of a file a SafeDI representation of this module. Only include this option when running on a project‘s non-root module. Must have a `.safedi` suffix.") var moduleInfoOutput: String?


just added a trailing . to the comment here

…nfiguration

dfed · 2025-01-17T01:10:45Z

Going to merge this and release a 1.1.0-beta-1 release so it can be tested. @pouyayarandi can you adopt and lmk if it works well for you before I release the version to all?

pouyayarandi · 2025-01-17T07:54:01Z

I just tested both include.csv and additionalImportedModules.csv, everything's work smoothly 🔥

dfed · 2025-01-17T08:01:23Z

Incredible! Will release the 1.1.0 within a few days then. Thank you for the feedback that led to this improvement, and for testing SafeDI 😄

Enable customization of arguments in Xcode package plugin

02aef90

Also enable the Xcode package plugin to run a Release binary. WIP. Still needs documentation.

dfed self-assigned this Jan 16, 2025

some documentation

d0585c8

dfed commented Jan 16, 2025

View reviewed changes

Plugins/Shared.swift Outdated Show resolved Hide resolved

dfed added 7 commits January 16, 2025 11:17

Test empty csv files

c4c9f72

Increase coverage

0ed0596

Bump version

c379393

less whitespace

f7d2105

update documentation

cd73edc

typos

6427eeb

simpler check

d221af3

dfed commented Jan 16, 2025

View reviewed changes

clearer comment

1197683

dfed commented Jan 16, 2025

View reviewed changes

dfed marked this pull request as ready for review January 16, 2025 21:57

Merge remote-tracking branch 'origin/HEAD' into dfed--xcode-plugin-co…

76957ac

…nfiguration

Set version to 1.1.0-beta-1

192a418

dfed force-pushed the dfed--xcode-plugin-configuration branch from 1f882cd to 192a418 Compare January 17, 2025 01:12

dfed merged commit d78a03d into main Jan 17, 2025
18 checks passed

dfed deleted the dfed--xcode-plugin-configuration branch January 17, 2025 01:15

dfed restored the dfed--xcode-plugin-configuration branch January 17, 2025 01:15

dfed deleted the dfed--xcode-plugin-configuration branch January 17, 2025 03:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable customization of arguments in Xcode package plugin #149

Enable customization of arguments in Xcode package plugin #149

dfed commented Jan 16, 2025 •

edited

Loading

codecov bot commented Jan 16, 2025 •

edited

Loading

dfed Jan 16, 2025

dfed Jan 16, 2025

dfed Jan 16, 2025

dfed Jan 16, 2025

dfed Jan 16, 2025

dfed Jan 16, 2025

dfed Jan 16, 2025

dfed Jan 16, 2025

dfed Jan 16, 2025

dfed Jan 16, 2025

dfed Jan 16, 2025

dfed commented Jan 17, 2025

pouyayarandi commented Jan 17, 2025

dfed commented Jan 17, 2025 •

edited

Loading

		// Force the command to wait until the async work is done.
		dispatchGroup.wait()

		@@ -0,0 +1 @@
		../Shared.swift

Enable customization of arguments in Xcode package plugin #149

Enable customization of arguments in Xcode package plugin #149

Conversation

dfed commented Jan 16, 2025 • edited Loading

codecov bot commented Jan 16, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dfed commented Jan 17, 2025

pouyayarandi commented Jan 17, 2025

dfed commented Jan 17, 2025 • edited Loading

dfed commented Jan 16, 2025 •

edited

Loading

codecov bot commented Jan 16, 2025 •

edited

Loading

dfed commented Jan 17, 2025 •

edited

Loading