在 VS Code 中尝试！

通过任务与外部工具集成

存在许多工具来自动化诸如代码检查、构建、打包、测试或部署软件系统等任务。示例包括 TypeScript 编译器，诸如 ESLint 和 TSLint 等代码检查工具，以及诸如 Make、Ant、Gulp、Jake、Rake 和 MSBuild 等构建系统。

VS Code can talk to a variety of external tools

这些工具大多从命令行运行，并自动化内部软件开发循环（编辑、编译、测试和调试）内外的工作。鉴于它们在开发生命周期中的重要性，能够从 VS Code 内部运行工具并分析其结果是很有帮助的。VS Code 中的任务可以配置为运行脚本和启动进程，以便许多现有工具可以在 VS Code 内部使用，而无需输入命令行或编写新代码。工作区或文件夹特定的任务在工作区 .vscode 文件夹中的 tasks.json 文件中进行配置。

扩展还可以使用任务提供程序贡献任务，这些贡献的任务可以添加在 tasks.json 文件中定义的工作区特定配置。

注意：任务支持仅在处理工作区文件夹时可用。在编辑单个文件时不可用。

TypeScript Hello World

让我们从一个简单的“Hello World”TypeScript 程序开始，我们希望将其编译为 JavaScript。

创建一个空文件夹“mytask”，生成一个 tsconfig.json 文件，并从该文件夹启动 VS Code。

mkdir mytask
cd mytask
tsc --init
code .

现在创建一个包含以下内容的 HelloWorld.ts 文件

function sayHello(name: string): void {
  console.log(`Hello ${name}!`);
}

sayHello('Dave');

按 ⇧⌘B（Windows、Linux Ctrl+Shift+B）或从全局终端菜单运行运行构建任务，会显示以下选择器

TypeScript Build Task

第一个条目执行 TypeScript 编译器并将 TypeScript 文件转换为 JavaScript 文件。当编译器完成后，应该会有一个 HelloWorld.js 文件。第二个条目以监视模式启动 TypeScript 编译器。每次保存 HelloWorld.ts 文件都会重新生成 HelloWorld.js 文件。

您还可以将 TypeScript 构建或监视任务定义为默认构建任务，以便在触发运行构建任务（⇧⌘B（Windows、Linux Ctrl+Shift+B））时直接执行。为此，请从全局终端菜单中选择配置默认构建任务。这会显示一个包含可用构建任务的选择器。选择tsc: build或tsc: watch，VS Code 将生成一个 tasks.json 文件。下面显示的文件将tsc: build任务设为默认构建任务

{
  // See https://go.microsoft.com/fwlink/?LinkId=733558
  // for the documentation about the tasks.json format
  "version": "2.0.0",
  "tasks": [
    {
      "type": "typescript",
      "tsconfig": "tsconfig.json",
      "problemMatcher": ["$tsc"],
      "group": {
        "kind": "build",
        "isDefault": true
      }
    }
  ]
}

上面的 tasks.json 示例没有定义新任务。它只是将 VS Code 的 TypeScript 扩展贡献的 tsc: build 任务标记为默认构建任务。您现在可以通过按 ⇧⌘B（Windows、Linux Ctrl+Shift+B）来执行 TypeScript 编译器。

任务自动检测

VS Code 当前自动检测以下系统的任务：Gulp、Grunt、Jake 和 npm。我们正在与相应的扩展作者合作，以增加对 Maven 和 C# dotnet 命令的支持。如果您使用 Node.js 作为运行时开发 JavaScript 应用程序，您通常会有一个 package.json 文件，其中描述了您的依赖项和要运行的脚本。如果您克隆了 eslint-starter 示例，那么从全局菜单执行运行任务会显示以下列表

Tasks ESLint starter

如果您尚未安装，请运行 npm install 安装必要的 npm 模块。现在打开 server.js 文件并在语句末尾添加一个分号（请注意 ESLint 启动器假设语句没有分号），然后再次执行运行任务。这次选择 npm: lint 任务。当提示使用问题匹配器时，选择 ESLint stylish

Tasks ESLint Problem Matcher Selection

执行任务会产生一个错误，显示在问题视图中

Tasks ESLint Problem

此外，VS Code 创建了一个内容如下的 tasks.json 文件

{
  // See https://go.microsoft.com/fwlink/?LinkId=733558
  // for the documentation about the tasks.json format
  "version": "2.0.0",
  "tasks": [
    {
      "type": "npm",
      "script": "lint",
      "problemMatcher": ["$eslint-stylish"]
    }
  ]
}

这指示 VS Code 使用 ESLint stylish 格式扫描 npm lint 脚本的输出以查找问题。

对于 Gulp、Grunt 和 Jake，任务自动检测的工作方式相同。下面是 vscode-node-debug 扩展检测到的任务示例。

Gulp task auto-detection

提示：您可以通过快速打开（⌘P（Windows、Linux Ctrl+P））输入“task”、空格和命令名称来运行您的任务。在本例中是“task lint”。

