Visual Studio Code中的任务配置文件tasks.json中的可选任务组tasks详解

? ? 前往老猿Python博客 ? https://blog.csdn.net/LaoYuanPython

一、引言

vscode是支持通过配置可以实现类似Visual C++等IDE开发工具使用菜单和快捷键直接进行程序编译构建的，这样构建的任务可以结合后续的调试配置进行IDE环境的程序调试，不过在之前必须先通过vscode的编译构建任务配置文件tasks.json进行相关设置，当然配置的任务不仅限于编译，还可以做很多后台处理，如老猿就定义了一个任务用于显示vscode中可以使用的预定义变量的值，详细介绍请参考老猿在CSDN的博文《vscode中tasks.json文件使用的预定义变量及国产统信操作系统UOS下配置一个任务显示相关预定义变量的案例》。

二、tasks.json文件中的任务官方定义

在tasks.json配置文件中，可以定义多个任务，每个任务都包含了一些属性，例如任务名称、任务类型、执行命令、命令参数、工作目录、输出等，这些任务还可以指定执行依赖关系。通过配置tasks.json文件，可以方便地在Visual Studio Code中执行这些任务，提高开发效率。

tasks.json最重要的配置当然就是任务，关于任务配置项官方定义请见vscode的官方文档。

任务又分为基本任务和可选的任务组，下面是基本任务的官方相关定义及注释：

interface BaseTaskConfiguration {
  /**
   * The type of a custom task. Tasks of type "shell" are executed
   * inside a shell (e.g. bash, cmd, powershell, ...)
   */
  type: 'shell' | 'process';

  /**
   * The command to be executed. Can be an external program or a shell
   * command.
   */
  command: string;

  /**
   * Specifies whether a global command is a background task.
   */
  isBackground?: boolean;

  /**
   * The command options used when the command is executed. Can be omitted.
   */
  options?: CommandOptions;

  /**
   * The arguments passed to the command. Can be omitted.
   */
  args?: string[];

  /**
   * The presentation options.
   */
  presentation?: PresentationOptions;

  /**
   * The problem matcher to be used if a global command is executed (e.g. no tasks
   * are defined). A tasks.json file can either contain a global problemMatcher
   * property or a tasks property but not both.
   */
  problemMatcher?: string | ProblemMatcher | (string | ProblemMatcher)[];

  /**
   * The configuration of the available tasks. A tasks.json file can either
   * contain a global problemMatcher property or a tasks property but not both.
   */
  tasks?: TaskDescription[];
}

基本任务中的tasks就是可选任务组，可见可选任务组tasks是基本任务下的一个可选的配置项，其类型为TaskDescription类型的一个数组，下面是TaskDescription的官方定义。

/**
 1. The description of a task.
 */
interface TaskDescription {
  /**
 2. The task's name
   */
  label: string;

  /**
 3. The type of a custom task. Tasks of type "shell" are executed
 4. inside a shell (e.g. bash, cmd, powershell, ...)
   */
  type: 'shell' | 'process';

  /**
 5. The command to execute. If the type is "shell" it should be the full
 6. command line including any additional arguments passed to the command.
   */
  command: string;

  /**
 7. Whether the executed command is kept alive and runs in the background.
   */
  isBackground?: boolean;

  /**
 8. Additional arguments passed to the command. Should be used if type
 9. is "process".
   */
  args?: string[];

  /**
 10. Defines the group to which this task belongs. Also supports to mark
 11. a task as the default task in a group.
   */
  group?: 'build' | 'test' | { kind: 'build' | 'test'; isDefault: boolean };

  /**
 12. The presentation options.
   */
  presentation?: PresentationOptions;

  /**
 13. The problem matcher(s) to use to capture problems in the tasks
 14. output.
   */
  problemMatcher?: string | ProblemMatcher | (string | ProblemMatcher)[];

  /**
 15. Defines when and how a task is run.
   */
  runOptions?: RunOptions;
}

本文主要介绍可选任务组tasks的相关配置，关于基本任务将在另外的博文中介绍。

三、TaskDescription的配置项详解

从官方文档可见，一个典型的TaskDescription元素包含多种属性，下面逐一介绍：

1. label：字符串类型，任务名，必选项；
2. type：任务类型，有3个可选值’shell’ 、‘process’、‘cppbuild’，其中前2个是vscode中安装后即可提供的，‘cppbuild’是安装C++扩展之后支持的，估计如果安排其他语言的扩展，应该还有其他可选类型，关于取值的区别请参考老猿在CSDN的博文《信创之国产浪潮电脑+统信UOS操作系统体验5：visual studio code的任务配置文件tasks.json进行C++编译的任务配置类型type取值及含义》；
3. command：任务需要执行的具体命令，可以是外部程序或shell命令，如对于C++编译任务，就可能是“gcc”；
4. isBackground：是否后台运行，还是前台运行；
5. args：命令执行的参数，相关案例《vscode中tasks.json文件使用的预定义变量及国产统信操作系统UOS下配置一个任务显示相关预定义变量的案例》；
6. group：用于定义任务属于哪个组，其下子元素kind有3个可选值包括’build’ 、‘test’ 、‘none’，子元素isDefault为布尔类型，表示是否该任务为任务组的缺省任务。
   对于kind为’test’ 、‘none’的情况老猿没有深入研究，对kind为’build’的情况，当选择菜单：终端->运行生成任务 执行生成任务时：
   1>vscode查找是否存在有任务类型为‘build’的任务，如果有且只有一个，则执行该生成任务，否则转下步；
   2>查找是否有isDefault为true的任务，如果有且只有一个，则执行该任务，否则转下步；
   3>其他情况，vscode将列出所有类型为build的任务，由操作人员选择具体执行的任务。
