パッケージ管理の基本

依存関係とは、サードパーティ製のソフトウェアであり、おそらく他の誰かによって作成されたものであり、理想的には 1 つの問題を解決してくれます。ウェブプロジェクトには、0 から多数の範囲で任意の数の依存関係を含めることができます。また依存関係には、明示的にインストールしていないサブ依存関係が含まれる場合があります。依存関係には、独自の依存関係がある場合があります。

プロジェクトで必要になる可能性のある便利な依存関係の簡単な例は、相対日付を人間が判読できるテキストとして計算するコードです。もちろん自分でコーディングすることもできますが、他の誰かがすでにこの問題を解決している可能性が高いです。さらに、信頼できるサードパーティの依存関係は、さまざまな状況でテストされている可能性が高く、独自のソリューションよりも堅牢でクロスブラウザー互換性があります。

プロジェクトの依存関係は、React や Vue などの JavaScript ライブラリーまたはフレームワーク全体、または人間が読める日付ライブラリーのような非常に小さなユーティリティ、または以前の記事で説明した Prettier や ESLint などのコマンドラインツールである可能性があります。

最新のビルドツールがなければ、単純な <script> 要素を使用して、このような依存関係をプロジェクトに含めることができますが、これはすぐには機能しない可能性があります。また、コードと依存関係がウェブ上にリリースされるときに、コードと依存関係を一緒にバンドルするための最新のツールが必要になる可能性があります。バンドルとは、通常、ソフトウェアのすべての JavaScript を含むウェブサーバー上の単一のファイルを指すために使用される用語です。通常、ソフトウェアをダウンロードしてブラウザーの訪問者に表示にかかる時間を短縮するために、可能な限り圧縮されています。

さらに、現在のツールの代わりに使用したいより良いツールを見つけた場合、または更新したい依存関係の新しいバージョンがリリースされた場合はどうなりますか? これは、いくつかの依存関係についてはそれほど苦痛ではありませんが、多くの依存関係がある大規模なプロジェクトでは、この種のことを追跡するのが非常に困難になる可能性があります。npm などの パッケージ マネージャー を使用する方が理にかなっています。これにより、コードがクリーンに追加および削除され、他の多くの利点が得られることが保証されます。

npm については既に触れましたが、npm 自体から離れて、パッケージマネージャーはプロジェクトの依存関係を管理するシステムです。

パッケージマネージャーは、新しい依存関係 (「パッケージ」とも呼ばれます) をインストールする方法を提供し、ファイルシステム上のパッケージの保存場所を管理し、独自のパッケージを公開する機能を提供します。

理論的には、パッケージマネージャーは必要なく、プロジェクトの依存関係を手動でダウンロードして保存することもできますが、パッケージマネージャーはパッケージのインストールとアンインストールをシームレスに処理します。使用していない場合は、手動で処理する必要があります。

• すべての正しいパッケージ JavaScript ファイルの検索。
• それらをチェックして、既知の脆弱性がないことを確認します。
• それらをダウンロードして、プロジェクト内の正しい場所に配置します。
• アプリケーションにパッケージを含めるためのコードを作成します (これは、よく読んで理解する価値のあるもう 1 つの主題である JavaScript モジュール モジュールを使用して行われます)。
• すべてのパッケージのサブ依存関係 (数十または数百になる可能性があります) に対して同じことを行います。
• パッケージを削除する場合は、すべてのファイルを再度削除します。

さらに、パッケージマネージャーは重複した依存関係 (フロントエンド開発で重要かつ一般的になるもの) を処理します。

npm (と JavaScript と Node ベースのパッケージマネージャー) の場合、依存関係をインストールする場所には 2 つのオプションがあります。前回の記事で触れたように、依存関係はプロジェクトにグローバルまたはローカルにインストールできます。グローバルにインストールする方がメリットが多い傾向にありますが、コードの移植性やバージョンのロックなど、ローカルにインストールする方がより重要です。

たとえば、プロジェクトが特定の構成の Webpack に依存している場合、そのプロジェクトを別のマシンにインストールしたり、後でそのプロジェクトに戻ったりした場合でも、構成が引き続き機能することを確認する必要があります。異なるバージョンの Webpack がインストールされている場合、互換性がない可能性があります。これを軽減するために、依存関係がプロジェクトにローカルにインストールされます。

ローカルの依存関係が本当に輝いていることを確認するには、既存のプロジェクトをダウンロードして実行するだけです。ーそれが機能し、すべての依存関係が箱から出してすぐに機能する場合、コードが移植可能であるという事実に感謝するローカル依存関係があります。

