推荐:ACCodeSnippetRepositoryPlugin——代码片段的 Git 同步利器
项目介绍
ACCodeSnippetRepositoryPlugin 是一个针对 Xcode 的插件,它能够让你的代码片段与 Git 仓库实现无缝同步,让团队协作变得更加高效。这个插件将你的代码片段以人类可读的文本格式存储,而不是通常的 .codesnippet
属性列表文件。
如果你对 Xcode 中的代码片段功能不熟悉,可以参考 NSHipster 上的这篇精彩文章:Xcode Snippets。
要尝试使用已经存在的公共仓库吗?不妨试试 acoomans 或者 mattt 的代码片段库。
安装
- 构建项目安装插件。插件会自动安装到
/Library/Application Support/Developer/Shared/Xcode/Plug-ins/ACCodeSnippetRepository.xcplugin
。 - 重启 Xcode,激活插件。
或者,你也可以通过 Alcatraz 插件管理器进行安装。
配置
在 Xcode 菜单中会出现一个 "插件" 选项,从这里你可以配置你的代码片段仓库:
首先,你需要配置并 fork 远程仓库:
当你 fork 之后,所有符合格式要求的代码片段(见下文“格式”部分)都会被导入到 Xcode 中。你现有的、尚未关联任何仓库的代码片段不会受到影响。
此外,还可以选择导入 Xcode 内置的代码片段,或者移除系统代码片段。
如果出现错误,可以通过备份用户代码片段文件夹来保护你的数据。用户代码片段会自动在每次操作前备份。
使用
ACCodeSnippetRepositoryPlugin 使用起来非常简单,就像平时使用 Xcode 一样编写代码片段。它们会被自动添加、修改或删除,并同步到 Git 仓库。
格式
代码片段以 .m
文件扩展名保存,格式如下:
- 一个头部,包含了:
- 标题
- 描述
- 数字键和值形式的 Xcode 相关信息(键按字母顺序排列)
- 代码
如果代码片段没有头部,该头部会在导入时被自动添加、提交和推送。
请注意不要删除 Xcode 相关的信息,因为这些信息对于同步是必要的。
如果有两个具有相同 IDECodeSnippetIdentifier 的代码片段,Xcode 会崩溃,因此,当手动创建代码片段时,请更改或删除这一标识符。
同步
每次代码片段变更都会独立地进行提交和推送。每隔10分钟(如果启用了该选项)或点击菜单中的 "更新代码片段",本地代码片段将与远程仓库同步。在合并过程中遇到冲突时,远程仓库的内容优先。
注意事项与限制
可能存在一些问题,比如错误、崩溃以及同步问题。请定期备份你的代码片段和 Git 仓库,以防万一。
贡献
架构
插件的工作原理是对 _IDECodeSnippetRepository
类进行了 swizzling 处理,这是 IDECodeSnippetLibrary.ideplugin
插件的一部分。然后,我们可以为 _IDECodeSnippetRepository
添加自定义的数据存储类,遵循 ACCodeSnippetDataStoreProtocol
协议。
下图展示了架构的大致情况,可能会让你感到有点迷茫:
提交代码
欢迎通过 pull request 形式贡献代码。
改进计划
未来的改进方向包括:
- 增加对
.codesnippet
文件的支持 - 实现多个数据存储管理
- 支持 Github Gist
总结
ACCodeSnippetRepositoryPlugin 让 Xcode 代码片段的版本控制变得轻松简单,提供了高效的团队协作环境。无论是个人开发者还是团队成员,都可以从中获益。现在就加入,开始享受代码片段同步带来的便利吧!
- 国产编程语言蓝皮书《国产编程语言蓝皮书》-编委会工作区017
- nuttxApache NuttX is a mature, real-time embedded operating system (RTOS).C00
- qwerty-learner为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workersTSX027
- 每日精选项目🔥🔥 01.17日推荐:一个开源电子商务平台,模块化和 API 优先🔥🔥 每日推荐行业内最新、增长最快的项目,快速了解行业最新热门项目动态~~026
- Cangjie-Examples本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie045
- 毕方Talon工具本工具是一个端到端的工具,用于项目的生成IR并自动进行缺陷检测。Python039
- PDFMathTranslatePDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/DockerPython05
- mybatis-plusmybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.comJava03
- advanced-javaAdvanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。JavaScript0108
- taro开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/TypeScript09