Node.jsのためのYarnパッケージマネージャーのインストールと使用方法
紹介
Yarnは、速度、セキュリティ、そして一貫性に重点を置いたNode.js用のパッケージマネージャーです。元々は、人気のあるNPMパッケージマネージャーに関するいくつかの問題を解決するために作成されました。その後、2つのパッケージマネージャーはパフォーマンスや機能の面で収束しましたが、Yarnは特にReact開発の世界では人気のままです。
Yarnの独自の特徴には次のようなものがあります:
- プロジェクトごとのキャッシングメカニズムは、その後のインストールやビルドを大幅に高速化することができます。
- 一貫性があり決定論的なインストールにより、インストールされたライブラリの構造が常に同じであることが保証されます。
- すべてのパッケージのチェックサムテストを行い、その整合性を確認する
- 「ワークスペース」は、モノレポ(単一のソースコードリポジトリで開発された複数のプロジェクト)でYarnを使用するのを容易にします。
このチュートリアルでは、Yarnをグローバルにインストールし、特定のプロジェクトにYarnを追加し、いくつかの基本的なYarnコマンドを学びます。
DigitalOcean App Platformを使用して、GitHubからフロントエンドアプリケーションをデプロイします。アプリのスケーリングにDigitalOceanが集中できるようにしましょう。
Node.jsのためのYarnパッケージマネージャーのインストールと使用
- Yarnをグローバルにインストールする
- プロジェクトにYarnをインストールする
- ヤーンを使用する
前提条件
Yarnパッケージマネージャーをインストールして使用する前に、Node.jsをインストールしておく必要があります。すでにNode.jsがインストールされているかどうかを確認するには、ローカルのコマンドラインターミナルに次のコマンドを入力してください:
- node -v
バージョン番号が印刷されている場合、例えばv12.16.3、Node.jsがインストールされています。コマンドが見つかりませんというエラー(または類似の表現)が表示された場合は、続行する前にNode.jsをインストールしてください。
Node.jsをインストールするには、Ubuntu、Debian、CentOS、またはmacOS向けのチュートリアルに従ってください。
Node.jsをインストールしたら、次にYarnパッケージマネージャーをインストールするためのステップ1に進んでください。
ステップ1 — Yarnをグローバルにインストールする
Yarnは、あなたのJavaScriptプロジェクトにおいて、独自のインストールと実行方法を持っています。まず、yarnコマンドをグローバルにインストールし、その後グローバルなyarnコマンドを使用して、特定のローカルバージョンのYarnをプロジェクトディレクトリにインストールします。これは、プロジェクトで作業しているすべての人(およびプロジェクトの自動テストやデプロイメントツールすべて)が同じバージョンのyarnを実行していることを保証するために必要であり、不一致な動作や結果を避けるためです。
Yarnのメンテイナーは、すべてのNode.jsインストールにデフォルトで含まれるNPMパッケージマネージャーを使用して、Yarnをグローバルにインストールすることを推奨しています。これを行うには、npm installに-gフラグを使用してください:
- sudo npm install -g yarn
パッケージのインストール後に、yarn コマンドが自分自身のバージョン番号を表示するようにします。これにより、正しくインストールされたかどうかを確認できます:
- yarn --version
1.22.11
グローバルに yarn コマンドがインストールされたので、特定のJavaScriptプロジェクトにYarnをインストールするためにそれを使用できます。
ステップ2 — プロジェクトにYarnをインストールする
既存のYarnベースのプロジェクトを使用している場合、このステップをスキップできます。プロジェクトは、Yarnのローカルバージョンと、使用するために必要なすべての設定ファイルをすでに用意しているはずです。
新しいプロジェクトを自分で設定する場合は、今、プロジェクト固有のYarnのバージョンを設定する必要があります。
まず、プロジェクトディレクトリに移動します:
- cd ~/my-project
プロジェクトディレクトリがない場合は、mkdirを使って新しいディレクトリを作成し、その中に移動できます:
- mkdir my-project
- cd my-project
yarn setコマンドを使って、バージョンをberryに設定してください:
- yarn set version berry
これにより、現在アクティブに開発されているYarnのバージョン - berry - がダウンロードされ、プロジェクトの.yarn/releases/ディレクトリに保存され、.yarnrc.ymlの設定ファイルもセットアップされます:
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コマンドを試してください:
- yarn --version
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では、--helpフラグを任意のコマンドに追加することで、さらに情報を得ることができます。
- yarn --help
これはyarnコマンドの全体的なヘルプを表示します。サブコマンドに関するより具体的な情報を得るには、サブコマンドの後に--helpを追加してください:
- yarn install --help
yarn installコマンドの使用方法に関する詳細が印刷されます。
新しい糸プロジェクトを始める
プロジェクトをゼロから始める場合、initサブコマンドを使用して、必要なYarn特有のファイルを作成してください:
- yarn init
これにより、package.json 設定ファイルと yarn.lock ファイルがあなたのディレクトリに追加されます。package.json には設定とモジュール依存関係のリストが含まれています。yarn.lock ファイルは、これらの依存関係を特定のバージョンにロックし、常に依存関係ツリーが一貫性を保つようにします。
プロジェクトのすべての依存関係をインストールする
既存のYarnベースのプロジェクトにすべての依存関係をダウンロードしてインストールするには、installサブコマンドを使用します:
- yarn install
これにより、始めるために必要なモジュールがダウンロードされ、インストールされます。
プロジェクトに新しい依存関係を追加する
add サブコマンドを使用してプロジェクトに新しい依存関係を追加します:
- yarn add package-name
これにより、モジュールがダウンロードされ、インストールされ、あなたの package.json と yarn.lock ファイルが更新されます。
Yarnのための.gitignoreファイルの更新
Yarnはプロジェクトディレクトリ内に.yarnフォルダーにファイルを保存します。これらのファイルのいくつかはバージョン管理にチェックインすべきであり、他のファイルは無視するべきです。Yarnの基本的な.gitignore設定は次の通りです:
.yarn/*
!.yarn/patches
!.yarn/releases
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
.pnp.*
これは全体の.yarnディレクトリを無視し、重要なフォルダのいくつかに例外を追加します。この中には、プロジェクト固有のYarnのバージョンを含むreleasesディレクトリが含まれています。
GitとYarnの設定方法の詳細については、公式のYarnドキュメントの.gitignoreを参照してください。
結論
このチュートリアルでは、Yarnをインストールし、いくつかのyarnサブコマンドについて学びました。Yarnの使用に関する詳細情報は、公式のYarn CLIドキュメントをご覧ください。
Node.jsやJavaScriptに関する一般的なヘルプについては、関連するチュートリアルや技術トーク、コミュニティQ&Aが見つかるNode.jsおよびJavaScriptタグページをご覧ください。