パッケージマネージャーが機能するには、どこからパッケージをインストールするかを知る必要があり、これはパッケージレジストリーの形式で提供されます。レジストリーは、パッケージが公開され、そこからインストールできる中心的な場所です。npm は、パッケージマネージャーであるだけでなく、JavaScript パッケージで最も一般的に使用されるパッケージ レジストリーの名前でもあります。npm レジストリーは npmjs.com にあります。

npm だけが選択肢ではありません。独自のパッケージ レジストリーを管理できます。Microsoft Azure などの製品を使用すると、npm レジストリーへのプロキシを作成できます (特定のパッケージをオーバーライドまたはロックできます)。GitHub もパッケージレジストリーサービス提供しています。 であり、時間が経つにつれてより多くのオプションが表示される可能性があります。

重要なのは、自分に最適なレジストリーを選択したことを確認することです。多くのプロジェクトで npm が使用されるため、モジュールの残りの例ではこれに関係します。

パッケージマネージャーとレジストリーを使用してコマンドラインユーティリティをインストールするための例を見てみましょう。

Parcel は、開発者が開発プロセスでよく使用する別のツールです。Parcel は、依存関係の呼び出しについてコードの内容を監視し、コードが必要とするすべての依存関係を自動的にインストールするという点で賢いです。また、コードを自動的にビルドすることもできます。

まず、実験的なアプリを保存するための新しいディレクトリーを作成します。これを parcel-experiment と呼びますが、好きなように呼ぶことができます。

mkdir parcel-experiment
cd parcel-experiment

次に、構成ファイルを作成する npm パッケージとしてアプリを初期化しましょう — package.json — これにより、後でこの環境を再作成したり、パッケージを npm レジストリーに公開したりする場合に備えて、構成の詳細を保存できます (ただし、これはこの記事の範囲を超えています)。

parcel-experiment ディレクトリー内で、次のコマンドを入力します。

npm init

ここで、いくつか質問されます。npm は、回答に基づいてデフォルトの package.json ファイルを作成します。

• name: アプリを識別するための名前。 Return を入力するとデフォルトの parcel-experiment がアプリ名になります。
• version: アプリの開始バージョン番号。 再度 Return を入力するとデフォルトの 1.0.0 がアプリの開始バージョン番号になります。
• description: アプリの目的の簡単な説明。 「npm の使い方を学ぶための簡単な npm パッケージ」など、非常に簡単なことを入力してから、 Return を入力します。
• entry point: これは、アプリの最上位の JavaScript ファイルになります。 今のところデフォルトの index.js で問題ないので Return を入力します。
• test command, git repository, と keywords : それぞれを入力する時は、空白のままにして Return を入力します。
• author: プロジェクトの作成者。 自分の名前を入力し、Return を入力します。
• license: パッケージを公開するためのライセンス。 ここではデフォルトを設定するので Return を入力します。

これらの設定を受け入れるためにもう一度 Return を入力します。

parcel-experiment ディレクトリーに移動すると、package.json ファイルが作成されていることがわかります。それを開くと、次のようになります。

{
  "name": "parcel-experiment",
  "version": "1.0.0",
  "description": "A simple npm package to learn about using npm",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Chris Mills",
  "license": "ISC"
}

したがって、これはパッケージを定義する構成ファイルです。今はこれでいいので、先に進みます。

次のコマンドを実行して、Parcel をローカルにインストールします。

npm install parcel-bundler

上記コマンドが全て完了すると、「最新のクライアント側開発」の準備が整います (これは、ビルドツールを使用して、開発者のエクスペリエンスを少し簡単にすることを意味します)。ただし、まず最初に、package.json ファイルをもう一度見てください。npm が新しいフィールドの依存関係を追加したことがわかります。

"dependencies": {
  "parcel-bundler": "^1.12.4"
}

これは npm マジックの一部です。将来、コードベースを別の場所、別のマシンに移動した場合、コマンドを実行して同じセットアップを再作成できます。npm install を実行すると npm が依存関係を調べてインストールします。

欠点の 1 つは、Parcel が parcel-experiment アプリ内でしか利用できないことです。別のディレクトリーで実行することはできません。しかし、利点は欠点を上回ります。

とにかく、セットアップを続けます。

Parcel は index.html と index.js ファイルが動作することを期待していますが、それ以外の場合、プロジェクトをどのように構築するかについて非常に意見がありません。他のツールは非常に異なる場合がありますが、少なくとも Parcel は最初の実験を容易にします。

そのため、 index.html ファイルを作業ディレクトリーに追加する必要があります。テストディレクトリーに index.html を作成し、次の内容を指定します。