7. presentation: 用于控制终端面板窗口的输出信息展示，具体请参考老猿在CSDN的博文《Visual Studio Code tasks.json中控制任务执行问题面板显示内容的PresentationOptions介绍》的介绍;
8. problemMatcher：用于控制任务执行时问题匹配及输出，具体请参考老猿在CSDN的博文《信创之国产浪潮电脑+统信UOS操作系统体验7：VSCode任务tasks.json的问题匹配器problemMatcher详解》的介绍；
9. runOptions：用于控制任务怎么执行的可选配置项，这个配置项老猿没有进行相关验证测试，从官方说明可以看出包括以下子项：
   1>reevaluateOnRerun：布尔类型，控制通过“重新运行”命令执行任务时如何计算变量。默认值为“true”，表示重新运行任务时将重新评估任务变量。当设置为“false”时，将使用上次运行任务时解析的任务变量值；
   2>runOn：指定任务何时运行，有两个可选值，“default”表示只有通过“运行任务”命令执行任务时，才会运行任务，就是必须手动执行；“folderOpen”表示打开包含的文件夹时即开始运行该任务;
   3>instanceLimit：允许同时运行的任务实例数，默认值为1。

四、一个案例

下面是老猿配置的2个可选任务buildHello1和buildHello2的配置内容：

"tasks": [
    {
      "type": "cppbuild",
      "label": "buildHello1",
      "command": "/usr/bin/g++",
      "args": [
        "-fdiagnostics-color=always",
        "-g",
        "-Wall",
        "-Wextra",
        "-O0",
        "${workspaceFolder}/hello.cpp",
        "-o",
        "${fileDirname}/$hello1"
      ],
      "options": {
        "cwd": "${fileDirname}"
      },
      "problemMatcher": "$gcc",
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "detail": "编译器: /usr/bin/g++"
    },
    {
      "type": "cppbuild",
      "label": "buildHello2",
      "command": "/usr/bin/g++",
      "args": [
        "-fdiagnostics-color=always",
        "-g",
        "-Wall",
        "-Wextra",
        "-O0",
        "${workspaceFolder}/hello2.cpp",
        "-o",
        "${fileDirname}/$hello2"
      ],
      "options": {
        "cwd": "${fileDirname}"
      },
      "problemMatcher": "$gcc",
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "detail": "编译器: /usr/bin/g++"
    }]

配置完成后，在终端菜单选择“运行生成任务…”时可以看到两个任务供选择：

四、小结

本文介绍了tasks.json中任务配置选项的可选任务组tasks子配置项，tasks的类型是TaskDescription，文章介绍了TaskDescription的详细内容和用途。tasks配置项配置的任务是大多数任务的配置方式，理解相关子配置项的内容对于更好地配置vscode的任务有重要作用。

参考资料

1. vscode用法;
2. Additional information for Visual Studio Code tasks
3. Variables Reference–Visual Studio Code supports variable
4. Integrate with External Tools via Tasks

写博不易，敬请支持：

如果阅读本文于您有所获，敬请点赞、评论、收藏，谢谢大家的支持！

更多关于vscode任务配置的内容请参考专栏《国产信创之光》的其他文章。

关于老猿的付费专栏

1. 付费专栏《https://blog.csdn.net/laoyuanpython/category_9607725.html 使用PyQt开发图形界面Python应用》专门介绍基于Python的PyQt图形界面开发基础教程，对应文章目录为《 https://blog.csdn.net/LaoYuanPython/article/details/107580932 使用PyQt开发图形界面Python应用专栏目录》；
2. 付费专栏《https://blog.csdn.net/laoyuanpython/category_10232926.html moviepy音视频开发专栏 )详细介绍moviepy音视频剪辑合成处理的类相关方法及使用相关方法进行相关剪辑合成场景的处理，对应文章目录为《https://blog.csdn.net/LaoYuanPython/article/details/107574583 moviepy音视频开发专栏文章目录》；
3. 付费专栏《https://blog.csdn.net/laoyuanpython/category_10581071.html OpenCV-Python初学者疑难问题集》为《https://blog.csdn.net/laoyuanpython/category_9979286.html OpenCV-Python图形图像处理 》的伴生专栏，是笔者对OpenCV-Python图形图像处理学习中遇到的一些问题个人感悟的整合，相关资料基本上都是老猿反复研究的成果，有助于OpenCV-Python初学者比较深入地理解OpenCV，对应文章目录为《https://blog.csdn.net/LaoYuanPython/article/details/109713407 OpenCV-Python初学者疑难问题集专栏目录 》
4. 付费专栏《https://blog.csdn.net/laoyuanpython/category_10762553.html Python爬虫入门 》站在一个互联网前端开发小白的角度介绍爬虫开发应知应会内容，包括爬虫入门的基础知识，以及爬取CSDN文章信息、博主信息、给文章点赞、评论等实战内容。

前两个专栏都适合有一定Python基础但无相关知识的小白读者学习，第三个专栏请大家结合《https://blog.csdn.net/laoyuanpython/category_9979286.html OpenCV-Python图形图像处理 》的学习使用。

对于缺乏Python基础的同仁，可以通过老猿的免费专栏《https://blog.csdn.net/laoyuanpython/category_9831699.html 专栏：Python基础教程目录）从零开始学习Python。

如果有兴趣也愿意支持老猿的读者，欢迎购买付费专栏。

老猿Python，跟老猿学Python！

? ? 前往老猿Python博文目录 https://blog.csdn.net/LaoYuanPython ?