Visual Studio の ASP.NET Core で LibMan を使用する

[アーティクル]
11/06/2024

作成者: Scott Addie

Visual Studio には、ASP.NET Core プロジェクトでの LibMan に対する次のようなサポートが組み込まれています。

ビルド時に LibMan の復元操作を構成して実行するためのサポート。
LibMan の復元操作とクリーン操作をトリガーするためのメニュー項目。
ライブラリを検索し、プロジェクトにファイルを追加するための検索ダイアログ。
LibMan マニフェストファイル libman.json の編集サポート。

サンプルコードを表示またはダウンロードします (ダウンロード方法)。

前提条件

Visual Studio 2019 と ASP.NET と Web 開発ワークロード

ライブラリファイルを追加する

ライブラリファイルは、次の 2 つの方法で ASP.NET Core プロジェクトに追加できます。

[クライアント側のライブラリを追加します] ダイアログを使用する
LibMan マニフェストファイルエントリを手動で構成する

[クライアント側のライブラリを追加します] ダイアログを使用する

クライアント側ライブラリをインストールするには、次の手順に従います。

ソリューションエクスプローラーで、ファイルを追加するプロジェクトフォルダーを右クリックします。 [追加]>[クライアント側のライブラリ] を選択します。 [クライアント側のライブラリを追加します] ダイアログが表示されます。
[プロバイダー] ドロップダウンからライブラリプロバイダーを選択します。 CDNJS が既定のプロバイダーです。
[ライブラリ] テキストボックスに、フェッチするライブラリ名を入力します。 IntelliSense により、指定したテキストで始まるライブラリの一覧が表示されます。
IntelliSense の一覧からライブラリを選択します。ライブラリ名には、@ 記号と、選択したプロバイダーによって認識される最新の安定バージョンがサフィックスとして付けられています。
含めるファイルを決定します。
- すべてのライブラリファイルを含めるには、 [Include all library files](すべてのライブラリファイルを含める) ラジオボタンを選択します。
- ライブラリのファイルのサブセットを含めるには、 [Choose specific files](特定のファイルを選択する) ラジオボタンを選択します。ラジオボタンを選択すると、ファイルセレクターツリーが有効になります。ダウンロードするファイルの名前の左側にあるボックスをオンにします。

[ターゲットの場所] テキストボックスで、ファイルを格納するプロジェクトフォルダーを指定します。各ライブラリを別々のフォルダーに保存することをお勧めします。

[ターゲットの場所] として提案されるフォルダーは、ダイアログを起動した場所に基づいています。

プロジェクトルートから起動した場合は、次のようになります。
- wwwroot が存在する場合は、wwwroot/lib が使用されます。
- wwwroot が存在しない場合は、lib が使用されます。
プロジェクトフォルダーから起動した場合は、対応するフォルダー名が使用されます。

提案されるフォルダーには、ライブラリ名がサフィックスとして付けられます。次の表は、Razor Pages プロジェクトに jQuery をインストールするときに提案されるフォルダーを示しています。

起動場所	提案されるフォルダー
プロジェクトルート (wwwroot が存在する場合)	wwwroot/lib/jquery/
プロジェクトルート (wwwroot が存在しない場合)	lib/jquery/
プロジェクトの Pages フォルダー	Pages/jquery/

[インストール] ボタンをクリックして、libman.json の構成に従ってファイルをダウンロードします。

インストールの詳細については、 [出力] ウィンドウの [ライブラリマネージャー] フィードを確認してください。次に例を示します。

Restore operation started...
Restoring libraries for project LibManSample
Restoring library jquery@3.3.1... (LibManSample)
wwwroot/lib/jquery/jquery.min.js written to destination (LibManSample)
wwwroot/lib/jquery/jquery.js written to destination (LibManSample)
wwwroot/lib/jquery/jquery.min.map written to destination (LibManSample)
Restore operation completed
1 libraries restored in 2.32 seconds

LibMan マニフェストファイルエントリを手動で構成する

Visual Studio のすべての LibMan 操作は、プロジェクトルートの LibMan マニフェスト (libman.json) のコンテンツに基づいています。 libman.json を手動で編集して、プロジェクトのライブラリファイルを構成できます。 libman.json が保存されると、Visual Studio ではすべてのライブラリファイルが復元されます。

編集のために libman.json を開くには、次のオプションがあります。

ソリューションエクスプローラーで libman.json ファイルをダブルクリックします。
ソリューションエクスプローラーでプロジェクトを右クリックし、 [クライアント側のライブラリを管理する] を選択します。
Visual Studio の [プロジェクト] メニューで、 [クライアント側のライブラリを管理する] を選択します。

†libman.json ファイルがプロジェクトルートにまだ存在しない場合は、既定の項目テンプレートコンテンツを使用して作成されます。

Visual Studio には、色付け、書式設定、IntelliSense、スキーマ検証などの豊富な JSON 編集サポートが用意されています。 LibMan マニフェストの JSON スキーマは、https://json.schemastore.org/libman にあります。

