pull-request-graph
v0.0.4
Published
Pull Request とブランチを取得し、Mermaid 形式で可視化する Node.js ツール。GitHub Device Flow を用いてプライベートリポジトリにも対応します。
Readme
Pull Request Graph
Pull Request とブランチを取得し、Mermaid 形式で可視化する Node.js ツールです。 GitHub Device Flow を用いることで、プライベートリポジトリにも対応可能です。
インストール
npm install -g pull-request-graphグローバルインストールを行うことで、どのディレクトリからでもコマンドを呼び出せるようになります。 特定のリポジトリで使いたい場合は、リポジトリのディレクトリで
npm install --save-devを実行してください。
使い方
リポジトリのあるディレクトリでコマンドを実行
prg
# または
npx prg- もしくは、パッケージをクローンして
npm run startのように実行する方法もあります。
index.html が生成 → ブラウザ表示
- 実行後に、同じディレクトリに
index.htmlが生成されます。 - そのまま自動的にブラウザが起動する場合もあれば、起動しない場合はファイルを手動で開いてください。
出力例
生成される index.html の中身(Mermaid 部分のみ抜粋):
graph RL
認証機能を実装する --> |Open| main
特殊記号をサニタイズする --> |Draft| main
...ブラウザで開くと、矢印や PR 番号、ブランチ名が可視化されて確認できます。 ブランチ名をクリックすると、PR のページにアクセスできます。
コントリビュート
- バグ報告やプルリクエストは歓迎です。
- Issue や Pull Request でお気軽にご連絡ください。
