riverpod_graph を手軽に実行する

https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_graph
riverpod_graph は、riverpodのproviderやwidgetの関係性を可視化するものです。

ただし、work in progressらしく、ドキュメントがあまり整備されていないような気がします。

今回、 dart pub global activate を利用することで、かんたんに実行出来たので、備忘録として残しておきます。

参考: https://dart.dev/tools/pub/cmd/pub-global

インストール

pub.dev に上がっていないので、GitHubから直接activateしていきます。

dart pub global activate -sgit https://github.com/rrousselGit/riverpod.git --git-path packages/riverpod_graph

実行

可視化したいリポジトリのルートディレクトリで、以下のように実行します。

dart pub global run riverpod_graph:riverpod_graph > graph.md

1行目に Analyzing ... といったものが出力されてしまうので、それを削除。
GitHub上で閲覧するには、 ```mermaid を先頭につけて、
末尾にも ``` を追加すると良いと思います。