LoginSignup
3
2

More than 1 year has passed since last update.

npmパッケージをGitHubでFrokして使う

Posted at

はじめに

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

やったこと

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

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

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

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

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

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

3
2
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
3
2