Node.jsのYarnパッケージマネージャーのインストールと使用方法

チュートリアル
JavaScript

紹介

Yarnは、速度、セキュリティ、一貫性に焦点を当てたNode.jsのパッケージマネージャーです。これは、人気のあるNPMパッケージマネージャーに関するいくつかの問題に対処するために元々作成されました。2つのパッケージマネージャーは、パフォーマンスと機能の面で収束したが、特にReact開発の世界ではYarnが人気です。

Yarnのいくつかのユニークな機能には次のものがあります：

  • A per-project caching mechanism, that can greatly speed up subsequent installs and builds
  • 常に同じ構造のインストールされたライブラリを保証する一貫性のある決定論的なインストール
  • すべてのパッケージのチェックサムテストによる整合性の検証
  • 「ワークスペース」、これによりYarnをモノリポ（単一のソースコードリポジトリで開発された複数のプロジェクト）で使用できるようになります

このチュートリアルでは、Yarnをグローバルにインストールし、特定のプロジェクトにYarnを追加し、基本的なYarnコマンドを学びます。

DigitalOcean App Platformを使用してGitHubからフロントエンドアプリケーションをデプロイします。DigitalOceanにアプリのスケーリングを任せてください。

Node.js用のYarnパッケージマネージャのインストールと使用

  1. Yarnをグローバルにインストールする
  2. プロジェクトにYarnをインストールする
  3. Yarnを使用する

前提条件

Yarnパッケージマネージャをインストールして使用する前に、Node.jsをインストールする必要があります。すでにNode.jsがインストールされているかどうかを確認するには、次のコマンドをローカルのコマンドラインターミナルに入力してください：

  1. node -v

バージョン番号が表示される場合（v12.16.3など）、Node.jsがインストールされています。 command not found エラー（または類似のフレーズ）が表示された場合は、続行する前にNode.jsをインストールしてください。

Node.jsをインストールするには、Ubuntu、Debian、CentOS、またはmacOSのチュートリアルに従ってください。

Node.jsをインストールしたら、YarnパッケージマネージャーをインストールするためにStep 1に進んでください。

Step 1 — Yarnをグローバルにインストールする

Yarnは、JavaScriptプロジェクトで自身をインストールして実行する独自の方法を持っています。まず、yarnコマンドをグローバルにインストールし、次に、プロジェクトディレクトリに特定のローカルバージョンのYarnをインストールするためにグローバルyarnコマンドを使用します。これにより、プロジェクトで作業しているすべての人（およびプロジェクトのすべての自動テストおよび展開ツール）が同じバージョンのyarnを実行していることを確認し、一貫性のある動作と結果を確保する必要があります。Yarnのメンテナーは、Yarnをグローバルにインストールすることを、すべてのNode.jsインストールにデフォルトで含まれるNPMパッケージマネージャーを使用して行うことを推奨しています。これを行うには、npm installコマンドに-gフラグを使用します。

Yarnのメンテナーは、YarnをグローバルにインストールするためにNPMパッケージマネージャーを使用することを推奨しています。これは、すべてのNode.jsインストールにデフォルトで含まれています。-gフラグをnpm installと共に使用してこれを行うことができます:

  1. sudo npm install -g yarn

パッケージがインストールされた後、yarnコマンドを使用して独自のバージョン番号を印刷します。これにより、適切にインストールされたことを確認できます:

  1. yarn --version



Output
1.22.11

これで、グローバルにインストールされたyarnコマンドを使用して、特定のJavaScriptプロジェクトにYarnをインストールできます。

ステップ2 — プロジェクト内のYarnのインストール

既存のYarnベースのプロジェクトでYarnを使用している場合は、このステップをスキップできます。プロジェクトは、すでにYarnのローカルバージョンと、それを使用するために必要なすべての設定ファイルで設定されているはずです。

独自の新しいプロジェクトを設定している場合は、現在プロジェクト固有のバージョンのYarnを設定したいと思うでしょう。

まず、プロジェクトのディレクトリに移動します。

  1. cd ~/my-project

プロジェクトディレクトリがない場合は、mkdirを使用して新しいディレクトリを作成し、それに移動できます。

  1. mkdir my-project

  2. cd my-project

次に、yarn setコマンドを使用してバージョンをberryに設定します。

  1. yarn set version berry

