コードリーディングが捗る"github1s.com"
はじめに
今日はTLで流れてきた"github1s.com"が気になったので、調べてみたら意外と使い勝手が良かったのでまとめみました。
流れてきたTL
TLが流れたときは、正直最初は何がどうなっているのかよく分かりませんでしたが、じっくり見てみてるとなかなかすごい。
Github1s is really nice.
— Henning Dieterichs (@hediet_dev) 2021年2月9日
Just add "1s" after "github" when viewing code on https://t.co/0Wbx80muQp and VS Code loads up instantly: pic.twitter.com/rW5tdxrqIJ
リポジトリを開いたら、https://github1s.com/atEaE/hogehogeのgithubの後ろに1sを追加するだけです。
たったそれだけで、ブラウザ上のVSCodeからソースコードを確認することができます。
github1s用のURL
https://github1s.com/atEaE/commandLineSelectableMenu
github1s自体はOSSで公開されています。
使用感
1. コードリーディングが捗る
今までOSSのソースコードを確認するときには、Github上だけではどうしてもコードが読みづらかったので、.zipをダウンロードしたり、cloneしたりしていました。
ところがgithub1sでは1sを付け加えるだけで、Github上で見るよりも遥かにソースコードが読みやすいです。
開発者の方々ありがとう！
2. タグやブランチ別のソースコードも確認可能
タグ別のソースコードや、ブランチ別のソースコードも同じ要領で確認することができます。
タグ別はhttps://github.com/atEaE/hogehoge/tree/v1.0.0、
ブランチ別はhttps://github.com/atEaE/hogehoge/tree/developのようになります。
後は同じように1sを付けるだけで、ソースコードの確認ができます。
3. OAuth Tokenを登録すれば自身のPrivateリポジトリも確認可能
Githubの OAuth Tokenを使用していない場合は、Privateリポジトリのソースコードを確認することができません。
また、Github APIの使用上は1時間あたりのリクエスト数に限りがあります。
(未認証時は1時間あたり最大60リクエストまで可能。認証時は、1時間あたり最大5,000リクエストまで可能。)
Privateのリポジトリの確認がしたい場合や、リクエスト制限を緩和したい場合は、OAuth Tokenを登録しましょう。
Tokenは↑の通り、メニューから登録することができます。
VSCodeとの差異
1. フォルダ横断検索ができない
VSCodeと同じような見た目をしていますが、完全に同じ機能を有しているわけではありません。
まず、フォルダ横断した検索を実行することができません。
あくまで、アクティブファイルに対しての検索しかできません。
(アクティブファイルはEditor上で開いているファイルのことです。)
2. 一部の言語はコードジャンプが機能しない。
C#, golang, Typescript, javascriptでリポジトリを確認しましたが、C#, golangではコードジャンプが機能しませんでした。
Typescript, Javascriptに関しては、カーソルをHoverさせることで定義の確認まですることができました。
3. 基本的にファイルの編集はできない。
ファイルの編集は基本的にはできません。
『New File』から新規タブを開いた場合は、例外的に編集を行うことができますが、新規タブで作成したファイルは保存できないので、メモ書き程度なのかなと。思いました。
まとめ
- コードリーディングが捗る。
- 欲を言えば、フォルダの横断検索とコードジャンプが使えるといい。