可以使用以下设置禁用任务自动检测

{
  "typescript.tsc.autoDetect": "off",
  "grunt.autoDetect": "off",
  "jake.autoDetect": "off",
  "gulp.autoDetect": "off",
  "npm.autoDetect": "off"
}

自定义任务

并非所有任务或脚本都可以在您的工作区中自动检测到。有时需要定义自己的自定义任务。假设您有一个脚本用于运行测试以正确设置某些环境。该脚本存储在工作区内的脚本文件夹中，在 Linux 和 macOS 上名为 test.sh，在 Windows 上名为 test.cmd。从全局终端菜单运行配置任务并选择从模板创建 tasks.json 文件条目。这将打开以下选择器

Configure Task Runner

注意：如果您没有看到任务运行器模板列表，您可能已在文件夹中拥有 tasks.json 文件，其内容将在编辑器中打开。关闭该文件，并为本例删除或重命名它。

我们正在努力提供更多自动检测支持，因此将来此列表会越来越短。由于我们想编写自己的自定义任务，请从列表中选择其他。这将打开带有任务骨架的 tasks.json 文件。将其内容替换为以下内容

{
  // See https://go.microsoft.com/fwlink/?LinkId=733558
  // for the documentation about the tasks.json format
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Run tests",
      "type": "shell",
      "command": "./scripts/test.sh",
      "windows": {
        "command": ".\\scripts\\test.cmd"
      },
      "group": "test",
      "presentation": {
        "reveal": "always",
        "panel": "new"
      }
    }
  ]
}

任务的属性具有以下语义

  • label：在用户界面中使用的任务标签。
  • type：任务类型。对于自定义任务，可以是 shell 或 process。如果指定 shell，则命令解释为 shell 命令（例如：bash、cmd 或 PowerShell）。如果指定 process，则命令解释为要执行的进程。
  • command：要执行的实际命令。
  • windows：任何 Windows 特定属性。当命令在 Windows 操作系统上执行时，将使用这些属性而不是默认属性。
  • group：定义任务所属的组。在本例中，它属于 test 组。属于测试组的任务可以通过从命令面板运行运行测试任务来执行。
  • presentation：定义任务输出在用户界面中如何处理。在此示例中，显示输出的集成终端将始终显示，并且每次任务运行时都会创建一个新终端。
  • options：覆盖 cwd（当前工作目录）、env（环境变量）或 shell（默认 shell）的默认值。选项可以按任务设置，也可以全局或按平台设置。此处配置的环境变量只能在任务脚本或进程中引用，如果它们是参数、命令或其他任务属性的一部分，则不会解析。
  • runOptions：定义任务何时以及如何运行。
  • hide：在“运行任务快速选择”中隐藏任务，这对于复合任务中不可独立运行的元素很有用。

您可以在 tasks.json 文件中使用 IntelliSense 查看完整的任务属性和值集。通过触发建议（⌃Space（Windows、Linux Ctrl+Space））调出建议，并通过悬停或阅读更多...（“i”）浮出框阅读描述。

tasks.json IntelliSense

您还可以查看tasks.json 架构。

当命令和参数包含空格或其他特殊字符（如 $）时，Shell 命令需要特殊处理。默认情况下，任务系统支持以下行为

  • 如果提供单个命令，任务系统将按原样将命令传递给底层 shell。如果命令需要引号或转义才能正常运行，则命令需要包含正确的引号或转义字符。例如，要列出名称中包含空格的文件夹的目录，在 bash 中执行的命令应如下所示：ls 'folder with spaces'。
{
  "label": "dir",
  "type": "shell",
  "command": "dir 'folder with spaces'"
}
  • 如果提供了命令和参数，则如果命令或参数包含空格，任务系统将使用单引号。对于 cmd.exe，使用双引号。像下面这样的 shell 命令将在 PowerShell 中作为 dir 'folder with spaces' 执行。
{
  "label": "dir",
  "type": "shell",
  "command": "dir",
  "args": ["folder with spaces"]
}
  • 如果您想控制参数如何引用，参数可以是一个字面量，指定值和引用样式。下面的示例对包含空格的参数使用转义而不是引用。
{
  "label": "dir",
  "type": "shell",
  "command": "dir",
  "args": [
    {
      "value": "folder with spaces",
      "quoting": "escape"
    }
  ]
}