<!doctype html>
<html lang="en-US">
  <head>
    <meta charset="utf-8" />
    <title>My test page</title>
  </head>
  <body>
    <script src="./index.js"></script>
  </body>
</html>

次に、 index.html と同じディレクトリーに index.js ファイルを追加する必要があります。今のところ、 index.js は空で構いません。存在する必要があるだけです。これを今すぐ作成します。

次に、新しくインストールした Parcel ツールを実行します。ターミナルで、次のコマンドを実行します。

 parcel index.html

ターミナルに次のような出力が表示されるはずです。

Server running at http://localhost:1234
✨  Built in 193ms.

これで、完全な JavaScript パッケージ エコシステムを活用する準備が整いました。まず、 http://localhost:1234 で実行されているローカルウェブサーバーがあります。ここにアクセスすると、今のところ何も表示されませんが、すばらしいのは、アプリに変更を加えると、Parcel がアプリを再構築してサーバーを自動的に更新するため、更新の効果をすぐに確認できることです。

次に、いくつかのページ コンテンツについて説明します。「2時間前」、「4日前」など、人間が読める相対的な日付を表示したいとしましょう。date-fns パッケージの formatDistanceToNow() メソッドは役立ちます (同じことを行う他のパッケージもあります)。

index.js ファイルに次のコードを追加して保存します。

import { formatDistanceToNow } from "date-fns";

const date = "1996-09-13 10:00:00";
document.body.textContent = `${formatDistanceToNow(new Date(date))} ago`;

http://localhost:1234 に戻ると、作者が 18 歳になってからどれくらい経ったかがわかります。

上記のコードで特に特別なのは、インストールしていない date-fns パッケージの formatDistanceToNow() 関数を使用していることです! Parcel は、モジュールが必要であることを発見し、 npmjs.com パッケージ レジストリーで検索して、自動的にローカルにインストールしました。これは、 package.json ファイルをもう一度見ることで証明できます — dependencies フィールドが更新されていることがわかります。

"dependencies": {
  "date-fns": "^2.12.0",
  "parcel-bundler": "^1.12.4"
}

Parcel は、他の誰かがこのプロジェクトを取得し、使用した依存関係をインストールするために必要なファイルも追加しました。parcel コマンドを実行したディレクトリーを調べると、多数の新しいファイルが見つかります。最も興味深いものは次のとおりです。

• node_modules: Parcel と date-fns の依存ファイル。
• dist: 配布ディレクトリー — これらは、自動的にパッケージ化され、Parcel がビルドして縮小したファイルであり、 localhost:1234 で提供されているファイルです。これらは、サイトを公開してオンラインで公開するときにウェブサーバーにアップロードするファイルです。

パッケージ名を知っている限り、コードでそれを使用でき、Parcel はパッケージをローカルディレクトリー (node_modules の下) に取り出し、フェッチし、インストール (実際には「コピー」) します。

ただし、このコードは本番用の準備ができていません。ほとんどのビルドツール システムには、「開発モード」と「プロダクションモード」があります。重要な違いは、開発で使用する便利な機能の多く、たとえば「hot module replacement」、「live reloading」、「uncompressed and commented source code」が最終サイトでは必要ないため、本番環境では取り除かれることです。すべてを網羅しているわけではありませんが、これらは一般的なウェブ開発機能の一部であり、開発段階では非常に役立ちますが、本番環境ではあまり役に立ちません。本番環境では、サイトが肥大化するだけです。

Ctrl + C を使用して、前の Parcel コマンドを停止します。

これで、架空の展開用に最小限のサンプルサイトを準備できます。Parcel は、発行に適したファイルを生成する追加のコマンドを提供し、build オプションでバンドル (前述) を作成します。

次のコマンドを実行します。

parcel build index.html

次のような出力が表示されるはずです。

✨  Built in 9.35s.

dist/my-project.fb76efcf.js.map    648.58 KB     64ms
dist/my-project.fb76efcf.js        195.74 KB    8.43s
dist/index.html                        288 B    806ms

繰り返しますが、本番ファイルのディレクトリーは、 dist です。

ただし、開発者を「助ける」すべてのツールと同様に多くの場合、トレードオフがあります。この特定のケースでは、それはファイルサイズです。JavaScript バンドル my-project.fb76efcf.js はなんと 195K にもなり、1 行のテキストを出力するだけなので非常に大きいです。確かに多少の計算は行いますが、これを行うために 195K 相当の JavaScript は絶対に必要ありません!

