扩展捆绑

打包您的Visual Studio Code扩展的第一个原因是确保它在任何平台上使用VS Code的每个人都能正常工作。只有打包的扩展才能在VS Code的Web环境中使用，例如github.dev和vscode.dev。当VS Code在浏览器中运行时，它只能为您的扩展加载一个文件，因此扩展代码需要被打包成一个单一的Web友好的JavaScript文件。这也适用于Notebook Output Renderers，其中VS Code也只会为您的渲染器扩展加载一个文件。

此外，扩展程序可能会迅速增长规模和复杂性。它们可能由多个源文件编写，并依赖于来自npm的模块。分解和重用是开发的最佳实践，但在安装和运行扩展程序时会带来成本。加载100个小文件比加载一个大文件要慢得多。这就是为什么我们推荐打包。打包是将多个小源文件合并为一个文件的过程。

对于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: 'silent',
    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}`);
        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标志，则压缩代码。
- 除非传递了--production标志，否则生成源映射。
- 从捆绑包中排除'vscode'模块（因为它由VS Code运行时提供）。
使用 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 是一个节点模块，它并行运行名称匹配给定前缀的脚本。对于我们来说，它运行 watch:esbuild 和 watch:tsc 脚本。你需要将 npm-run-all 添加到 package.json 中的 devDependencies 部分。

compile 和 watch 脚本用于开发，它们会生成带有源映射的打包文件。package 脚本由 vscode:prepublish 脚本使用，该脚本由 vsce（VS Code 打包和发布工具）使用，并在发布扩展之前运行。将 --production 标志传递给 esbuild 脚本会导致它压缩代码并创建一个小型打包文件，但也会使调试变得困难，因此在开发过程中使用其他标志。要运行上述脚本，请打开终端并输入 npm run watch 或从命令面板中选择 任务：运行任务（⇧⌘P (Windows, Linux Ctrl+Shift+P)）。

如果你按照以下方式配置.vscode/tasks.json，你将为每个监视任务获得一个单独的终端。

{
  "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"
      }
    }
  ]
}

此监视任务依赖于扩展 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文件，以在devDependencies中包含webpack。

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.js.org/configuration/target/#target

  entry: './src/extension.ts', // the entry point of this extension, 📖 -> https://webpack.js.org/configuration/entry-context/
  output: {
    // the bundle is stored in the 'dist' folder (check package.json), 📖 -> https://webpack.js.org/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.js.org/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.js.org/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 表示您的扩展将在哪个上下文中运行。我们建议使用 webworker，以便您的扩展在 VS Code 网页版和桌面版中都能工作。
webpack 应该使用的入口点。这类似于 package.json 中的 main 属性，不同之处在于你为 webpack 提供了一个“源”入口点，通常是 src/extension.ts，而不是“输出”入口点。webpack 打包器理解 TypeScript，因此单独的 TypeScript 编译步骤是多余的。
output 配置告诉 webpack 将生成的打包文件放在哪里。按照惯例，通常是 dist 文件夹。在这个示例中，webpack 将生成一个 dist/extension.js 文件。
resolve 和 module/rules 配置用于支持 TypeScript 和 JavaScript 输入文件。
externals 配置用于声明排除项，例如不应包含在捆绑包中的文件和模块。vscode 模块不应被捆绑，因为它不存在于磁盘上，而是在需要时由 VS Code 动态创建。根据扩展使用的节点模块，可能需要更多的排除项。

最后，您需要更新您的.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 由 vsce（VS Code 的打包和发布工具）使用，并在发布扩展之前运行。区别在于模式，它控制优化的级别。使用 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的References视图，通过这个pull request。

在那里你可以看到：

添加 esbuild 或 webpack、webpack-cli 和 ts-loader 作为 devDependencies。
更新 npm 脚本以使用如上所示的打包工具
更新任务配置文件 tasks.json。
添加并调整esbuild.js或webpack.config.js构建文件。
更新 .vscodeignore 以排除 node_modules 和中间输出文件。
享受一个安装和加载速度更快的扩展！

故障排除

最小化

在production模式下进行打包也会执行代码压缩。压缩通过移除空白和注释，并将变量和函数名称改为丑陋但简短的名称来压缩源代码。使用Function.prototype.name的源代码工作方式不同，因此您可能需要禁用压缩。

webpack 关键依赖

在运行webpack时，你可能会遇到一个警告，如关键依赖项：依赖项的请求是一个表达式。这样的警告必须认真对待，很可能你的打包文件无法正常工作。这个消息意味着webpack无法静态地确定如何打包某些依赖项。这通常是由动态的require语句引起的，例如require(someDynamicVariable)。

为了解决警告，您应该：

尝试使依赖项静态化，以便可以打包。
通过externals配置排除该依赖项。同时确保这些JavaScript文件不会从打包的扩展中被排除，可以在.vscodeignore中使用否定的glob模式，例如!node_modules/mySpecialModule。

下一步

Extension Marketplace - 了解更多关于VS Code的公共扩展市场。
Testing Extensions - 为您的扩展项目添加测试，以确保高质量。
Continuous Integration - 了解如何在 Azure Pipelines 上运行扩展 CI 构建。

12/11/2024