除转义外，还支持以下值

  • strong：使用 shell 的强引用机制，该机制抑制字符串中的所有评估。在 PowerShell 以及 Linux 和 macOS 的 shell 下，使用单引号 (')。对于 cmd.exe，使用 "。
  • weak：使用 shell 的弱引用机制，该机制仍评估字符串中的表达式（例如，环境变量）。在 PowerShell 以及 Linux 和 macOS 的 shell 下，使用双引号 (")。cmd.exe 不支持弱引用，因此 VS Code 也使用 "。

如果命令本身包含空格，VS Code 默认也会对命令进行强引用。与参数一样，用户可以使用相同的字面样式控制命令的引用。

还有更多任务属性可以配置您的工作流程。您可以使用 IntelliSense 和 ⌃Space（Windows、Linux Ctrl+Space）来获取有效属性的概览。

Tasks IntelliSense

除了全局菜单栏，还可以使用命令面板（⇧⌘P（Windows、Linux Ctrl+Shift+P））访问任务命令。您可以筛选“任务”并查看各种与任务相关的命令。

Tasks in Command Palette

复合任务

您还可以使用 dependsOn 属性将更简单的任务组合成复合任务。例如，如果您有一个包含客户端和服务器文件夹的工作区，并且两者都包含构建脚本，则可以创建一个任务，在单独的终端中启动这两个构建脚本。如果在 dependsOn 属性中列出多个任务，它们默认会并行执行。

tasks.json 文件如下所示

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Client Build",
      "command": "gulp",
      "args": ["build"],
      "options": {
        "cwd": "${workspaceFolder}/client"
      }
    },
    {
      "label": "Server Build",
      "command": "gulp",
      "args": ["build"],
      "options": {
        "cwd": "${workspaceFolder}/server"
      }
    },
    {
      "label": "Build",
      "dependsOn": ["Client Build", "Server Build"]
    }
  ]
}

如果指定 "dependsOrder": "sequence"，则您的任务依赖项将按照它们在 dependsOn 中列出的顺序执行。在 dependsOn 中使用 "dependsOrder": "sequence" 的任何后台/监视任务都必须有一个问题匹配器来跟踪它们何时“完成”。以下任务将运行任务二、任务三，然后是任务一。

{
  "label": "One",
  "type": "shell",
  "command": "echo Hello ",
  "dependsOrder": "sequence",
  "dependsOn": ["Two", "Three"]
}

用户级别任务

您可以使用任务：打开用户任务命令创建不绑定到特定工作区或文件夹的用户级别任务。这里只能使用 shell 和 process 任务，因为其他任务类型需要工作区信息。

输出行为

有时您希望控制运行任务时集成终端面板的行为。例如，您可能希望最大化编辑器空间，并且只有在认为存在问题时才查看任务输出。终端的行为可以使用任务的 presentation 属性控制。它提供以下属性

  • reveal：控制集成终端面板是否置于最前。有效值为
    • always - 面板始终置于最前。这是默认值。
    • never - 用户必须使用视图 > 终端命令（⌃` (Windows, Linux Ctrl+`)）显式将终端面板置于最前。
    • silent - 只有当输出未被扫描到错误和警告时，终端面板才会被置于最前。
  • revealProblems：控制运行此任务时是否显示“问题”面板。优先于选项 reveal。默认为 never。
    • always - 每次执行此任务时，始终显示“问题”面板。
    • onProblem - 仅在发现问题时显示“问题”面板。
    • never - 执行此任务时，从不显示“问题”面板。
  • focus：控制终端是否获取输入焦点。默认为 false。
  • echo：控制执行的命令是否在终端中回显。默认为 true。
  • showReuseMessage：控制是否显示“终端将被任务复用，按任意键关闭”消息。
  • panel：控制任务运行实例之间是否共享终端。可能的值有
    • shared - 终端共享，其他任务运行的输出将添加到同一个终端。
    • dedicated - 终端专用于特定任务。如果该任务再次执行，终端将被复用。但是，不同任务的输出会呈现在不同的终端中。
    • new - 每次执行该任务都使用一个新的干净终端。
  • clear：控制在此任务运行前是否清除终端。默认为 false。
  • close：控制任务运行的终端在任务退出时是否关闭。默认为 false。
  • group：控制任务是否在特定的终端组中使用分屏窗格执行。同一组中的任务（由字符串值指定）将使用分屏终端进行显示，而不是新的终端面板。

您也可以为自动检测到的任务修改终端面板行为。例如，如果您想更改 ESLint 示例中 npm: run lint 的输出行为，请为其添加 presentation 属性

{
  // See https://go.microsoft.com/fwlink/?LinkId=733558
  // for the documentation about the tasks.json format
  "version": "2.0.0",
  "tasks": [
    {
      "type": "npm",
      "script": "lint",
      "problemMatcher": ["$eslint-stylish"],
      "presentation": {
        "reveal": "never"
      }
    }
  ]
}

您还可以将自定义任务与检测到的任务的配置混合使用。一个配置 npm: run lint 任务并添加自定义 Run Test 任务的 tasks.json 文件如下所示

{
  // See https://go.microsoft.com/fwlink/?LinkId=733558
  // for the documentation about the tasks.json format
  "version": "2.0.0",
  "tasks": [
    {
      "type": "npm",
      "script": "lint",
      "problemMatcher": ["$eslint-stylish"],
      "presentation": {
        "reveal": "never"
      }
    },
    {
      "label": "Run tests",
      "type": "shell",
      "command": "./scripts/test.sh",
      "windows": {
        "command": ".\\scripts\\test.cmd"
      },
      "group": "test",
      "presentation": {
        "reveal": "always",
        "panel": "new"
      }
    }
  ]
}