開発ツールを使用するときは、それが正しいことを行っているかどうかを検討する価値があります。この場合、使用している関数だけでなく、実際には date-fns ライブラリー全体が含まれているため、バンドルはほぼ 200K になります。

開発ツールを一切使用せず、 <script src=""> 要素を date-fns のホストされたバージョンに向けていた場合、ほぼ同じことが起こっていたでしょう — サンプルページのときにすべてのライブラリーがダウンロードされます。ブラウザーに読み込まれます。

ただし、ここで開発ツールが活躍する可能性があります。ツールがマシン上にある間、ソフトウェアにコードの使用を検査し、本番環境で実際に使用している関数のみを含めるように依頼できます。これは「ツリーシェーキング」と呼ばれるプロセスです。

これは、ファイルサイズを小さくしてアプリの読み込みをできるだけ速くしたいため、非常に理にかなっています。さまざまなツールを使用すると、さまざまな方法でツリーを振ることができます。

リストは月ごとに増えていきますが、ソース コードからバンドルを生成するツールには、Webpack、Rollup、および Parcel の 3 つの主なオファリングがあります。これ以外にも利用できるようになりますが、これらは人気のあるものです。

• RollUp ツールは、そのコア機能としてツリーシェイキングとコード分割を提供します。
• Webpack にはいくつかの構成が必要です (「一部」という表現は、一部の開発者の Webpack 構成の複雑さを過小評価している可能性があります)。
• (Parcel version 2 より前の) Parcel の場合、特別なフラグが必要です — --experimental-scope-hoisting — ビルド中にツリーシェークが発生します。

すでにインストールされていることを考えると、今のところ Parcel に固執しましょう。次のコマンドを実行してみてください。

parcel build index.html --experimental-scope-hoisting

これにより大きな違いが生じることがわかります。

✨  Built in 7.87s.

dist/my-project.86f8a5fc.js    10.34 KB    7.17s
dist/index.html                   288 B    753ms

現在バンドルは約 10K です。かなり良くなりました。

このプロジェクトをサーバーにリリースする場合、dist フォルダー内のファイルのみをリリースします。Parcel は、すべてのファイル名の変更を自動的に処理してくれました。Parcel が自動的に実行した変更を確認できるように、 dist/index.html のソースコードを確認することをお勧めします。

利用可能なツールはたくさんあり、JavaScript パッケージのエコシステムは前例のない速度で成長していますが、これには長所と短所があります。常に改善が行われており、良くも悪くも選択肢が増え続けています。圧倒的なツールの選択に直面した場合、おそらく最も重要な教訓は、選択したツールで何ができるかを学ぶことです。

このチュートリアルでは npm を使用して Parcel パッケージをインストールしましたが、前述のようにいくつかの代替手段があります。少なくともそれらが存在することを知って、ツール間で共通のコマンドについて漠然とした考えを持つことは価値があります。すでにいくつかの動作を見てきましたが、他のものを見てみましょう。

リストは時間の経過とともに増加しますが、執筆時点では、次の主要なパッケージマネージャーが利用可能です。

• npm at npmjs.org
• pnpm at pnpm.js.org
• Yarn at yarnpkg.com

npm と pnpm は、コマンド ラインの観点からは似ています。実際、pnpm は、npm が提供する引数オプションと完全に同等であることを目指しています。パッケージをダウンロードしてコンピューターに保存する方法が異なり、必要な全体的なディスク容量を削減することを目的としています。

以下の例では npm が示されていますが、pnpm を入れ替えると、コマンドが機能します。

多くの場合、インストールプロセスに関しては、yarn は npm よりも高速であると考えられています(マイレージは異なる場合があります)。依存関係のインストール(およびコンピューターへのコピー)を待つためにかなりの時間が浪費される可能性があるため、これは開発者にとって重要です。

パッケージマネージャーで実行する一般的なアクションを確認しましょう。

npm init
yarn init

上記のように、これにより一連の質問が表示され、プロジェクトを説明するための一連の質問(名前、ライセンス、説明など) が表示されます。package.json プロジェクトとその依存関係に関するメタ情報が含まれています。

npm install date-fns
yarn add date-fns

上記の動作で install も見ました。これにより、 date-fns パッケージが、 date-fns 自体の依存関係とともに、 node_modules と呼ばれるサブディレクトリー内の作業ディレクトリーに直接追加されます。

デフォルトでは、このコマンドは「date-fns」の最新バージョンをインストールしますが、これも制御できます。date-fns@1 を要求すると、最新の 1.x バージョン (1.30.1) が得られます。または、date-fns@^2.3.0 を試すこともできます。これは、2.3.0 以降 (執筆時点では 2.8.1) の最新バージョンを意味します。

