メインコンテンツへスキップ
見出し画像

個人開発:Chrome 拡張機能「Github PR Mew」をリリースしました。

    今回、Chrome 拡張機能をリリースしました。
    その名も「Github PR Mew」です。

    複数のプルリクエストテンプレートをプリセットとして保存し簡単に利用できる開発者向けの拡張機能です。ぜひインストールよろしくお願いします。

    主な機能について

    この拡張機能の主な機能は下記です。

    1. 自分が閲覧権限のあるリポジトリから `./github/` 配下にある `〇〇.md` ファイル(PULL_REQUEST_TEMPLATE.mdなど)を自動リストアップ

    2. リストアップされた `〇〇.md` ファイルから選択してプリセット登録(手動)

    3. Github のプルリクエストの画面でプリセットから任意の `〇〇.md`を選択すると説明欄に挿入される。

    ※ Github Personal Access Token ( Classic ) が必要です。

    ストーリー

    なぜこの拡張機能を作ったのか?
    きっかけはあるプロジェクトに「レビューワー」として参画したことです。
    その時に Github が複数の プルリクエストテンプレートに対応していないことを知りました。

    プルリクエストテンプレートについて

    通常、下記の「例 A」ような構成であればプルリクエストの画面に自動的に `BACKEND.md` の中身が反映されます。これがプルリクエストテンプレートです。

    # 例 A
    Project Root
      ┗ /.github
            ┗ /PULL_REQURST_TEMPLATE
                 ┗ BACKEBD.md → これが反映される

    しかし下記の「例 B」のように `PULL_REQURST_TEMPLATE` 配下に複数の `*.md` ファイルがある場合には対応していません( BACKEND.mdが反映される )。

    # 例 B
    Project Root
      ┗ /.github
            ┗ /PULL_REQURST_TEMPLATE
                 ┣ BACKEND.md
                 ┗ FRONTEND.md

    開発にモノレポ構成 を取り入れていて1つのリポジトリでバックもフロントも管理しているプロジェクトに参加することが多いので「例 B」のようにフロントエンド用、バックエンド用のプルリクエストテンプレートが混在している場合がほとんどでした。

    小さいプロジェクトであれば開発者の人数も少ないため意思の疎通もしやすく「そもそもプルリクエストテンプレートを用意しない」という選択肢もありますが大きいプロジェクトで、開発者が10人以上いるとそうはいきません。

    テンプレートが無いとプルリクエストの説明欄に書く内容に大きな差異が生じてしまいます。
    エビデンス画像がなかったり、Issue との紐付けをしてなかったりと、そうなるとレビュワーは都度開発者に確認しなければいけません。

    プルリクエストテンプレートの内容をメモっておいて都度コピペすることで最初は対応していましたが面倒だし開発スピードを遅延させる原因になっていました(コピペ忘れしてしまう人も一定数いました)

    検索してみると「Github は特定の条件の時にプルリクエストを選択できる」など出てきますが、どれを試してみても上手くいかず。
    ならば自分で拡張機能を作ろうと思い作った次第です。

    命名について

    「Github PR Mew」の Mew(ミャー)は英語圏内でのネコの鳴き声のことです。Githubの公式マスコット「オクトキャット」が「タコ+ネコ」であること。猫の手も借りたいほど忙しい人にほど使って欲しいという願いを込めてこの名前にしました。

    技術スタックについて

    技術スタックは「ブラウザ拡張機能におけるNext.js」と強気のワードを謳っている 拡張機能用 React フレームワーク「Plasmo」を採用しました。
    その他の技術スタックは下記をご参考ください。

    • TypeScript

    • Tailwind

    • Zustand

    • LocalStorage(ブラウザ。プリセットやトークンの保存に使用)

    • Github API

    トークンは暗号化して保存しています。
    Github Personal Access Token ( Classic ) は絶対に外部漏れてはいけない情報のため暗号化しユーザーのブラウザのLocalStorage内にだけ保存し外部に出さないことで安全性を担保しています。

    以上になります。
    日々忙しい開発者の方に使っていただき少しでも負担経験になれば幸いです。


     
     
    パパです。息子が1人います。デザイナー&エンジニアの仕事してます。育児と仕事の両立は大変でいつもヒーハー言ってます。note では「パパとして」または「エンジニアとして」の記事を書いていこうと思います。 たまに自分が作ったアプリなどの宣伝をするかもしれませんがご容赦ください。

    あなたへのおすすめ