SourcegraphでiPad上のコードリーディング環境を整える

はじめに

Sourcegraphはブラウザ上でGitリポジトリ上のソースコードを検索・分析できるツールです。
このツールを使うとGitHub上のパブリックリポジトリに対して簡単にコードリーディングを行う環境を準備することができます。

前提

• 本記事では、Sourcegraphの使い方は説明しません。
• GitHub上のパブリックリポジトリを対象とします。
  • プライベートリポジトリを対象とする場合は、自前のサーバにオープンソースのSourcegraphをインストールする必要があるかもしれません。
    • こちらについては詳しくは調べていません。
• iPad環境を想定します。
  • iPhoneでも大丈夫だと思いますが、画面が小さいため個人的にコードリーディングには適さない気がします。
  • また、Apple Pencilを使うとコードリーディングと相性が良さそうです。
  • PC上でコードリーディングする場合は、Chrome拡張をインストールすると便利かもしれません。
• iOSのショートカット機能を使用するため、iPadのiOSバージョンはiOS12以上を使用します。

Sourcegraphのコードリーディング用のURL

SourcegraphのドメインとGitHubのリポジトリのURLを組み合わせると、GitHubリポジトリ上のソースコードを参照することができます。

URLの形式は次の通りです。

https://sourcegraph.com/github.com/<リポジトリのパス>

例えば、Swiftのソースコードを参照したい場合は、apple/swiftをリポジトリのパスに指定します。

https://sourcegraph.com/github.com/apple/swift

上記URLをiPadのSafariブラウザなどで開けば、SwiftのソースコードをSourcegraph上で参照できます。

基本的に、リポジトリのパスさえ分かれば、GitHub上の任意のパブリックリポジトリが参照できるのですが、iOSのショートカット機能を使って簡単に参照できるようにすると便利です。

iOSのショートカットを作る

任意のGitHubのパブリックリポジトリのテキストをアラートで受け取って、コードリーディング用のURL作成し、最後にSafariブラウザを開くショートカットを作成します。

ここで、簡単にフローを説明します。

• ショートカットアプリで、ショートカットの新規作成画面を起動します。
• スクリプティングの入力を要求をを追加します。
  • 例えば、Githubのリポジトリを尋ねるに設定します。
• 変数の変数を設定を追加します。
  • 例えば、変数repoを指定入力に設定します。
• アクションのURLを追加します。
  • 例えば、https://sourcegraph.com/github.com/<変数repo>に設定します。
• アクションのURLを開くを追加します。
• 最後に完了ボタンを押して、ショートカットの名称を付ければショートカットの作成は完了です。

iOSのショートカットの実行

上記で作成したショートカットを選択すると、タイトルがGitHubのリポジトリのアラートが表示されます。ここで、apple/swiftを入力し、OKボタンを押下すれば、Safariのブラウザが自動的に起動します。

参考までに、ショートカットの共有リンクを貼っておきます。
iOS12以上の端末から、上記の共有リンクをクリックすると、ショートカットをインストールすることができます。

さいごに

今回は、GitHubのパブリックリポジトリに対して、iPadからお手軽にコードリーディングできる環境を整えました。今後、プライベートリポジトリに対しても簡単にコードリーディングできる環境を整えたいと思います。