次のマニフェストファイルを使用すると、LibMan では、libraries プロパティに定義されている構成に従ってファイルが取得されます。 libraries 内で定義されているオブジェクトリテラルの説明を次に示します。

jQuery バージョン 3.3.1 のサブセットは、CDNJS プロバイダーから取得されます。このサブセットは、files プロパティ、すなわち、jquery.min.js、jquery.js、および jquery.min.map で定義されます。これらのファイルは、プロジェクトの wwwroot/lib/jquery フォルダーに格納されます。
ブートストラップバージョン 4.1.3 の全体が取得され、wwwroot/lib/bootstrap フォルダーに格納されます。オブジェクトリテラルの provider プロパティによって defaultProvider プロパティ値がオーバーライドされます。 LibMan により、unpkg プロバイダーからブートストラップファイルが取得されます。
Lodash のサブセットは、組織内の管理機関によって承認されています。 lodash.js ファイルと lodash.min.js ファイルは、C:\temp\lodash\ のローカルファイルシステムから取得されます。これらのファイルは、プロジェクトの wwwroot/lib/lodash フォルダーにコピーされます。

{
  "version": "1.0",
  "defaultProvider": "cdnjs",
  "libraries": [
    {
      "library": "jquery@3.3.1",
      "files": [
        "jquery.min.js",
        "jquery.js",
        "jquery.min.map"
      ],
      "destination": "wwwroot/lib/jquery/"
    },
    {
      "provider": "unpkg",
      "library": "bootstrap@4.1.3",
      "destination": "wwwroot/lib/bootstrap/"
    },
    {
      "provider": "filesystem",
      "library": "C:\\temp\\lodash\\",
      "files": [
        "lodash.js",
        "lodash.min.js"
      ],
      "destination": "wwwroot/lib/lodash/"
    }
  ]
}

Note

LibMan では、各プロバイダーのライブラリごとに 1 つのバージョンのみがサポートされます。 libman.json ファイルでは、特定のプロバイダーに対して同じライブラリ名を持つ 2 つのライブラリが含まれている場合、スキーマの検証に失敗します。

ライブラリファイルを復元する

Visual Studio 内からライブラリファイルを復元するには、プロジェクトルートに有効な libman.json ファイルが存在する必要があります。復元されたファイルは、各ライブラリに指定された場所にあるプロジェクトに配置されます。

ライブラリファイルは、ASP.NET Core プロジェクトで次の 2 つの方法で復元できます。

ビルド時にファイルを復元する
ファイルを手動で復元する

ビルド時にファイルを復元する

LibMan では、ビルドプロセスの一環として、定義済みのライブラリファイルを復元できます。既定では、"ビルド時の復元" 動作は無効になっています。

ビルド時の復元動作を有効にしてテストするには、次の手順に従います。

ソリューションエクスプローラーで libman.json を右クリックし、コンテキストメニューで [ビルド時にクライアント側のライブラリの復元を有効にする] をオンにします。
NuGet パッケージのインストールを求めるメッセージが表示されたら、 [はい] ボタンをクリックします。プロジェクトに Microsoft.Web.LibraryManager.Build NuGet パッケージが追加されます。
```
<PackageReference Include="Microsoft.Web.LibraryManager.Build" Version="1.0.113" />
```
プロジェクトをビルドして、LibMan ファイルの復元が実行されることを確認します。 Microsoft.Web.LibraryManager.Build パッケージにより、プロジェクトのビルド操作中に LibMan を実行する MSBuild ターゲットが挿入されます。

[出力] ウィンドウの [ビルド] フィードで LibMan アクティビティログを確認します。

1>------ Build started: Project: LibManSample, Configuration: Debug Any CPU ------
1>
1>Restore operation started...
1>Restoring library jquery@3.3.1...
1>Restoring library bootstrap@4.1.3...
1>
1>2 libraries restored in 10.66 seconds
1>LibManSample -> C:\LibManSample\bin\Debug\netcoreapp2.1\LibManSample.dll
========== Build: 1 succeeded, 0 failed, 0 up-to-date, 0 skipped ==========

ビルド時の復元動作が有効になっている場合は、 libman.json コンテキストメニューに [Disable Restore Client-Side Libraries on Build](ビルド時にクライアント側のライブラリの復元を無効にする) オプションが表示されます。このオプションを選択すると、プロジェクトファイルから Microsoft.Web.LibraryManager.Build パッケージ参照が削除されます。その結果、各ビルド時にクライアント側ライブラリは復元されなくなります。

ビルド時の復元設定に関係なく、libman.json コンテキストメニューからいつでも手動で復元を行うことができます。詳細については、「ファイルを手動で復元する」を参照してください。

ファイルを手動で復元する

ライブラリファイルを手動で復元するには、次の手順に従います。

ソリューション内のすべてのプロジェクトについて:
- ソリューションエクスプローラーでソリューション名を右クリックします。
- [クライアント側のライブラリを復元する] オプションを選択します。
特定のプロジェクトについて:
- ソリューションエクスプローラーで libman.json ファイルを右クリックします。
- [クライアント側のライブラリを復元する] オプションを選択します。

