Ein Xcode-Plugin: Reveal-In-GitHub
Dies ist die README.md von einem GitHub-Projekt: https://github.com/lzwjava/Reveal-In-GitHub.
Reveal-In-GitHub
Ein Xcode-Plugin, das für eine nahtlose Navigation zu wichtigen GitHub-Funktionen innerhalb Ihres aktuellen Repositories entwickelt wurde. Mit einem Klick können Sie mühelos auf den GitHub-Verlauf, die Verursacheransicht, Pull-Requests, Issues und Benachrichtigungen zugreifen – alles in wenigen Sekunden.
Unser Unternehmen arbeitet auf GitHub. Ich öffne GitHub oft. Manchmal bearbeite ich in Xcode etwas und verstehe den Code nicht, also gehe ich zu GitHub, um ihn zu veröffentlichen. Manchmal finde ich die letzten Commits für eine Datei, um herauszufinden, wie sich der Code entwickelt hat. Daher fragte ich mich, ob es ein Tool gibt, das mir hilft, schnell von Xcode aus zu GitHub zu wechseln. Daher schrieb ich dieses Plugin. Wenn du eine Quelldatei in Xcode bearbeitest, ist es einfach zu wissen, in welchem GitHub-Repository du arbeitest und welche Datei du bearbeitest. Daher macht es Sinn, schnell zur Datei auf GitHub zu springen, schnell zur Verursacheransicht der aktuellen bearbeiteten Zeile auf GitHub zu springen, schnell zu den Issues oder PRs des aktuellen Repositories zu springen, an dem du in Xcode arbeitest.
Menüpunkte
Es gibt sechs Menüpunkte:
| Menü-Titel | Taschenrechner | GitHub-URL-Muster (wenn ich LZAlbumManager.m Zeile 40 bearbeite) |
|---|---|---|
| Einstellungen | ⌃⇧⌘S | |
| Repository | ⌃⇧⌘R | https://github.com/lzwjava/LZAlbum |
| Issues | ⌃⇧⌘I | https://github.com/lzwjava/LZAlbum/issues |
| PRs | ⌃⇧⌘P | https://github.com/lzwjava/LZAlbum/pulls |
| Schnelldatei | ⌃⇧⌘Q | https://github.com/lzwjava/LZAlbum/blob/fd7224/LZAlbum/manager/LZAlbumManager.m#L40 |
| Historie auflisten | ⌃⇧⌘L | https://github.com/lzwjava/LZAlbum/commits/fd7224/LZAlbum/manager/LZAlbumManager.m |
| Verursacheransicht | ⌃⇧⌘B | https://github.com/lzwjava/LZAlbum/blame/fd7224/LZAlbum/manager/LZAlbumManager.m#L40 |
| Benachrichtigungen | ⌃⇧⌘N | https://github.com/leancloud/LZAlbum/notifications?all=1 |
Die Tastenkombinationen sind sorgfältig gestaltet. Sie werden nicht mit den Standardtastenkombinationen von Xcode in Konflikt geraten. Das Tastenkombinationsmuster ist ⌃⇧⌘ (Ctrl+Shift+Command), plus das erste Zeichen des Menü-Titels.
Anpassen
Manchmal möchten Sie möglicherweise schnell zur Wiki springen. Hier ist die Vorgehensweise, öffnen Sie die Einstellungen:
Zum Beispiel,
Schnelldatei, das Muster und die tatsächliche URL:
{git_remote_url} /blob/{commit}/ {file_path} #{selection}
https://github.com/lzwjava/LZAlbum/blob/fd7224/LZAlbum/manager/LZAlbumManager.m#L40-L43
Der {commit} ist der aktuelle Commit-Hash des aktuellen Branches. Es ist besser, ihn zu verwenden, anstatt den Branch, weil der HEAD des Branches sich ändern kann. Daher kann auch der Code in #L40-L43 geändert werden.
Wenn Sie also eine Tastenkombination für die Wiki des aktuellen Repositories hinzufügen möchten, fügen Sie einfach einen Menüpunkt hinzu und legen Sie das Muster auf {git_remote_url}/wiki fest.
In den Einstellungen bedeutet Clear Default Repos, wenn Sie mehrere Git-Remotes haben, wird es Sie beim ersten Mal auffordern, eines von ihnen auszuwählen:
Das Plugin merkt sich dann, welches Sie wählen. Daher wird beim nächsten Auslösen des Menüs dieses Remote-Repository als Standard geöffnet. Der Knopf Clear Default Repos löscht diese Einstellung und fordert Sie erneut zur Auswahl auf.
Installieren
Empfohlen zur Installation mit Alcatraz,
Oder
- Klonen Sie dieses Repository.
- Öffnen Sie
Reveal-In-GitHub.xcodeprojund bauen Sie es. - Reveal-In-GitHub.xcplugin sollte sich in
~/Library/Application Support/Developer/Shared/Xcode/Plug-insbefinden - XCode neu starten
- Öffnen Sie ein beliebiges GitHub-Projekt und drücken Sie ⌃⇧⌘B (Ctrl+Shift+Command+B), um den Code zu veröffentlichen.
安装
Empfohlen zur Installation mit Alcatraz, siehe auch den Blog von Devtang Blog. Nach der Installation, suchen Sie nach Reveal In GitHub und klicken Sie auf Install.
Wenn Sie dieses Tool nicht verwenden, erfolgen drei Schritte:
- Klonen Sie dieses Projekt auf Ihren lokalen Rechner.
- Öffnen Sie xcodeproj, klicken Sie auf Build zum Bauen. Dies wird in der Verzeichnis
~/Library/Application Support/Developer/Shared/Xcode/Plug-insReveal-In-GitHub.xcplugin Datei generieren. - Starten Sie Xcode neu und öffnen Sie ein beliebiges Projekt auf GitHub. Drücken Sie
Ctrl+Shift+Command+B, um den Code zu veröffentlichen.
Credit
Während der Entwicklung stellte sich heraus, dass ein weiteres Plugin ShowInGitHub eine ähnliche Aufgabe durchführt. Ich lernte einige Techniken davon. Vielen Dank dafür.
Lizenz
MIT