Yarn で GitHub リポジトリからパッケージをインストールする - サンプルコード
Yarn で GitHub リポジトリからパッケージをインストールする方法
このチュートリアルでは、Yarn を使って GitHub リポジトリから Node.js パッケージをインストールする方法を説明します。
方法
-
必要なもの
- Yarn がインストールされていること
- インストールしたいパッケージの GitHub リポジトリ URL
-
パッケージをインストールする
以下のコマンドを実行して、パッケージをインストールします。
yarn add <git-repo-url>
<git-repo-url>
を、インストールしたいパッケージの GitHub リポジトリ URL に置き換えます。例:
yarn add https://github.com/yarnpkg/berry.git
このコマンドを実行すると、Yarn はパッケージとその依存関係をダウンロードしてインストールします。
-
パッケージを使用する
パッケージがインストールされたら、プロジェクトで
require()
を使って利用できます。const berry = require('berry'); // ... berry.doSomething();
オプション
-
特定のバージョンをインストールするには、以下のコマンドを使用します。
yarn add <git-repo-url>@<version>
<version>
を、インストールしたいパッケージのバージョン番号に置き換えます。yarn add https://github.com/yarnpkg/[email protected]
-
プライベートリポジトリをインストールする
プライベートリポジトリからパッケージをインストールするには、認証トークンが必要です。
yarn config set registry https://npm.pkg.github.com yarn auth set-github-token <your-token>
<your-token>
を、GitHub の個人アクセストークンに置き換えます。yarn add <git-repo-url>@<version>
このチュートリアルは、情報提供のみを目的としています。 筆者は、このチュートリアルに記載されている情報に基づいて行われるいかなる行為についても責任を負いません。
Yarn で GitHub リポジトリからパッケージをインストールする - サンプルコード
yarn add https://github.com/yarnpkg/berry.git
const berry = require('berry');
// ...
berry.doSomething();
yarn add https://github.com/yarnpkg/[email protected]
このコマンドは、berry
パッケージのバージョン 1.0.0
をインストールします。
yarn config set registry https://npm.pkg.github.com
yarn auth set-github-token <your-token>
yarn add https://github.com/your-org/your-repo.git
Yarn で GitHub リポジトリからパッケージをインストールする - 他の方法
npm install
コマンドを使用して、GitHub リポジトリからパッケージをインストールすることもできます。
npm install https://github.com/yarnpkg/berry.git
git clone
コマンドを使用して、GitHub リポジトリをローカルにクローンし、その後に yarn install
を実行することもできます。
git clone https://github.com/yarnpkg/berry.git
cd berry
yarn install
この方法は、パッケージをソースコードレベルでデバッグしたい場合や、パッケージをプロジェクトに組み込みたい場合に役立ちます。
npx を使用する
npx
コマンドを使用して、Node.js パッケージをグローバルにインストールせずに実行することもできます。
npx install https://github.com/yarnpkg/berry.git
npx berry doSomething
この方法は、パッケージを試してみたいだけで、プロジェクトにインストールするつもりがない場合に役立ちます。
上記の方法で説明したオプションは、すべての場合に適用されます。
- 特定のバージョンをインストールするには、
<git-repo-url>
に@<version>
を追加します。
node.js yarnpkg