復元操作の実行時には、次の処理が行われます。

Visual Studio のステータスバーのタスクステータスセンター (TSC) アイコンがアニメーション化され、 [復元操作が開始されました] と表示されます。このアイコンをクリックすると、既知のバックグラウンドタスクを示すヒントが表示されます。

ステータスバーと、 [出力] ウィンドウの [ライブラリマネージャー] フィードに、メッセージが送信されます。次に例を示します。

Restore operation started...
Restoring libraries for project LibManSample
Restoring library jquery@3.3.1... (LibManSample)
wwwroot/lib/jquery/jquery.min.js written to destination (LibManSample)
wwwroot/lib/jquery/jquery.js written to destination (LibManSample)
wwwroot/lib/jquery/jquery.min.map written to destination (LibManSample)
Restore operation completed
1 libraries restored in 2.32 seconds

ライブラリファイルを削除する

Visual Studio で以前に復元されたライブラリファイルを削除するために "クリーン" 操作を実行するには、次の手順に従います。

ソリューションエクスプローラーで libman.json ファイルを右クリックします。
[クライアント側のライブラリをクリーンアップする] オプションを選択します。

ライブラリファイル以外が誤って削除されないように、クリーン操作ではディレクトリ全体が削除されることはありません。以前の復元に含まれていたファイルのみが削除されます。

クリーン操作の実行時には、次の処理が行われます。

Visual Studio の TSC アイコンがアニメーション化され、 [ライブラリのクリーン操作が開始されました] と表示されます。このアイコンをクリックすると、既知のバックグラウンドタスクを示すヒントが表示されます。
ステータスバーと、 [出力] ウィンドウの [ライブラリマネージャー] フィードに、メッセージが送信されます。次に例を示します。

Clean libraries operation started...
Clean libraries operation completed
2 libraries were successfully deleted in 1.91 secs

クリーン操作では、プロジェクトからファイルのみが削除されます。ライブラリファイルは、今後の復元操作で速やかに取得できるようにキャッシュに残っています。ローカルコンピューターのキャッシュに格納されているライブラリファイルを管理するには、LibMan CLI を使用します。

ライブラリファイルをアンインストールする

ライブラリファイルをアンインストールするには、次の手順に従います。

libman.json を開きます。
対応する libraries オブジェクトリテラル内にカレットを配置します。
左余白に表示される電球アイコンをクリックし、[<library_name>@<library_version> のアンインストール] を選択します。

または、LibMan マニフェスト (libman.json) を手動で編集して保存することもできます。ファイルが保存されると、復元操作が実行されます。 libman.json で定義されなくなったライブラリファイルは、プロジェクトから削除されます。

ライブラリバージョンを更新する

更新されたライブラリバージョンを確認するには、次の手順に従います。

libman.json を開きます。
対応する libraries オブジェクトリテラル内にカレットを配置します。
左余白に表示される電球アイコンをクリックします。 [更新プログラムの確認] にカーソルを合わせます。

LibMan により、インストールされているバージョンよりも新しいライブラリバージョンがないか確認されます。次の結果が生じる可能性があります。

最新バージョンが既にインストールされている場合は、 [更新プログラムが見つかりませんでした] メッセージが表示されます。
まだインストールされていない場合は、最新の安定バージョンが表示されます。
インストールされているバージョンよりも新しいプレリリースを使用できる場合は、プレリリースが表示されます。

古いライブラリバージョンにダウングレードするには、libman.json ファイルを手動で編集します。ファイルが保存されると、LibMan 復元操作によって次の処理が行われます。

以前のバージョンから冗長なファイルが削除されます。
新しいバージョンから新しいファイルと更新済みのファイルが追加されます。

次の方法で共有

Visual Studio の ASP.NET Core で LibMan を使用する

前提条件

ライブラリファイルを追加する

[クライアント側のライブラリを追加します] ダイアログを使用する

LibMan マニフェストファイルエントリを手動で構成する

ライブラリファイルを復元する

ビルド時にファイルを復元する

ファイルを手動で復元する

ライブラリファイルを削除する

ライブラリファイルをアンインストールする

ライブラリバージョンを更新する

その他の技術情報

その他のリソース

次の方法で共有

Visual Studio の ASP.NET Core で LibMan を使用する

前提条件

ライブラリ ファイルを追加する

[クライアント側のライブラリを追加します] ダイアログを使用する

LibMan マニフェスト ファイル エントリを手動で構成する

ライブラリ ファイルを復元する

ビルド時にファイルを復元する

ファイルを手動で復元する

ライブラリ ファイルを削除する

ライブラリ ファイルをアンインストールする

ライブラリ バージョンを更新する

その他の技術情報

その他のリソース

ライブラリファイルを追加する

LibMan マニフェストファイルエントリを手動で構成する

ライブラリファイルを復元する

ライブラリファイルを削除する

ライブラリファイルをアンインストールする

ライブラリバージョンを更新する