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

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

2024-05-20 05:03:06作者:侯霆垣
ACCodeSnippetRepositoryPlugin
A plugin for Xcode to synchronize code snippets with repositories

项目介绍

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 菜单中会出现一个 "插件" 选项,从这里你可以配置你的代码片段仓库:

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

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

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

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

使用

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

格式

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

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

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

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

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

同步

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

注意事项与限制

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

贡献

架构

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

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

提交代码

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

改进计划

未来的改进方向包括:

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

总结

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

ACCodeSnippetRepositoryPlugin
A plugin for Xcode to synchronize code snippets with repositories
热门项目推荐
相关项目推荐

项目优选

收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
669
0
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
10
4
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
322
26
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.56 K
1.44 K
Jpom
🚀简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
Java
1.41 K
292
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
30
5
easy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
taro
开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/
TypeScript
35.34 K
4.77 K