GitHubでコードを読むのが楽になるプラグイン「module-linker」



GitHubレポジトリ内のコードが見やすくなる Google Chromeプラグイン「module-linker」の紹介です。

 GitHubには オープンソースの中心と言っていほど 沢山のコード & プロジェクトが
ホスティングされており、レポジトリ内のコードを閲覧する機会も多いのではないでしょうか。

 コードが閲覧出来るのは便利ですが、よほど小さくない限り
外部ファイルやライブラリを読み込んでいるので コード全体に目を通すとなると
ライブラリの検索したり、ページを戻ったりで手間が掛かってしまいます。

そのような二度手間、三度手間を解消してくれそうなChromeプラグインが「module-linker」です。

module-linkerで出来ること

- GitHub上のソースコードのページで、外部からインポートしているライブラリのレポジトリ・API ページに 1クリックでアクセスできる

 * module-linker 


module-linkerの入手 & 初期設定 

module-linkerは こちらのChromeウェブストアのページから入手できます。

プラグインを導入しても ' * GitHub Access Token ' を登録しないと使うことはでないので、
こちらのGitHubのページから、Access Tokenの作成を行います。
( * GitHubアカウントが必要になります )

'moduler-chrome-extension'という名でアクセストークンを作成してみました 

プラグインのオプションで、作成した'GitHub Access Token'を入力すれば登録は完了です


module-linkerの使い方

module-linerはGitHubのソースコードのページを開けば自動的に適応されます。

また、執筆時点では13のプログラミング言語に対応。

* GO言語のコードの例 

* 対応しているプログラミング言語
- Python
- PHP ('composer.json'内に記述されている外部ライブラリに対応 )
- Nim
- Dart ('.dart', 'pubspec.yaml'に対応 )
- Rust ('.rs', 'Cargo.toml' に対応 )
- Javascript ('.js', '.jsx', '.coffee', '.ts', 'package.json' ファイルに対応)
- Ruby ('.rb', 'Rakefile', 'Gemfile'内に記述されているライブラリに対応)
- Crystal ( '.cr','shard.yml'に対応 )
- Julia
- Go
- Haskell ('.hs'内のモジュール, 'stack.yaml'に記述されているパッケージに対応 )
- Elm ('.elm'内のモジュール, 'elm-package.json'に記述されているパッケージに対応 )
- PureScript

 高機能なIDE( Visual Studioなどのテキストエディタ)に見られる
'関数'や'クラス'をクリックしてジャンプするのではなく、
'import'や'require'などのモジュール読み込み関数を通じてリンクが作成されます。
( - PHPの'use'メソッド ( namespace ) などからはリンクが作成されません
  - 相対パスで読み込んでいるファイルもリンクが作成されます
 )


Summary

以上が module-linker の紹介でした。

 今回はGoogle Chrome用のmodule-linkerを紹介しましたが、
Firefox用のプラグインも用意されています。

 また、GitHubエンタープライズ上にコードをホスティングしているプロジェクトであれば、
ソースレビューが楽になりそうです。

コードのボリュームが大きいほど 役に立つプラグインなので、気になった人はゼヒ×2チェックしてください!

GitHub : fiatjaf/module-linker

 

この記事のカテゴリ
プログラミング

この記事に付けられているタグ



その他の運営サービス

最新の記事