これにより、現在のアクティブに開発されているYarnのバージョンであるberryがダウンロードされ、プロジェクト内の.yarn/releases/ディレクトリに保存され、.yarnrc.yml設定ファイルも設定されます。

Output
Resolving berry to a url...
Downloading https://github.com/yarnpkg/berry/raw/master/packages/berry-cli/bin/berry.js...
Saving it into /home/sammy/my-project/.yarn/releases/yarn-berry.cjs...
Updating /home/sammy/my-project/.yarnrc.yml...
Done!

また、yarn --versionコマンドを試してみてください:

  1. yarn --version



Output
3.0.0

あなたはバージョンが3.0.0以上であることを確認するでしょう。これはYarnの最新リリースです。

注意:プロジェクトディレクトリからcdを実行し、yarn --versionを再び実行すると、再びグローバルなYarnのバージョン番号である1.22.11が表示されます。yarnを実行するたびに、コマンドのグローバルインストールされたバージョンを使用します。グローバルなyarnコマンドは最初に、.yarnrc.ymlファイルが含まれているYarnプロジェクトディレクトリであるか確認し、そうであれば、プロジェクトのyarnPath設定で構成されたプロジェクト固有のバージョンのYarnにコマンドを渡します。

あなたのプロジェクトは、プロジェクト固有のバージョンのYarnで設定されています。次に、いくつかの一般的に使用されるyarnコマンドを見て、始めるためにどのようなものがあるかを見てみましょう。

Yarnの使用

Yarnには多くのサブコマンドがありますが、始めるために必要なのはいくつかです。それらの最初のサブコマンドについて見てみましょう。

ヘルプの取得

新しいツールで始めるときは、オンラインヘルプにアクセスする方法を学ぶことが役立ちます。Yarnでは、--helpフラグを追加して、より多くの情報を取得できます。

  1. yarn --help

これは、yarnコマンドの全体的なヘルプを表示します。サブコマンドに関するより具体的な情報を取得するには、サブコマンドの後に--helpを追加します:

  1. yarn install --help

これは、yarn installコマンドの使い方の詳細を表示します。

新しいYarnプロジェクトの開始

新しいプロジェクトから始める場合は、initサブコマンドを使用して、必要なYarn固有のファイルを作成します:

  1. yarn init

これにより、package.json設定ファイルとyarn.lockファイルがディレクトリに追加されます。package.jsonには、設定とモジュールの依存関係のリストが含まれています。yarn.lockファイルはロックしており、依存関係のツリーが常に一貫していることを保証します。

プロジェクトのすべての依存関係のインストール

既存のYarnベースのプロジェクトの依存関係をすべてダウンロードしてインストールするには、installサブコマンドを使用します:

  1. yarn install

これにより、開始に必要なモジュールがダウンロードおよびインストールされます。

プロジェクトへの新しい依存関係の追加

addサブコマンドを使用して、プロジェクトに新しい依存関係を追加します:

  1. yarn add package-name

これにより、モジュールがダウンロードされ、インストールされ、package.jsonとyarn.lockファイルが更新されます。

Yarn用に.gitignoreファイルを更新する

Yarnは、プロジェクトディレクトリ内の.yarnフォルダにファイルを保存します。これらのファイルの一部はバージョン管理に含めるべきであり、他のファイルは無視すべきです。Yarnの基本的な.gitignore構成は次の通りです:

.gitignore
.yarn/*
!.yarn/patches
!.yarn/releases
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
.pnp.*

これは、.yarnディレクトリ全体を無視し、重要なフォルダ（プロジェクト固有のYarnバージョンが含まれるreleasesディレクトリを含む）に対するいくつかの例外を追加します。

GitとYarnの設定方法の詳細については、.gitignoreに関する公式のYarnドキュメントを参照してください。

結論

このチュートリアルでは、Yarnをインストールし、いくつかのyarnサブコマンドについて学びました。Yarnの使用方法に関する詳細情報は、公式のYarn CLIドキュメントをご覧ください。

より一般的なNode.jsおよびJavaScriptのヘルプについては、関連するチュートリアル、技術講演、コミュニティQ&AがあるNode.jsタグページとJavaScriptタグページをご覧ください。

Source:
https://www.digitalocean.com/community/tutorials/how-to-install-and-use-the-yarn-package-manager-for-node-js