npm update
yarn upgrade

これにより、現在インストールされている依存関係が調べられ、利用可能な更新がある場合は、パッケージで指定されている範囲内で更新されます。

範囲は、 package.json の依存関係のバージョンで指定され、 date-fns@^2.0.1 — この場合、キャレット文字 ^ 2.0.1 以降、3.0.0 を除くすべてのマイナーおよびパッチリリースを意味します。

これは semver と呼ばれるシステムを使用して決定されます。このシステムはドキュメントから見ると少し複雑に見えるかもしれませんが、要約情報とバージョンが MAJOR.MINOR.PATCH 、たとえば 2.0.1 はメジャーバージョン 2 でパッチバージョン 1 です。semver 値を試す優れた方法は、semver Calculator を使用することです。

npm update は依存関係を package.json で定義された範囲を超えてアップグレードしないことを覚えておくことが重要です — これを行うには、そのバージョンを具体的にインストールする必要があります。

npm audit
yarn audit

これにより、プロジェクトのすべての依存関係ツリーがチェックされ、使用している特定のバージョンが脆弱性データベースに対して実行され、プロジェクトに潜在的な脆弱なパッケージがあるかどうかが通知されます。

脆弱性について学習するための出発点として 、JavaScript パッケージと他のプログラミング言語の両方をカバーする Snyk プロジェクト をお勧めします。

npm ls date-fns
yarn why date-fns

このコマンドは、インストールされている依存関係のバージョンと、それがどのようにプロジェクトに含まれるようになったかを示します。別の最上位パッケージが date-fns を取り込んだ可能性があります。プロジェクトに複数のバージョンのパッケージが存在する可能性も同様にあり得ます(そして理想的ではありません)(これは非常に便利な lodash パッケージで何度も見られます)。

パッケージマネージャーはパッケージの重複を排除するために最善を尽くしますが、インストールされているバージョンを正確に調査することをお勧めします。

npm および yarn の個々のコマンドの詳細をオンラインで確認できます。繰り返しますが、pnpm コマンドは npm と同等であり、いくつかの追加があります。

パッケージマネージャーは、独自のコマンドの作成とコマンドラインからの実行もサポートしています。たとえば、次のコマンドを作成できます。

npm run dev
# or yarn run dev

これにより、プロジェクトを「開発モード」で開始するためのカスタム スクリプトが実行されます。実際、ローカルでの開発セットアップは本番環境での実行方法とは若干異なる傾向があるため、すべてのプロジェクトにこれを定期的に含めています。

以前の Parcel テストプロジェクトでこれを実行しようとすると、(おそらく) 「dev script is missing」 と表示されます。これは、npm、Yarn (など) が package.json ファイルの scripts プロパティで dev というプロパティを探しているためです。

Parcel はコマンド parcel serve filename.html を使用して開発サーバーを実行できます。これを開発中に頻繁に使用したいと考えています。

それでは、package.json にカスタムの省略形コマンド「dev」を作成しましょう。

前のチュートリアルに従った場合は、パーセル実験ディレクトリー内に package.json ファイルがあるはずです。それを開くと、その scripts メンバーは次のようになります。

"scripts": {
  "test": "echo \"Error: no test specified\" && exit 1",
},

次のように更新し、ファイルを保存します。

"scripts": {
  "test": "echo \"Error: no test specified\" && exit 1",
  "dev": "parcel serve index.html"
},

カスタム dev コマンドを npm スクリプトとして追加しました。

ターミナルで次のコマンドを実行してみてください。parcel-experiment ディレクトリー内にいることを確認してください。

 npm run dev

これにより前に見たように、Parcel が起動し、ローカルの開発サーバーで index.html が提供されます。

Server running at http://localhost:1234
✨  Built in 5.48s.

さらに、npm (および yarn) コマンドは、プロジェクトにローカルにインストールされているコマンド ライン ツールを検索してから、従来の方法(コンピューターが通常ソフトウェアを格納して検索できるようにする場所)で検索するという点で優れています。run コマンドの技術的な複雑さについて詳しく知ることができますが、ほとんどの場合、独自のスクリプトは問題なく実行されます。

仕事をするのに役立つあらゆる種類のものを scripts プロパティに追加できます。私たちは確かに持っていますし、他も持っています。

これで、パッケージマネージャーのツアーは終了です。次のステップは、これまでに学んだことをすべて実践して、ツールチェーンのサンプルを構築することです。

• 前のページ
• Overview: クライアントサイドウェブ開発ツールの理解
• 次のページ

• npm スクリプト リファレンス
• package.json リファレンス