拡張機能のバンドル

Visual Studio Code拡張機能をバンドルする主な理由は、VS Codeをあらゆるプラットフォームで使用しているすべてのユーザーに対して、拡張機能が確実に動作するようにするためです。バンドルされた拡張機能のみが、github.devやvscode.devのようなWeb環境のVS Codeで使用できます。VS Codeがブラウザーで実行されている場合、拡張機能ごとに1つのファイルしかロードできないため、拡張機能のコードを単一のWebフレンドリーなJavaScriptファイルにバンドルする必要があります。これは、ノートブック出力レンダラーにも当てはまります。VS Codeは、レンダラー拡張機能に対して1つのファイルのみをロードします。

さらに、拡張機能はサイズと複雑さを急速に増大させる可能性があります。複数のソースファイルで作成され、npmのモジュールに依存する場合があります。分解と再利用は開発のベストプラクティスですが、拡張機能をインストールおよび実行する際にはコストがかかります。100個の小さなファイルをロードするよりも、1つの大きなファイルをロードする方がはるかに高速です。そのため、バンドルをお勧めします。バンドルとは、複数の小さなソースファイルを1つのファイルに結合するプロセスです。

JavaScriptの場合、さまざまなバンドラーが利用可能です。一般的なものとしては、rollup.js、Parcel、esbuild、およびwebpackがあります。

esbuildの使用

esbuildは、設定が簡単な高速JavaScriptバンドラーです。esbuildを入手するには、ターミナルを開いて次のように入力します。

npm i --save-dev esbuild

esbuildを実行する

esbuildはコマンドラインから実行できますが、繰り返しを減らし、問題の報告を有効にするには、ビルドスクリプトesbuild.jsを使用すると便利です。

const esbuild = require('esbuild');

const production = process.argv.includes('--production');
const watch = process.argv.includes('--watch');

async function main() {
  const ctx = await esbuild.context({
    entryPoints: ['src/extension.ts'],
    bundle: true,
    format: 'cjs',
    minify: production,
    sourcemap: !production,
    sourcesContent: false,
    platform: 'node',
    outfile: 'dist/extension.js',
    external: ['vscode'],
    logLevel: 'warning',
    plugins: [
      /* add to the end of plugins array */
      esbuildProblemMatcherPlugin
    ]
  });
  if (watch) {
    await ctx.watch();
  } else {
    await ctx.rebuild();
    await ctx.dispose();
  }
}

/**
 * @type {import('esbuild').Plugin}
 */
const esbuildProblemMatcherPlugin = {
  name: 'esbuild-problem-matcher',

  setup(build) {
    build.onStart(() => {
      console.log('[watch] build started');
    });
    build.onEnd(result => {
      result.errors.forEach(({ text, location }) => {
        console.error(`✘ [ERROR] ${text}`);
        if (location == null) return;
        console.error(`    ${location.file}:${location.line}:${location.column}:`);
      });
      console.log('[watch] build finished');
    });
  }
};

main().catch(e => {
  console.error(e);
  process.exit(1);
});

ビルドスクリプトは次の処理を行います。

• esbuildでビルドコンテキストを作成します。コンテキストは次のように構成されています。
  • src/extension.tsのコードを単一のファイルdist/extension.jsにバンドルします。
  • --productionフラグが渡された場合は、コードをminifyします。
  • --productionフラグが渡されない限り、ソースマップを生成します。
  • バンドルから'vscode'モジュールを除外します（VS Codeランタイムによって提供されるため）。
• bundlerの完了を妨げたエラーを報告するために、esbuildProblemMatcherPluginプラグインを使用します。このプラグインは、拡張機能としてインストールする必要があるesbuildプロブレムマッチャーによって検出される形式でエラーを出力します。
• --watchフラグが渡された場合、ソースファイルの変更を監視し、変更が検出されるたびにバンドルを再構築し始めます。

esbuildはTypeScriptファイルを直接処理できます。ただし、esbuildは型チェックを行わずにすべての型宣言を削除するだけです。構文エラーのみが報告され、esbuildが失敗する可能性があります。

そのため、型をチェックするためにTypeScriptコンパイラー（tsc）を別途実行しますが、コードは出力しません（--noEmitフラグ）。

package.jsonのscriptsセクションは次のようになります。

