步骤
- 创建一个macOS下的Cocoa Application工程,作为插件的母体: Command+shift+N -> macOS CocoaApplication
- 在这个Mac工程中添加一个target(Xcode Souce Editor Extension):File->New->Target->选择macOS Xcode Souce Editor Extension。 起一个插件名字,此时弹出是否启用此Target的Scheme对话框,点击Activate按钮启用。
- 在插件target中,SourceEditorCommand文件中进行逻辑开发。
- 测试插件的时候,一定要配置签名,application工程和插件签名一致,否则不显示插件按钮。
- 将scheme切换为插件,Command+R运行插件,在弹出框中选择xcode,点击运行Run。Dock中出现一个黑色的Xcode。
- 这样就可以随意打开一个项目,进行插件测试了。Editor->最下行有自定义的插件,选择进行插件使用。
开发插件
SourceEditorExtension.h/.m
SourceEditorExtension和插件的生命周期,配置有关
/* - (void)extensionDidFinishLaunching { //是指刚刚加载好插件但还未点击插件按钮时,可以执行某些准备工作。 */ /* - (NSArray <NSDictionary <XCSourceEditorCommandDefinitionKey, id> *> *)commandDefinitions { //变量commandDefinitions返回字典类型的数组,可以为每个插件重写名字、标识符和自定义类名等信息,相当于设置 Info.plist文件中对应的XCSourceEditorCommandName、XCSourceEditorCommandIdentifier和XCSourceEditorCommandClassName信息。 return @[]; } */
SourceEditorCommand.h/.m
实现了XCSourceEditorCommand协议中的perform方法,点击插件按钮所执行的具体逻辑就是在这个方法中完成。
- (void)performCommandWithInvocation:(XCSourceEditorCommandInvocation *)invocation completionHandler:(void (^)(NSError * _Nullable nilOrError))completionHandler { // Implement your command here, invoking the completion handler when done. Pass it nil on success, and an NSError on failure. completionHandler(nil); }
- Info.plist
Info.plist 其中,每个插件的名字、标识符和自定义类名分别对应XCSourceEditorCommandName、XCSourceEditorCommandIdentifier和XCSourceEditorCommandClassName信息。 XCSourceEditorExtensionPrincipalClass对应插件的默认实现类:SourceEditorExtension。