首页
/ 推荐:ACCodeSnippetRepositoryPlugin——代码片段的 Git 同步利器

推荐:ACCodeSnippetRepositoryPlugin——代码片段的 Git 同步利器

2024-05-20 05:03:06作者:侯霆垣

项目介绍

ACCodeSnippetRepositoryPlugin 是一个针对 Xcode 的插件,它能够让你的代码片段与 Git 仓库实现无缝同步,让团队协作变得更加高效。这个插件将你的代码片段以人类可读的文本格式存储,而不是通常的 .codesnippet 属性列表文件。

Build Status

如果你对 Xcode 中的代码片段功能不熟悉,可以参考 NSHipster 上的这篇精彩文章:Xcode Snippets

要尝试使用已经存在的公共仓库吗?不妨试试 acoomans 或者 mattt 的代码片段库。

安装

  1. 构建项目安装插件。插件会自动安装到 /Library/Application Support/Developer/Shared/Xcode/Plug-ins/ACCodeSnippetRepository.xcplugin
  2. 重启 Xcode,激活插件。

或者,你也可以通过 Alcatraz 插件管理器进行安装。

配置

在 Xcode 菜单中会出现一个 "插件" 选项,从这里你可以配置你的代码片段仓库:

推荐:ACCodeSnippetRepositoryPlugin——代码片段的 Git 同步利器

首先,你需要配置并 fork 远程仓库:

推荐:ACCodeSnippetRepositoryPlugin——代码片段的 Git 同步利器

当你 fork 之后,所有符合格式要求的代码片段(见下文“格式”部分)都会被导入到 Xcode 中。你现有的、尚未关联任何仓库的代码片段不会受到影响。

此外,还可以选择导入 Xcode 内置的代码片段,或者移除系统代码片段。

如果出现错误,可以通过备份用户代码片段文件夹来保护你的数据。用户代码片段会自动在每次操作前备份。

使用

ACCodeSnippetRepositoryPlugin 使用起来非常简单,就像平时使用 Xcode 一样编写代码片段。它们会被自动添加、修改或删除,并同步到 Git 仓库。

推荐:ACCodeSnippetRepositoryPlugin——代码片段的 Git 同步利器

格式

代码片段以 .m 文件扩展名保存,格式如下:

  1. 一个头部,包含了:
    • 标题
    • 描述
    • 数字键和值形式的 Xcode 相关信息(键按字母顺序排列)
  2. 代码

如果代码片段没有头部,该头部会在导入时被自动添加、提交和推送。

请注意不要删除 Xcode 相关的信息,因为这些信息对于同步是必要的。

如果有两个具有相同 IDECodeSnippetIdentifier 的代码片段,Xcode 会崩溃,因此,当手动创建代码片段时,请更改或删除这一标识符。

推荐:ACCodeSnippetRepositoryPlugin——代码片段的 Git 同步利器

同步

每次代码片段变更都会独立地进行提交和推送。每隔10分钟(如果启用了该选项)或点击菜单中的 "更新代码片段",本地代码片段将与远程仓库同步。在合并过程中遇到冲突时,远程仓库的内容优先。

注意事项与限制

可能存在一些问题,比如错误、崩溃以及同步问题。请定期备份你的代码片段和 Git 仓库,以防万一。

贡献

架构

插件的工作原理是对 _IDECodeSnippetRepository 类进行了 swizzling 处理,这是 IDECodeSnippetLibrary.ideplugin 插件的一部分。然后,我们可以为 _IDECodeSnippetRepository 添加自定义的数据存储类,遵循 ACCodeSnippetDataStoreProtocol 协议。

下图展示了架构的大致情况,可能会让你感到有点迷茫:

推荐:ACCodeSnippetRepositoryPlugin——代码片段的 Git 同步利器

提交代码

欢迎通过 pull request 形式贡献代码。

改进计划

未来的改进方向包括:

  • 增加对 .codesnippet 文件的支持
  • 实现多个数据存储管理
  • 支持 Github Gist

总结

ACCodeSnippetRepositoryPlugin 让 Xcode 代码片段的版本控制变得轻松简单,提供了高效的团队协作环境。无论是个人开发者还是团队成员,都可以从中获益。现在就加入,开始享受代码片段同步带来的便利吧!

登录后查看全文
热门项目推荐

项目优选

收起
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
53
468
kernelkernel
deepin linux kernel
C
22
5
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
349
381
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
133
186
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
878
517
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
336
1.1 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
180
264
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
612
60
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4