"scripts": {
    "compile": "npm run check-types && node esbuild.js",
    "check-types": "tsc --noEmit",
    "watch": "npm-run-all -p watch:*",
    "watch:esbuild": "node esbuild.js --watch",
    "watch:tsc": "tsc --noEmit --watch --project tsconfig.json",
    "vscode:prepublish": "npm run package",
    "package": "npm run check-types && node esbuild.js --production"
}

npm-run-allは、指定されたプレフィックスに一致する名前のスクリプトを並行して実行するnodeモジュールです。ここでは、watch:esbuildスクリプトとwatch:tscスクリプトを実行します。npm-run-allをpackage.jsonのdevDependenciesセクションに追加する必要があります。

compileスクリプトとwatchスクリプトは開発用であり、ソースマップ付きのバンドルファイルを生成します。packageスクリプトは、VS Codeパッケージングおよび公開ツールであるvsceで使用されるvscode:prepublishスクリプトによって使用され、拡張機能を公開する前に実行されます。--productionフラグをesbuildスクリプトに渡すと、コードが圧縮され、小さなバンドルが作成されますが、デバッグが困難になるため、開発中は他のフラグが使用されます。上記のスクリプトを実行するには、ターミナルを開いてnpm run watchと入力するか、コマンドパレットからタスク: タスクの実行を選択します（⇧⌘P (Windows、Linux Ctrl+Shift+P)）。

.vscode/tasks.jsonを次のように構成すると、各watchタスクに個別のターミナルが表示されます。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "watch",
      "dependsOn": ["npm: watch:tsc", "npm: watch:esbuild"],
      "presentation": {
        "reveal": "never"
      },
      "group": {
        "kind": "build",
        "isDefault": true
      }
    },
    {
      "type": "npm",
      "script": "watch:esbuild",
      "group": "build",
      "problemMatcher": "$esbuild-watch",
      "isBackground": true,
      "label": "npm: watch:esbuild",
      "presentation": {
        "group": "watch",
        "reveal": "never"
      }
    },
    {
      "type": "npm",
      "script": "watch:tsc",
      "group": "build",
      "problemMatcher": "$tsc-watch",
      "isBackground": true,
      "label": "npm: watch:tsc",
      "presentation": {
        "group": "watch",
        "reveal": "never"
      }
    }
  ]
}

このwatchタスクは、問題ビューで問題を報告するためにインストールする必要がある問題マッチング用の拡張機能connor4312.esbuild-problem-matchersに依存しています。この拡張機能は、起動を完了するためにインストールする必要があります。

忘れないように、.vscode/extensions.jsonファイルをワークスペースに追加します。

{
  "recommendations": ["connor4312.esbuild-problem-matchers"]
}

最後に、コンパイルされたファイルが公開された拡張機能に含まれるように、.vscodeignoreファイルを更新する必要があります。詳細については、公開セクションを確認してください。

読み進めるには、テストセクションにジャンプしてください。

webpackの使用

Webpackは、npmから入手できる開発ツールです。webpackとそのコマンドラインインターフェースを入手するには、ターミナルを開いて次のように入力します。

npm i --save-dev webpack webpack-cli

これにより、webpackがインストールされ、拡張機能のpackage.jsonファイルが更新され、webpackがdevDependenciesに含まれるようになります。

WebpackはJavaScriptバンドラーですが、多くのVS Code拡張機能はTypeScriptで記述され、JavaScriptにコンパイルされるだけです。拡張機能がTypeScriptを使用している場合は、ローダーts-loaderを使用すると、webpackがTypeScriptを理解できるようになります。ts-loaderをインストールするには、次を使用します。

npm i --save-dev ts-loader

すべてのファイルは、webpack-extensionサンプルで入手できます。

webpackを構成する

すべてのツールがインストールされたので、webpackを構成できます。慣例により、webpack.config.jsファイルには、webpackに拡張機能をバンドルするように指示する構成が含まれています。以下のサンプル構成は、VS Code拡張機能用であり、良い出発点となるはずです。

//@ts-check

'use strict';

const path = require('path');
const webpack = require('webpack');

