Swift SPM Plugin无权限读写主Xcode项目外部文件求助

问题分析 #

当前代码存在两个核心问题：

1. 错误使用了documentDirectory，这是用户沙盒目录，并非主项目的目标写入目录，且子进程无权限访问该路径。
2. 子进程无法直接获取SPM插件的上下文权限，需要由插件传递合法的可写入路径。

解决方案 #

1. 修改插件代码，传递主项目合法路径给子进程 #

插件的context对象中包含主项目的根目录路径（package.directory），这是插件有权限操作的路径，将其作为参数传递给子进程：

@main
struct MyPlugin: CommandPlugin {

    func performCommand(context: PackagePlugin.PluginContext, arguments: [String]) async throws {
        let tool = try context.tool(named: "MyCodegen")
        let codegenExecutable = URL(fileURLWithPath: tool.path.string)
        // 获取主项目根目录路径
        let projectRootPath = context.package.directory.string
        // 将路径作为参数传给子进程
        let process = try Process.run(codegenExecutable, arguments: [projectRootPath])
        process.waitUntilExit()
        
        // 检查子进程执行状态
        guard process.terminationStatus == 0 else {
            throw NSError(domain: "MyPluginError", code: Int(process.terminationStatus), userInfo: [NSLocalizedDescriptionKey: "代码生成工具执行失败"])
        }
    }
}

2. 修改子进程代码，接收路径参数并写入文件 #

通过ParsableCommand的@Argument接收插件传递的路径，然后在该路径下创建目标文件：

import Foundation
import ArgumentParser

@main
struct MyCodegen: ParsableCommand {
    // 接收主项目根目录参数
    @Argument(help: "主项目根目录路径")
    var projectRootPath: String
    
    func run() throws {
        let projectRootURL = URL(fileURLWithPath: projectRootPath)
        // 定义要写入的目标文件路径（可根据需求调整）
        let targetFileURL = projectRootURL.appendingPathComponent("test.txt")
        
        try "test".write(to: targetFileURL, atomically: true, encoding: .utf8)
    }
}

关键说明 #

• SPM插件仅被允许访问context.package.directory及其子目录，传递该路径给子进程后，子进程即可获得对应路径的写入权限。
• 避免使用沙盒目录（如documentDirectory）作为主项目文件的写入目标，这类目录和主项目工程无关，且子进程无访问权限。

内容的提问来源于stack exchange，提问作者aryaxt