Reveal-In-GitHub
Xcode plugin to let you jump to GitHub History, Blame, PRs, Issues, Notifications of current repo in one second.
My company work on GitHub. I open the GitHub a lot. Sometimes, I am editing on Xcode and do not understand some code, so I go to GitHub to blame them. Sometimes, find the latest commits about a file to help me figure out how the code evolves. So I wonder is there a tool to help me quick open GitHub from Xcode. So I write this plugin. When you editing some source file on Xcode, it's easy to know which GitHub repo you are working on and know which file you are editing. So it makes sense to quickly jump to the file on GitHub, quickly jump to blame the current editing line on GitHub, quickly jump to the issues or prs of the current repo you are working on Xcode.
Menu Items
It has six menu items:
| Menu Title | Shortcut | GitHub URL Pattern (When I'm editing LZAlbumManager.m Line 40) |
|---|---|---|
| Setting | ⌃⇧⌘S | |
| Repo | ⌃⇧⌘R | https://github.com/lzwjava/LZAlbum |
| Issues | ⌃⇧⌘I | https://github.com/lzwjava/LZAlbum/issues |
| PRs | ⌃⇧⌘P | https://github.com/lzwjava/LZAlbum/pulls |
| Quick File | ⌃⇧⌘Q | https://github.com/lzwjava/LZAlbum/blob/fd7224/LZAlbum/manager/LZAlbumManager.m#L40 |
| List History | ⌃⇧⌘L | https://github.com/lzwjava/LZAlbum/commits/fd7224/LZAlbum/manager/LZAlbumManager.m |
| Blame | ⌃⇧⌘B | https://github.com/lzwjava/LZAlbum/blame/fd7224/LZAlbum/manager/LZAlbumManager.m#L40 |
| Notifications | ⌃⇧⌘N | https://github.com/leancloud/LZAlbum/notifications?all=1 |
The shortcuts are carefully designed. They will not confict to Xcode default shortcuts. The shortcut pattern is ⌃⇧⌘ (Ctrl+Shift+Command), plus First Character of the menu title.
Customize
Sometimes, you may want to quickly jump to Wiki. Here is the way, open the setting:
For example,
Quick file, the pattern and the actual url:
{git_remote_url} /blob/{commit}/ {file_path} #{selection}
https://github.com/lzwjava/LZAlbum/blob/fd7224/LZAlbum/manager/LZAlbumManager.m#L40-L43
The {commit} is the latest commit hash of current branch. It's better then use branch. Because branch's HEAD may be changed. So the code in #L40-L43 may also be changed.
So if you want to add a shortcut to current repo's wiki, just add a menu item and set the pattern to {git_remote_url}/wiki.
In settings, Clear Default Repos say if you have multiple git remotes, when first time to trigger, it will ask you to choose one of them:
Then the plugin remembers which you choose. So when you trigger the menu again, will open that remote repo as the default. The button Clear Default Repos will clear this setting, will ask you to select again.
Install
Recomend install with Alcatraz,
Or
- Clone this repo.
- Open
Reveal-In-GitHub.xcodeproj, and build it. - Reveal-In-GitHub.xcplugin should locate at
~/Library/Application Support/Developer/Shared/Xcode/Plug-ins - Restart Xcode
- Open any GitHub Project and press ⌃⇧⌘B (Ctrl+Shift+Command+B) to blame the code.
安装
推荐使用 Alcatraz，可参考巧神的一遍博客。安装好后，按照上图搜索 Reveal In GitHub，点击 Install 即可。
如果不使用这个工具的话，那么也只需三步：
- 克隆该项目到本地。
- 打开 xcodeproj，点击 Build 构建。这会在目录
~/Library/Application Support/Developer/Shared/Xcode/Plug-ins生成 Reveal-In-GitHub.xcplugin 文件。 - 重启 Xcode，打开任意一个放在 GitHub 上的项目。按下
Ctrl+Shift+Command+B即可。
Credit
When at the course of developing it, find another plugin ShowInGitHub do something similar. I learn some techique from it. Thanks for that.
License
MIT
160 Dec 17, 2022
34 Dec 17, 2022
104 Jan 4, 2023
2.3k Jan 1, 2023
629 Jan 4, 2023
15.9k Jan 8, 2023
1.1k Dec 14, 2022
77 Dec 27, 2022
1 Oct 18, 2021
0 Dec 30, 2021
2 May 23, 2022
0 Jan 7, 2022
6 Nov 14, 2022
322 Sep 7, 2022
0 Jan 4, 2022
118 Jan 2, 2023
27 Dec 27, 2022
0 Nov 3, 2021
233 Sep 9, 2022
188 Dec 23, 2022
229 Jun 29, 2022
76 Jul 2, 2022
1.5k Sep 7, 2022
75 Jun 18, 2022
188 Jun 18, 2022
718 Aug 21, 2022
191 Dec 10, 2022
839 Nov 10, 2022