通过任务与外部工具集成

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

这些工具大多从命令行运行，并自动执行内部和外部软件开发循环（编辑、编译、测试和调试）中的作业。考虑到它们在开发生命周期中的重要性，能够从 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 编译器并将 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 示例，则从全局菜单执行运行任务将显示以下列表

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

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

此外，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 扩展检测到的任务示例。

提示：您可以通过键入“任务”、空格和命令名称，通过快速打开 (⌘P (Windows、Linux Ctrl+P)) 来运行任务。在这种情况下，为“task lint”。

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

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

自定义任务

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

注意： 如果您没有看到任务运行器模板列表，则可能您的文件夹中已经有一个 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 组。属于 test 组的任务可以通过从 命令面板 运行 运行测试任务 来执行。
• presentation: 定义如何在用户界面中处理任务输出。在此示例中，显示输出的集成终端 always 会被显示出来，并且每次任务运行时都会创建一个 new 终端。
• options: 覆盖 cwd（当前工作目录）、env（环境变量）或 shell（默认 shell）的默认值。可以在每个任务、全局或每个平台上设置选项。此处配置的环境变量只能在您的任务脚本或进程中引用，如果它们是您的 args、command 或其他任务属性的一部分，则不会被解析。
• runOptions: 定义何时以及如何运行任务。
• hide: 从“运行任务快速选择”中隐藏任务，这对于复合任务中不是独立可运行的元素很有用。

您可以在 tasks.json 文件中使用 IntelliSense 查看完整的任务属性和值集。使用 触发建议 (⌃Space (Windows, Linux Ctrl+Space)) 调出建议，并在悬停或使用 阅读更多... ('i') 弹出窗口时阅读描述。

您还可以查看 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 默认也会强引用该命令。与参数一样，用户可以使用相同的文字样式来控制命令的引用。

还有更多任务属性可用于配置您的工作流程。您可以使用带有 ⌃Space (Windows, Linux Ctrl+Space) 的 IntelliSense 来获取有效属性的概述。

除了全局菜单栏之外，还可以使用 命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 访问任务命令。您可以按 'task' 进行筛选，并可以查看各种与任务相关的命令。

复合任务

您还可以使用 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 任务并添加自定义 运行测试 任务的 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 对 JavaScript 文件进行 lint （该文件取自 https://github.com/adametry/gulp-eslint）

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...
});

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

按下齿轮图标。这将创建以下 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 编译器时，$tsc-watch 会匹配报告的问题。
• JSHint：$jshint 假设文件名报告为绝对路径。
• JSHint Stylish：$jshint-stylish 假设文件名报告为绝对路径。
• ESLint Compact：$eslint-compact 假设输出中的文件名是相对于打开的文件夹的。
• ESLint Stylish：$eslint-stylish 假设输出中的文件名是相对于打开的文件夹的。
• Go：$go 匹配 go 编译器报告的问题。假设文件名是相对于打开的文件夹的。
• CSharp 和 VB 编译器：$mscompile 假设文件名报告为绝对路径。
• Lessc 编译器：$lessc 假设文件名报告为绝对路径。
• Node Sass 编译器：$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.autopep8Path。

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

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

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

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

有关 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 的编码。

如果您只需要针对特定任务进行调整，则将更改编码所需的特定于操作系统的命令添加到任务命令行。以下示例适用于默认使用代码页 437 的 Windows。该任务显示包含西里尔字符的文件的输出，因此需要代码页 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 如何使用任务来集成诸如 linters 和编译器之类的外部工具。

将 TypeScript 转译为 JavaScript

TypeScript 主题 包括一个示例，该示例创建一个任务来将 TypeScript 转译为 JavaScript，并观察 VS Code 中的任何相关错误。

将 Less 和 SCSS 转译为 CSS

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

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

定义问题匹配器

VS Code 自带一些最常见的问题匹配器“开箱即用”。但是，有很多编译器和 linting 工具，它们都产生自己风格的错误和警告，因此您可能需要创建自己的问题匹配器。

我们有一个 helloWorld.c 程序，开发人员在该程序中将 printf 错误地键入为 prinft。使用 gcc 进行编译将产生以下警告

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

我们想要生成一个问题匹配器，该匹配器可以捕获输出中的消息，并在 VS Code 中显示相应的问题。问题匹配器在很大程度上依赖于正则表达式。以下部分假设您熟悉正则表达式。

提示：我们发现 RegEx101 游乐场（具有 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
  }
}

请注意，file、line 和 message 属性是必需的。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) 以获取问题列表，您将看到以下输出

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

在模式中还可以使用几个其他属性。它们是：

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

您还可以定义一个只捕获文件的的问题匹配器。为此，定义一个 pattern，并将其可选属性 kind 设置为 file。在这种情况下，不需要提供 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)

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

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

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

{
  "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 时尚问题的问题匹配器

{
  "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 吗？

可以。您可以使用 "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) 运行。