现已发布！阅读关于 12 月份的新功能和修复。

捆绑扩展

打包你的 Visual Studio Code 扩展的首要原因是确保它能在任何平台的 VS Code 用户上正常工作。只有打包过的扩展才能在 VS Code for Web 环境中使用，例如 github.dev 和 vscode.dev。当 VS Code 在浏览器中运行时，它只能为你的扩展加载一个文件，因此扩展代码需要被打包成一个单一的、对 Web 友好的 JavaScript 文件。这同样适用于 Notebook 输出渲染器，其中 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: '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 标志，则压缩代码。
    • 除非传递了 --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 是一个 Node 模块，它并行运行名称与给定前缀匹配的脚本。对我们来说，它运行 watch:esbuild 和 watch:tsc 脚本。你需要将 npm-run-all 添加到 package.json 的 devDependencies 部分。

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

如果按如下方式配置 .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 文件，将 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.js.cn/configuration/target/#target

  entry: './src/extension.ts', // the entry point of this extension, 📖 -> https://webpack.js.cn/configuration/entry-context/
  output: {
    // the bundle is stored in the 'dist' folder (check package.json), 📖 -> https://webpack.js.cn/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.cn/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.cn/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 for web 和 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 动态创建。根据扩展使用的 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 使用，并在发布扩展之前运行。区别在于 模式，它控制优化级别。使用 production 可以获得最小的包，但耗时也更长，因此否则使用 development。要运行上述脚本，请打开终端并键入 npm run compile，或从命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中选择 **Tasks: Run Task**。

运行扩展

在运行扩展之前，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 视图，通过此 拉取请求。

在那里你可以看到

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

故障排除

代码压缩

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

Webpack 关键依赖项

运行 webpack 时，你可能会遇到警告，例如 **Critical dependencies: the request of a dependency is an expression**。此类警告必须认真对待，否则你的包很可能无法正常工作。该消息意味着 webpack 无法静态确定如何打包某个依赖项。这通常是由动态 require 语句引起的，例如 require(someDynamicVariable)。

要解决此警告，你应该

  • 尝试使依赖项静态化，以便它可以被打包。
  • 通过 externals 配置排除该依赖项。另外，请确保这些 JavaScript 文件未被排除在打包的扩展之外，方法是在 .vscodeignore 中使用否定 glob 模式，例如 !node_modules/mySpecialModule。

后续步骤

  • 扩展市场 - 了解更多关于 VS Code 的公共扩展市场的信息。
  • 测试扩展 - 为你的扩展项目添加测试以确保高质量。
  • 持续集成 - 了解如何在 Azure Pipelines 上运行扩展 CI 构建。
01/08/2026
English 한국어 中文(简体)
© . This site is unofficial and not affiliated with Microsoft.