GitUp
快速、安全、无忧工作。你一直期待的Git界面终于来了。
Git最近庆祝了它的10周年,但大多数工程师仍然对其复杂性感到困惑(Stack Overflow上所有时间票数最高的5个问题中有3个与Git有关)。由于Git甚至将简单的操作都变成了令人费解的命令("git add"用于暂存,而"git reset HEAD"用于取消暂存,有谁能说清楚吗?),难怪用户会浪费时间、感到沮丧、打扰团队其他成员寻求帮助,或者更糟糕的是,搞砸他们的代码库!
GitUp是一次尝试,旨在发明一种新的Git交互模式,让各个水平的工程师都能快速、安全、无忧地工作。它与其他Git客户端截然不同,从构建方式(直接与磁盘上的Git数据库交互)到工作方式(您操作存储库图而不是操作提交)。
使用GitUp,您可以获得一个真正高效的Mac版Git客户端:
- 实时交互式存储库图(编辑、重新排序、修复、合并提交等),
- 几乎所有操作的无限撤销/重做(甚至包括变基和合并),
- 类似Time Machine的快照功能,一键回滚到之前的存储库状态,
- Git原生不存在的功能,如可视化提交拆分器或统一的reflog浏览器,
- 跨整个存储库的即时搜索,包括差异内容,
- 极快的用户界面,通常比命令行还要快。
GitUp由@swisspol于2014年底创建,旨在重新发明开发者与Git交互的方式。经过几个月的工作,它于2015年初进行了预发布,并登上了Hacker News的头条,同时被Product Hunt和Daring Fireball推荐。3万行代码之后,GitUp于2015年8月中旬达到1.0版本,并作为礼物开源发布给开发者社区。
入门
- 官方网站:https://gitup.co
下载:
- GitHub上的最新发布版:https://github.com/git-up/GitUp/releases
- Homebrew(非GitUp开发者维护):
brew install homebrew/cask/gitup
(注意:已有一个名为gitup的formula,所以必须指定完整名称!)
阅读文档并使用GitHub Issues获取支持和反馈。
发布说明可在https://github.com/git-up/GitUp/releases 查看。标记为v
的构建(如v1.2.3
)在"稳定"通道发布,而标记为b
的构建(如b1234
)仅在"持续"通道发布。您可以在应用程序首选项中更改GitUp使用的更新通道。
构建
要自行构建GitUp,只需在终端中运行命令git clone --recursive https://github.com/git-up/GitUp.git
,然后打开GitUp/GitUp.xcodeproj
Xcode项目并点击运行。
**重要提示:**如果您没有用于签署Mac应用程序的Apple ID开发者账户,构建将因代码签名错误而失败。只需删除"Application"目标的"Code Signing Identity"构建设置即可解决此问题:
或者,如果您有开发者账户,可以创建文件"Xcode-Configurations/DEVELOPMENT_TEAM.xcconfig",并将以下构建设置作为其内容:
DEVELOPMENT_TEAM = [您的TeamID]
有关更详细的描述,您可以查看"Xcode-Configurations/Base.xcconfig"文件末尾的注释。
GitUpKit
GitUp是作为一个薄层构建在可重用的通用Git工具包"GitUpKit"之上的。这意味着您可以使用相同的GitUpKit框架来构建自己的Git用户界面!
GitUpKit的目标与ObjectiveGit有很大不同。它不是提供libgit2的广泛原始绑定,而是只使用libgit2的最小子集,并在此基础上重新实现其他所有功能(例如,它有自己的"变基引擎")。 这使得它能够暴露一个非常紧凑和一致的API,完全遵循Obj-C约定,并隐藏了libgit2的复杂性和有时的不一致性。GitUpKit在此基础上添加了许多独特和强大的功能,从撤销/重做和类似Time Machine的快照,到完整的即插即用UI组件。
架构
GitUpKit源代码组织为两个独立的层,仅通过使用公共API进行通信:
基础层(仅依赖于Foundation,兼容OS X和iOS)
Core/
:围绕libgit2所需的最小功能的包装器,在此基础上实现了GitUp所需的所有Git功能(请注意,GitUp使用了稍微定制的libgit2分支)Extensions/
:Core
类的分类,仅使用公共API添加便利功能
UI层(依赖于AppKit,仅兼容OS X)
Interface/
:低级视图类,例如用于渲染GitUp Map视图的GIGraphView
Utilities/
:接口实用程序类,例如基础视图控制器类GIViewController
Components/
:可重用的单视图视图控制器,例如用于渲染差异的GIDiffContentsViewController
Views/
:高级可重用的多视图视图控制器,例如用于实现整个GitUp高级提交视图的GIAdvancedCommitViewController
重要提示:如果在构建GitUpKit时将预处理器常量DEBUG
定义为非零值(这是在"Debug"配置下构建时的默认设置),则会在运行时启用许多额外的一致性检查以及额外的日志记录。请注意,这种开销可能会显著影响性能。
GitUpKit API
使用GitUpKit API应该相当简单,因为它按功能组织(例如存储库、分支、提交、界面组件等),并且我们尽最大努力清晰地命名函数。
关于"Core" API,学习它们的最佳方式是浏览相关的单元测试 - 例如,查看分支测试了解分支API。
这里有一些示例代码可以帮助你入门(错误处理留给读者自行练习): 打开和浏览仓库:
// 打开仓库
GCRepository* repo = [[GCRepository alloc] initWithExistingLocalRepository:<路径> error:NULL];
// 确保仓库是干净的
assert([repo checkClean:kGCCleanCheckOption_IgnoreUntrackedFiles error:NULL]);
// 列出所有分支
NSArray* branches = [repo listAllBranches:NULL];
NSLog(@"%@", branches);
// 查找HEAD
GCLocalBranch* headBranch; // 如果HEAD是分离状态,这将为nil
GCCommit* headCommit;
[repo lookupHEADCurrentCommit:&headCommit branch:&headBranch error:NULL];
NSLog(@"%@ = %@", headBranch, headCommit);
// 将整个仓库历史加载到内存中以便快速访问,包括所有提交、分支和标签
GCHistory* history = [repo loadHistoryUsingSorting:kGCHistorySorting_ReverseChronological error:NULL];
assert(history);
NSLog(@"总共%lu个提交", history.allCommits.count);
NSLog(@"%@\n%@", history.rootCommits, history.leafCommits);
修改仓库:
// 为仓库创建快照
GCSnapshot* snapshot = [repo takeSnapshot:NULL];
// 创建新分支并检出
GCLocalBranch* newBranch = [repo createLocalBranchFromCommit:headCommit withName:@"temp" force:NO error:NULL];
NSLog(@"%@", newBranch);
assert([repo checkoutLocalBranch:newBranch options:0 error:NULL]);
// 将文件添加到索引
[[NSData data] writeToFile:[repo.workingDirectoryPath stringByAppendingPathComponent:@"empty.data"] atomically:YES];
assert([repo addFileToIndex:@"empty.data" error:NULL]);
// 检查索引状态
GCDiff* diff = [repo diffRepositoryIndexWithHEAD:nil options:0 maxInterHunkLines:0 maxContextLines:0 error:NULL];
assert(diff.deltas.count == 1);
NSLog(@"%@", diff);
// 创建提交
GCCommit* newCommit = [repo createCommitFromHEADWithMessage:@"添加文件" error:NULL];
assert(newCommit);
NSLog(@"%@", newCommit);
// 将仓库恢复到保存的快照,即创建主题分支和提交之前的状态
BOOL success = [repo restoreSnapshot:snapshot withOptions:kGCSnapshotOption_IncludeAll reflogMessage:@"回滚" didUpdateReferences:NULL error:NULL];
assert(success);
// 确保主题分支已被删除
assert([repo findLocalBranchWithName:@"temp" error:NULL] == nil);
// 更新工作目录和索引以匹配HEAD
assert([repo resetToHEAD:kGCResetMode_Hard error:NULL]);
完整示例 #1: GitDown
GitDown是一个非常基础的应用程序,它提示用户输入一个仓库,并显示其贮藏列表的交互式实时更新(全部通过-[AppDelegate applicationDidFinishLaunching:]
中约20行代码实现):
通过GitUpKit,这个基础应用还免费获得了无限撤销/重做、统一和并排差异、文本选择和复制、键盘快捷键等功能...
这段源代码还演示了如何使用其他一些GitUpKit视图控制器以及如何构建自定义控制器。
完整示例 #2: GitDiff
GitDiff演示了如何创建一个视图控制器,以类似git diff HEAD
的方式显示HEAD
和工作目录之间的实时更新差异:
完整示例 #3: GitY
GitY是使用GitUpKit和不到200行代码构建的GitX克隆版:
完整示例 #4: iGit
iGit是一个测试用的iOS应用,它简单地使用GitUpKit克隆GitHub仓库并执行提交。
贡献
致谢
同时也要特别感谢优秀的libgit2贡献者们,没有他们GitUp就不可能存在!
许可证
GitUp的版权归2015-2018 Pierre-Olivier Latour所有,并在GPL v3许可证下可用。更多信息请参见项目中的LICENSE文件。
重要提示: GitUp包含一些其他开源项目,这些项目仍然保持其原有的许可证。