はじめに

npmパッケージのGitHubリポジトリをフォークして、npmではなくGitHubからインストールして使うことがあったのでやったことのまとめです。

やったこと

1. GitHubリポジトリをフォークする

npmパッケージの package.json の repository にリポジトリのURLが書かれていることが多いので、そこからアクセスします。
リポジトリを自分のアカウントにフォークします。
参考: https://docs.github.com/ja/get-started/quickstart/fork-a-repo

2. ビルドファイルをリポジトリに含める

パッケージによってはビルド済みのファイルはnpmにのみプッシュされており、Gitには含まれていないことがあります。
その場合はGitHubからパッケージをインストールしても、ビルドしないと使えません。
インストールのたびにビルドするのは面倒なので、ビルドしたファイルをGit管理するようにします。

package.json の files に記載されているファイルがGitで管理されていない場合はビルドが必要です。
ビルド方法はパッケージによって異なりますが、いくつかのリポジトリを見たところpackage.json の script に build コマンドが用意されていることが多いようです。

3. フォークしたパッケージをインストールする

リポジトリのURLをforkしたリポジトリのページから取得します。
URLはクローン用のURLと同じなので、こちらを参考に取得してください。
参考: https://docs.github.com/ja/get-started/quickstart/fork-a-repo#cloning-your-forked-repository

パッケージをインストールするコマンドは普段と少し異なり、このようなコマンドになります。

yarn add "パッケージ名@git+リポジトリのURL#ブランチ・タグ名"

参考: https://classic.yarnpkg.com/en/docs/cli/add#toc-adding-dependencies