运行行为

您可以使用 runOptions 属性指定任务的运行行为

  • reevaluateOnRerun：控制通过重新运行上次任务命令执行任务时变量的评估方式。默认值为 true，表示重新运行任务时变量将重新评估。当设置为 false 时，将使用上次运行任务时解析的变量值。
  • runOn：指定何时运行任务。
    • default - 任务只会在通过运行任务命令执行时运行。
    • folderOpen - 任务将在包含文件夹打开时运行。第一次打开包含 folderOpen 任务的文件夹时，系统会询问您是否允许任务在该文件夹中自动运行。您以后可以使用管理自动任务命令，并通过选择允许自动任务和禁止自动任务来更改您的决定。
  • instanceLimit - 允许同时运行的任务实例数。默认值为 1。

自定义自动检测到的任务

如上所述，您可以在 tasks.json 文件中自定义自动检测到的任务。您通常这样做是为了修改呈现属性或附加问题匹配器以扫描任务输出中的错误和警告。您可以通过单击运行任务列表右侧的齿轮图标，将相应的任务引用插入到 tasks.json 文件中，直接自定义任务。假设您有以下 Gulp 文件，使用 ESLint（该文件取自 https://github.com/adametry/gulp-eslint）来检查 JavaScript 文件

const gulp = require('gulp');
const eslint = require('gulp-eslint');

gulp.task('lint', () => {
  // ESLint ignores files with "node_modules" paths.
  // So, it's best to have gulp ignore the directory as well.
  // Also, Be sure to return the stream from the task;
  // Otherwise, the task may end before the stream has finished.
  return (
    gulp
      .src(['**/*.js', '!node_modules/**'])
      // eslint() attaches the lint output to the "eslint" property
      // of the file object so it can be used by other modules.
      .pipe(eslint())
      // eslint.format() outputs the lint results to the console.
      // Alternatively use eslint.formatEach() (see Docs).
      .pipe(eslint.format())
      // To have the process exit with an error code (1) on
      // lint error, return the stream and pipe to failAfterError last.
      .pipe(eslint.failAfterError())
  );
});

gulp.task('default', ['lint'], function() {
  // This will only run if the lint task is successful...
});

从全局终端菜单执行运行任务将显示以下选择器

Configure Task

按齿轮图标。这将创建以下 tasks.json 文件

{
  // See https://go.microsoft.com/fwlink/?LinkId=733558
  // for the documentation about the tasks.json format
  "version": "2.0.0",
  "tasks": [
    {
      "type": "gulp",
      "task": "default",
      "problemMatcher": []
    }
  ]
}

通常，您现在会添加一个问题匹配器（在本例中为 $eslint-stylish）或修改演示设置。

使用问题匹配器处理任务输出

VS Code 可以使用问题匹配器处理任务的输出。问题匹配器会扫描任务输出文本中已知的警告或错误字符串，并在编辑器和“问题”面板中以内联方式报告这些问题。VS Code 内置了几个问题匹配器

  • TypeScript：$tsc 假设输出中的文件名是相对于打开的文件夹的。
  • TypeScript Watch：$tsc-watch 匹配 tsc 编译器在监视模式下执行时报告的问题。
  • JSHint：$jshint 假设文件名报告为绝对路径。
  • JSHint Stylish：$jshint-stylish 假设文件名报告为绝对路径。
  • ESLint Compact：$eslint-compact 假设输出中的文件名是相对于打开的文件夹的。
  • ESLint Stylish：$eslint-stylish 假设输出中的文件名是相对于打开的文件夹的。
  • Go：$go 匹配 go 编译器报告的问题。假设文件名是相对于打开的文件夹的。
  • CSharp and VB Compiler：$mscompile 假设文件名报告为绝对路径。
  • Lessc compiler：$lessc 假设文件名报告为绝对路径。
  • Node Sass compiler：$node-sass 假设文件名报告为绝对路径。

您还可以创建自己的问题匹配器，我们将在后面部分讨论。

将键盘快捷方式绑定到任务

如果您需要经常运行某个任务，可以为其定义一个键盘快捷方式。

例如，要将 Ctrl+H 绑定到上面的运行测试任务，请将以下内容添加到您的 keybindings.json 文件中

{
  "key": "ctrl+h",
  "command": "workbench.action.tasks.runTask",
  "args": "Run tests"
}

变量替换

在编写任务配置时，使用一组预定义的常用变量（如活动文件（${file}）或工作区根文件夹（${workspaceFolder}））非常有用。VS Code 支持在 tasks.json 文件中的字符串中进行变量替换，您可以在变量参考中查看预定义变量的完整列表。

注意：并非所有属性都接受变量替换。具体来说，只有 command、args 和 options 支持变量替换。

以下是一个自定义任务配置的示例，它将当前打开的文件传递给 TypeScript 编译器。

{
  "label": "TypeScript compile",
  "type": "shell",
  "command": "tsc ${file}",
  "problemMatcher": ["$tsc"]
}