/**@type {import('webpack').Configuration}*/
const config = {
  target: 'webworker', // vscode extensions run in webworker context for VS Code web 📖 -> https://webpack.dokyumento.jp/configuration/target/#target

  entry: './src/extension.ts', // the entry point of this extension, 📖 -> https://webpack.dokyumento.jp/configuration/entry-context/
  output: {
    // the bundle is stored in the 'dist' folder (check package.json), 📖 -> https://webpack.dokyumento.jp/configuration/output/
    path: path.resolve(__dirname, 'dist'),
    filename: 'extension.js',
    libraryTarget: 'commonjs2',
    devtoolModuleFilenameTemplate: '../[resource-path]'
  },
  devtool: 'source-map',
  externals: {
    vscode: 'commonjs vscode' // the vscode-module is created on-the-fly and must be excluded. Add other modules that cannot be webpack'ed, 📖 -> https://webpack.dokyumento.jp/configuration/externals/
  },
  resolve: {
    // support reading TypeScript and JavaScript files, 📖 -> https://github.com/TypeStrong/ts-loader
    mainFields: ['browser', 'module', 'main'], // look for `browser` entry point in imported node modules
    extensions: ['.ts', '.js'],
    alias: {
      // provides alternate implementation for node module and source files
    },
    fallback: {
      // Webpack 5 no longer polyfills Node.js core modules automatically.
      // see https://webpack.dokyumento.jp/configuration/resolve/#resolvefallback
      // for the list of Node.js core module polyfills.
    }
  },
  module: {
    rules: [
      {
        test: /\.ts$/,
        exclude: /node_modules/,
        use: [
          {
            loader: 'ts-loader'
          }
        ]
      }
    ]
  }
};
module.exports = config;

ファイルは、webpack-extensionサンプルの一部として入手できます。Webpack構成ファイルは、構成オブジェクトをエクスポートする必要がある通常のJavaScriptモジュールです。

上記のサンプルでは、次のものが定義されています。

• targetは、拡張機能が実行されるコンテキストを示します。拡張機能がWeb用VS Codeとデスクトップ版VS Codeの両方で動作するように、webworkerを使用することをお勧めします。
• webpackが使用するエントリポイント。これは、package.jsonのmainプロパティに似ていますが、webpackには「出力」エントリポイントではなく、通常はsrc/extension.tsである「ソース」エントリポイントを提供します。webpackバンドラーはTypeScriptを理解しているため、個別のTypeScriptコンパイルステップは冗長です。
• output構成は、生成されたバンドルファイルをwebpackがどこに配置するかをwebpackに指示します。慣例により、それはdistフォルダーです。このサンプルでは、webpackはdist/extension.jsファイルを生成します。
• resolveおよびmodule/rules構成は、TypeScriptおよびJavaScript入力ファイルをサポートするためのものです。
• externals構成は、バンドルに含めるべきではないファイルやモジュールなど、除外を宣言するために使用されます。vscodeモジュールは、ディスク上に存在せず、必要なときにVS Codeによってオンザフライで作成されるため、バンドルすべきではありません。拡張機能が使用するnodeモジュールによっては、さらに除外が必要になる場合があります。

最後に、コンパイルされたファイルが公開された拡張機能に含まれるように、.vscodeignoreファイルを更新する必要があります。詳細については、公開セクションを確認してください。

webpackを実行する

webpack.config.jsファイルが作成されたら、webpackを呼び出すことができます。webpackはコマンドラインから実行できますが、繰り返しを減らすには、npmスクリプトを使用すると便利です。

これらのエントリをpackage.jsonのscriptsセクションにマージします。

"scripts": {
    "compile": "webpack --mode development",
    "watch": "webpack --mode development --watch",
    "vscode:prepublish": "npm run package",
    "package": "webpack --mode production --devtool hidden-source-map",
},

compileスクリプトとwatchスクリプトは開発用であり、バンドルファイルを生成します。vscode:prepublishは、VS Codeパッケージングおよび公開ツールであるvsceで使用され、拡張機能を公開する前に実行されます。違いはmodeにあり、最適化のレベルを制御します。productionを使用すると、最小のバンドルが得られますが、時間もかかるため、それ以外の場合はdevelopmentが使用されます。上記のスクリプトを実行するには、ターミナルを開いてnpm run compileと入力するか、コマンドパレットからタスク: タスクの実行を選択します（⇧⌘P (Windows、Linux Ctrl+Shift+P)）。

拡張機能の実行