同样，您可以通过在名称前加上 ${config: 来引用项目的配置设置。例如，${config:python.formatting.autopep8Path} 返回 Python 扩展设置 formatting.autopepe8Path。

以下是一个自定义任务配置的示例，它使用由 python.formatting.autopep8Path 设置定义的 autopep8 可执行文件对当前文件执行 autopep8

{
  "label": "autopep8 current file",
  "type": "process",
  "command": "${config:python.formatting.autopep8Path}",
  "args": ["--in-place", "${file}"]
}

如果您想指定 Python 扩展用于 tasks.json 或 launch.json 的选定 Python 解释器，您可以使用 ${command:python.interpreterPath} 命令。

如果简单的变量替换不够，您还可以通过在 tasks.json 文件中添加 inputs 部分，从任务用户那里获取输入。

Inputs Example

有关 inputs 的更多信息，请参阅变量参考。

操作系统特定属性

任务系统支持定义特定于操作系统的 值（例如，要执行的命令）。为此，请在 tasks.json 文件中放入一个特定于操作系统的字面值，并在该字面值内部指定相应的属性。

下面是一个示例，它使用 Node.js 可执行文件作为命令，在 Windows 和 Linux 上有不同的处理方式

{
  "label": "Run Node",
  "type": "process",
  "windows": {
    "command": "C:\\Program Files\\nodejs\\node.exe"
  },
  "linux": {
    "command": "/usr/bin/node"
  }
}

有效的操作系统属性是 Windows 的 windows，Linux 的 linux 和 macOS 的 osx。在操作系统特定范围内定义的属性会覆盖在任务或全局范围内定义的属性。

全局任务

任务属性也可以在全局范围内定义。如果存在，它们将用于特定任务，除非这些任务用不同的值定义了相同的属性。在下面的示例中，有一个全局 presentation 属性，它定义所有任务都应在新面板中执行

{
  // See https://go.microsoft.com/fwlink/?LinkId=733558
  // for the documentation about the tasks.json format
  "version": "2.0.0",
  "presentation": {
    "panel": "new"
  },
  "tasks": [
    {
      "label": "TS - Compile current file",
      "type": "shell",
      "command": "tsc ${file}",
      "problemMatcher": ["$tsc"]
    }
  ]
}

提示：要访问全局范围的 tasks.json 文件，请打开命令面板（⇧⌘P（Windows、Linux Ctrl+Shift+P））并运行任务：打开用户任务命令。

PowerShell 中的字符转义

当默认 shell 是 PowerShell，或者当任务配置为使用 PowerShell 时，您可能会看到意外的空格和引号转义。这种意外的转义只发生在 cmdlet 上，因为 VS Code 不知道您的命令是否包含 cmdlet。下面的示例 1 显示了一个您将获得不适用于 PowerShell 的转义的情况。示例 2 显示了获得良好转义的最佳跨平台方式。在某些情况下，您可能无法遵循示例 2，您需要进行示例 3 中所示的手动转义。

"tasks": [
    {
        "label": "PowerShell example 1 (unexpected escaping)",
        "type": "shell",
        "command": "Get-ChildItem \"Folder With Spaces\""
    },
    {
        "label": "PowerShell example 2 (expected escaping)",
        "type": "shell",
        "command": "Get-ChildItem",
        "args": ["Folder With Spaces"]
    },
    {
        "label": "PowerShell example 3 (manual escaping)",
        "type": "shell",
        "command": "& Get-ChildItem \\\"Folder With Spaces\\\""
    }
]

更改任务输出的编码

任务通常与磁盘上的文件一起操作。如果这些文件以与系统编码不同的编码存储在磁盘上，您需要让作为任务执行的命令知道使用哪种编码。由于这取决于操作系统和所使用的 shell，因此没有通用的解决方案来控制这一点。下面是关于如何使其工作的建议和示例。

如果您需要调整编码，您应该检查更改操作系统使用的默认编码是否合理，或者至少通过调整 shell 的配置文件来更改您使用的 shell 的编码。

如果您只需要针对特定任务进行调整，则将更改编码所需的操作系统特定命令添加到任务命令行。以下示例适用于 Windows，其默认代码页为 437。该任务显示包含西里尔字母的文件输出，因此需要代码页 866。假定默认 shell 设置为 cmd.exe，则列出文件的任务如下所示

{
  // See https://go.microsoft.com/fwlink/?LinkId=733558
  // for the documentation about the tasks.json format
  "version": "2.0.0",
  "tasks": [
    {
      "label": "more",
      "type": "shell",
      "command": "chcp 866 && more russian.txt",
      "problemMatcher": []
    }
  ]
}

如果任务在 PowerShell 中执行，命令需要像这样：chcp 866; more russian.txt。在 Linux 和 macOS 上，可以使用 locale 命令来检查区域设置并调整必要的环境变量。

任务实际操作示例

为了突出任务的强大功能，这里有一些 VS Code 如何使用任务集成外部工具（如代码检查器和编译器）的示例。

将 TypeScript 转换为 JavaScript

TypeScript 主题包含一个示例，该示例创建了一个任务，用于将 TypeScript 转换为 JavaScript 并观察 VS Code 中的任何相关错误。

将 Less 和 SCSS 转换为 CSS

CSS 主题提供了如何使用任务生成 CSS 文件的示例。

  1. 使用构建任务手动转译
  2. 使用文件监视器自动化编译步骤

定义问题匹配器

VS Code 内置了一些最常见的问题匹配器。然而，有许多编译器和代码检查工具，它们都产生自己的错误和警告样式，因此您可能希望创建自己的问题匹配器。

我们有一个 helloWorld.c 程序，其中开发者将 printf 误拼为 prinft。使用 gcc 编译它将产生以下警告

helloWorld.c:5:3: warning: implicit declaration of function ‘prinft’

我们想生成一个问题匹配器，它可以捕获输出中的消息并在 VS Code 中显示相应的错误。问题匹配器严重依赖正则表达式。以下部分假设您熟悉正则表达式。

提示：我们发现 RegEx101 playground（具有 ECMAScript (JavaScript) 风格）是开发和测试正则表达式的绝佳方式。

捕获上述警告（和错误）的匹配器如下所示

{
  // The problem is owned by the cpp language service.
  "owner": "cpp",
  // The file name for reported problems is relative to the opened folder.
  "fileLocation": ["relative", "${workspaceFolder}"],
  // The name that will be shown as the source of the problem.
  "source": "gcc",
  // The actual pattern to match problems in the output.
  "pattern": {
    // The regular expression. Example to match: helloWorld.c:5:3: warning: implicit declaration of function ‘printf’ [-Wimplicit-function-declaration]
    "regexp": "^(.*):(\\d+):(\\d+):\\s+(warning|error):\\s+(.*)$",
    // The first match group matches the file name which is relative.
    "file": 1,
    // The second match group matches the line on which the problem occurred.
    "line": 2,
    // The third match group matches the column at which the problem occurred.
    "column": 3,
    // The fourth match group matches the problem's severity. Can be ignored. Then all problems are captured as errors.
    "severity": 4,
    // The fifth match group matches the message.
    "message": 5
  }
}

请注意，文件、行和消息属性是强制性的。fileLocation 指定任务输出中生成并匹配问题的文件路径是 absolute 还是 relative。如果任务生成绝对路径和相对路径，您可以使用 autoDetect 文件位置。使用 autoDetect，路径首先作为绝对路径进行测试，如果文件不存在，则假定路径是相对路径。

severity 指定如果模式不包含严重性，则使用哪种问题严重性。severity 的可能值为 error、warning 或 info。

这是一个已完成的 tasks.json 文件，其中包含上面代码（已删除注释）并包装了实际任务详细信息

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "build",
      "command": "gcc",
      "args": ["-Wall", "helloWorld.c", "-o", "helloWorld"],
      "problemMatcher": {
        "owner": "cpp",
        "fileLocation": ["relative", "${workspaceFolder}"],
        "source": "gcc",
        "pattern": {
          "regexp": "^(.*):(\\d+):(\\d+):\\s+(warning|error):\\s+(.*)$",
          "file": 1,
          "line": 2,
          "column": 3,
          "severity": 4,
          "message": 5
        }
      }
    }
  ]
}

在 VS Code 中运行它，然后按 ⇧⌘M（Windows、Linux Ctrl+Shift+M）以获取问题列表，会得到以下输出

GCC Problem Matcher

注意：C/C++ 扩展包含 GCC 的问题匹配器，因此无需自定义。

模式中还可以使用其他几个属性。这些属性是

  • location - 如果问题位置是 line 或 line,column 或 startLine,startColumn,endLine,endColumn，则可以使用我们的通用位置匹配组。
  • endLine - 问题结束行的匹配组索引。如果编译器未提供结束行值，则可以省略。
  • endColumn - 问题结束列的匹配组索引。如果编译器未提供结束列值，则可以省略。
  • code - 问题代码的匹配组索引。如果编译器未提供代码值，则可以省略。

您还可以定义一个只捕获文件的问题匹配器。为此，请定义一个带有可选 kind 属性设置为 file 的 pattern。在这种情况下，无需提供 line 或 location 属性。

注意：如果 kind 属性设置为 file，则功能模式必须至少提供 file 和 message 的匹配组。如果没有提供 kind 属性或 kind 属性设置为 location，则功能模式还必须提供 line 或 location 属性。

注意：问题匹配器只解析给定命令的输出。如果您想解析写入单独文件（例如日志文件）的输出，请让您运行的命令在执行完成之前打印出单独文件中的行。

定义多行问题匹配器

有些工具将源文件中发现的问题分散在多行上，特别是当使用时尚的报告器时。一个例子是 ESLint；在时尚模式下，它会产生如下输出

test.js
  1:0   error  Missing "use strict" statement                 strict