拡張機能を実行する前に、package.jsonのmainプロパティをバンドルを指すようにする必要があります。上記の構成の場合、"./dist/extension"です。この変更により、拡張機能を実行およびテストできるようになりました。

テスト

拡張機能の作成者は、拡張機能のソースコードの単体テストを作成することがよくあります。拡張機能のソースコードがテストに依存しない正しいアーキテクチャレイヤーを使用すると、webpackおよびesbuildで生成されたバンドルにはテストコードが含まれないはずです。単体テストを実行するには、単純なコンパイルのみが必要です。

これらのエントリをpackage.jsonのscriptsセクションにマージします。

"scripts": {
    "compile-tests": "tsc -p . --outDir out",
    "pretest": "npm run compile-tests",
    "test": "vscode-test"
}

compile-testsスクリプトは、TypeScriptコンパイラーを使用して拡張機能をoutフォルダーにコンパイルします。その中間JavaScriptが利用可能になると、launch.jsonの次のスニペットは、テストを実行するのに十分です。

{
  "name": "Extension Tests",
  "type": "extensionHost",
  "request": "launch",
  "runtimeExecutable": "${execPath}",
  "args": [
    "--extensionDevelopmentPath=${workspaceFolder}",
    "--extensionTestsPath=${workspaceFolder}/out/test"
  ],
  "outFiles": ["${workspaceFolder}/out/test/**/*.js"],
  "preLaunchTask": "npm: compile-tests"
}

テストを実行するためのこの構成は、バンドルされていない拡張機能と同じです。単体テストは拡張機能の公開部分ではないため、バンドルする理由はありません。

公開

公開する前に、.vscodeignoreファイルを更新する必要があります。dist/extension.jsファイルにバンドルされたものはすべて除外できます。通常はoutフォルダー（まだ削除していない場合）と、最も重要なnode_modulesフォルダーです。

一般的な.vscodeignoreファイルは次のようになります。

.vscode
node_modules
out/
src/
tsconfig.json
webpack.config.js
esbuild.js

既存の拡張機能の移行

既存の拡張機能を移行してesbuildまたはwebpackを使用することは、簡単で、上記の入門ガイドと似ています。webpackを採用した実際のサンプルは、このプルリクエストによるVS Codeのリファレンスビューです。

そこで確認できます。

• esbuildまたはwebpack、webpack-cli、およびts-loaderをdevDependenciesとして追加します。
• 上記の例に示すように、バンドラーを使用するようにnpmスクリプトを更新します。
• タスク構成tasks.jsonファイルを更新します。
• esbuild.jsまたはwebpack.config.jsビルドファイルを追加および調整します。
• node_modulesおよび中間出力ファイルを除外するように.vscodeignoreを更新します。
• インストールとロードがはるかに高速な拡張機能をお楽しみください！

トラブルシューティング

Minification

productionモードでのバンドルは、コードのminifyも実行します。minifyは、空白とコメントを削除し、変数名と関数名を醜いですが短いものに変更することで、ソースコードを圧縮します。Function.prototype.nameを使用するソースコードは異なる動作をするため、minifyを無効にする必要がある場合があります。

webpackの重大な依存関係

webpackを実行すると、重大な依存関係: 依存関係のリクエストが式ですのような警告が発生する場合があります。このような警告は真剣に受け止める必要があり、バンドルが動作しない可能性があります。このメッセージは、webpackが一部の依存関係をバンドルする方法を静的に決定できないことを意味します。これは通常、require(someDynamicVariable)のような動的なrequireステートメントによって引き起こされます。

警告に対処するには、次のいずれかを行う必要があります。

• 依存関係を静的にして、バンドルできるように試みます。
• externals構成を介してその依存関係を除外します。また、グロブパターンを否定したグロブパターン（たとえば、!node_modules/mySpecialModule）を使用して、これらのJavaScriptファイルがパッケージ化された拡張機能から除外されていないことも確認してください。

次のステップ

• 拡張機能マーケットプレース - VS Codeの公開拡張機能マーケットプレースの詳細をご覧ください。
• 拡張機能のテスト - 高品質を保証するために、拡張機能プロジェクトにテストを追加します。
• 継続的インテグレーション - Azure Pipelinesで拡張機能CIビルドを実行する方法を学びます。