✖ 1 problems (1 errors, 0 warnings)

我们的问题匹配器是基于行的，因此我们需要用与实际问题位置和消息（1:0 error Missing "use strict" statement）不同的正则表达式来捕获文件名（test.js）。

为此，请为 pattern 属性使用问题模式数组。这样，您可以为要匹配的每一行定义一个模式。

以下问题模式匹配 ESLint 在 stylish 模式下的输出 - 但仍然有一个小问题我们需要下一步解决。下面的代码有一个第一个正则表达式来捕获文件名，第二个正则表达式来捕获行、列、严重性、消息和错误代码

{
  "owner": "javascript",
  "fileLocation": ["relative", "${workspaceFolder}"],
  "pattern": [
    {
      "regexp": "^([^\\s].*)$",
      "file": 1
    },
    {
      "regexp": "^\\s+(\\d+):(\\d+)\\s+(error|warning|info)\\s+(.*)\\s\\s+(.*)$",
      "line": 1,
      "column": 2,
      "severity": 3,
      "message": 4,
      "code": 5
    }
  ]
}

但是，如果一个资源上有多个问题，则此模式将不起作用。例如，想象一下 ESLint 的以下输出

test.js
  1:0   error  Missing "use strict" statement                 strict
  1:9   error  foo is defined but never used                  no-unused-vars
  2:5   error  x is defined but never used                    no-unused-vars
  2:11  error  Missing semicolon                              semi
  3:1   error  "bar" is not defined                           no-undef
  4:1   error  Newline required at end of file but not found  eol-last
✖ 6 problems (6 errors, 0 warnings)

模式的第一个正则表达式将匹配“test.js”，第二个正则表达式将匹配“1:0 error ...”。下一行“1:9 error ...”被处理，但与第一个正则表达式不匹配，因此没有问题被捕获。

为了使其正常工作，多行模式的最后一个正则表达式可以指定 loop 属性。如果设置为 true，它会指示任务系统将多行匹配器的最后一个模式应用于输出中的行，只要正则表达式匹配。

由第一个模式捕获的信息（在本例中匹配 test.js）将与匹配 loop 模式的每个后续行组合，以创建多个问题。在此示例中，将创建六个问题。

这是一个问题匹配器，可以完整捕获 ESLint stylish 问题

{
  "owner": "javascript",
  "fileLocation": ["relative", "${workspaceFolder}"],
  "pattern": [
    {
      "regexp": "^([^\\s].*)$",
      "file": 1
    },
    {
      "regexp": "^\\s+(\\d+):(\\d+)\\s+(error|warning|info)\\s+(.*)\\s\\s+(.*)$",
      "line": 1,
      "column": 2,
      "severity": 3,
      "message": 4,
      "code": 5,
      "loop": true
    }
  ]
}

注意：如果同一资源上同一行和列出现多个问题，则只会显示一个问题。这适用于所有问题匹配器，而不仅仅是多行问题匹配器。

修改现有问题匹配器

如果现有问题匹配器与您所需的功能相似，您可以在 tasks.json 任务中对其进行修改。例如，$tsc-watch 问题匹配器仅适用于已关闭的文档。如果您希望它适用于所有文档，您可以对其进行修改

{
  "type": "npm",
  "script": "watch",
  "problemMatcher": {
    "base": "$tsc-watch",
    "applyTo": "allDocuments"
  },
  "isBackground": true
}

其他可修改的问题匹配器属性包括 background、fileLocation、owner、pattern、severity 和 source。

后台/监视任务

有些工具支持在后台运行，同时监视文件系统中的更改，并在文件在磁盘上更改时触发操作。在 Gulp 中，此功能通过 npm 模块 gulp-watch 提供。TypeScript 编译器 tsc 通过 --watch 命令行选项内置了对此的支持。

为了提供背景任务在 VS Code 中处于活动状态并产生问题结果的反馈，问题匹配器必须使用额外的信息来检测输出中的这些 state 更改。让我们以 tsc 编译器为例。当编译器以监视模式启动时，它会向控制台打印以下附加信息

> tsc --watch
12:30:36 PM - Compilation complete. Watching for file changes.

当磁盘上包含问题的文件发生更改时，会出现以下输出

12:32:35 PM - File change detected. Starting incremental compilation...
src/messages.ts(276,9): error TS2304: Cannot find name 'candidate'.
12:32:35 PM - Compilation complete. Watching for file changes.

查看输出显示以下模式

  • 当控制台打印 File change detected. Starting incremental compilation... 时，编译器运行。
  • 当控制台打印 Compilation complete. Watching for file changes. 时，编译器停止。
  • 在这两个字符串之间报告问题。
  • 编译器也在初始启动后运行一次（没有向控制台打印 File change detected. Starting incremental compilation...）。

为了捕获这些信息，问题匹配器可以提供一个 background 属性。

对于 tsc 编译器，一个合适的 background 属性如下所示

"background": {
    "activeOnStart": true,
    "beginsPattern": "^\\s*\\d{1,2}:\\d{1,2}:\\d{1,2}(?: AM| PM)? - File change detected\\. Starting incremental compilation\\.\\.\\.",
    "endsPattern": "^\\s*\\d{1,2}:\\d{1,2}:\\d{1,2}(?: AM| PM)? - Compilation complete\\. Watching for file changes\\."
}

除了问题匹配器上的 background 属性外，任务本身还必须标记为 isBackground，以便任务继续在后台运行。

一个在监视模式下运行的 tsc 任务的完整手写 tasks.json 如下所示

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "watch",
      "command": "tsc",
      "args": ["--watch"],
      "isBackground": true,
      "problemMatcher": {
        "owner": "typescript",
        "fileLocation": "relative",
        "pattern": {
          "regexp": "^([^\\s].*)\\((\\d+|\\d+,\\d+|\\d+,\\d+,\\d+,\\d+)\\):\\s+(error|warning|info)\\s+(TS\\d+)\\s*:\\s*(.*)$",
          "file": 1,
          "location": 2,
          "severity": 3,
          "code": 4,
          "message": 5
        },
        "background": {
          "activeOnStart": true,
          "beginsPattern": "^\\s*\\d{1,2}:\\d{1,2}:\\d{1,2}(?: AM| PM)? - File change detected\\. Starting incremental compilation\\.\\.\\.",
          "endsPattern": "^\\s*\\d{1,2}:\\d{1,2}:\\d{1,2}(?: AM| PM)? - Compilation complete\\. Watching for file changes\\."
        }
      }
    }
  ]
}

后续步骤

以上就是任务——让我们继续……

  • tasks.json 架构 - 您可以查看完整的 tasks.json 架构和描述。
  • 基本编辑 - 了解功能强大的 VS Code 编辑器。
  • 代码导航 - 快速浏览您的源代码。
  • 语言支持 - 了解我们支持的编程语言，包括 VS Code 内置的和通过社区扩展提供的。
  • 调试 - 直接在 VS Code 编辑器中调试您的源代码。

常见问题

任务可以使用与集成终端中指定的 shell 不同的 shell 吗？

是的。您可以使用 "terminal.integrated.automationProfile.*" 设置来设置将用于 VS Code 中所有自动化的 shell，其中包括任务。

    "terminal.integrated.automationProfile.windows": {
        "path": "cmd.exe"
    }

或者，您可以使用 options.shell 属性覆盖任务的 shell。您可以按任务、全局或按平台设置此属性。例如，要在 Windows 上使用 cmd.exe，您的 tasks.json 将包含

{
    "version": "2.0.0",
    "windows": {
        "options": {
            "shell": {
                "executable": "cmd.exe",
                "args": [
                    "/d", "/c"
                ]
            }
        }
    },
    ...

后台任务可以用作 launch.json 中的 prelaunchTask 吗？

是的。由于后台任务会一直运行直到被终止，因此后台任务本身没有“完成”的信号。要将后台任务用作 prelaunchTask，您必须为后台任务添加一个适当的后台 problemMatcher，以便任务系统和调试系统能够知道任务“完成”了。

您的任务可以是

{
  "type": "npm",
  "script": "watch",
  "problemMatcher": "$tsc-watch",
  "isBackground": true
}

注意：$tsc-watch 是一个后台问题匹配器，这是后台任务所必需的。

然后，您可以在 launch.json 文件中将任务用作 prelaunchTask

{
  "name": "Launch Extension",
  "type": "extensionHost",
  "request": "launch",
  "runtimeExecutable": "${execPath}",
  "args": ["--extensionDevelopmentPath=${workspaceRoot}"],
  "stopOnEntry": false,
  "sourceMaps": true,
  "outFiles": ["${workspaceRoot}/out/src/**/*.js"],
  "preLaunchTask": "npm: watch"
}

有关后台任务的更多信息，请访问后台/监视任务。

运行任务时为什么会出现“command not found”？

“command not found”消息表示您尝试运行的任务命令未被您的终端识别为可运行。最常见的情况是，该命令被配置为您的 shell 启动脚本的一部分。任务以非登录和非交互方式运行，这意味着您的 shell 的启动脚本不会运行。特别是 nvm 已知会使用启动脚本作为其配置的一部分。

有几种方法可以解决此问题

  1. 确保您的命令在您的路径上，并且不需要启动脚本才能添加到您的路径中。这是解决此问题最彻底的方法，也是推荐的解决方案。
  2. 您可以对您的任务进行一次性修复，使其以登录或交互方式运行。不推荐这样做，因为它可能会产生其他后果。但是，它也可以是单个任务的快速简便修复。下面是使用 bash 作为 shell 的任务示例
{
  "type": "npm",
  "script": "watch",
  "options": {
    "shell": {
      "args": ["-c", "-l"]
    }
  }
}

上面的 npm 任务将像任务系统默认那样，使用命令 (-c) 运行 bash。但是，此任务还会将 bash 作为登录 shell (-l) 运行。

06/12/2025