Visual Studio Code中tasks.json全局任务命令选项CommandOptions配置介绍

最新推荐文章于 2025-10-02 12:14:31 发布

原创最新推荐文章于 2025-10-02 12:14:31 发布 · 2.1k 阅读

23 ·

CC 4.0 BY-SA版权

文章标签：

#vscode #编程工具 #全局命令选项 #CommandOptions #tasks.json

老猿Python 同时被 2 个专栏收录

1156 篇文章

订阅专栏

国产信创之光

32 篇文章

订阅专栏

☞ ░ 前往老猿Python博客 ░ https://blog.youkuaiyun.com/LaoYuanPython

一、引言

从官方文档可见，一个vscode典型的task.json文件包含多种属性，格式复杂，任务可以分为全局任务和局部可选任务，在tasks.json一级配置的任务为全局任务，在二级tasks中配置的任务老猿称为局部可选任务，这个名称是老猿根据全局任务的说法自定义的。

全局任务比局部可选任务多了version、options和tasks这三个子配置项，options的类型为CommandOptions，表示传递给外部执行程序或shell的选项。

二、vscode官方文档的CommandOptions定义

下面是CommandOptions的官方文档定义：

/**
 * Options to be passed to the external program or shell
 */
export interface CommandOptions {
  /**
 * The current working directory of the executed program or shell.
 * If omitted the current workspace's root is used.
   */
  cwd?: string;

  /**
 * The environment of the executed program or shell. If omitted
 * the parent process' environment is used.
   */
  env?: { [key: string]: string };

  /**
 * Configuration of the shell when task type is `shell`
   */
  shell: {
    /**
     * The shell to use.
     */
    executable: string;

    /**
     * The arguments to be passed to the shell executable to run in command mode
     * (e.g ['-c'] for bash or ['/S', '/C'] for cmd.exe).
     */
    args?: string[];
  };
}

三、CommandOptions详解

从上述官方文档定义可以看出，CommandOptions是用于传递给shell或后台进程的运行选项，包括以下可选项：

cwd: 执行进程或shell的工作目录，如果没有设置则使用当前项目的根目录
env :执行进程或shell的需要的环境变量，如果没有设置则使用父进程的环境，如果需要设置，采用："环境变量名：环境变量值"的方式传递，类似： “env”: { “MY_VAR1”: “value1”, “MY_VAR2”:1 }
shell：当type设置为"shell"时，用于配置使用的shell类型，其下有两个子项配置，executable配置执行的shell，如“bash”、“ksh”、“csh”、“dash”等，使用的前提是机器上安装了对应shell；args为传递给shell以在命令模式下运行的options参数，如bash的使用语法为：bash [options] [command_string | file]，则args是options相关选项值，而command_string则是前面的command命令。

四、CommandOptions配置举例

为了说明清楚，下面举个配置正确实际不合理的一个全局任务的部分配置来看看：

"command":"g++",
    "args": [
      "-fdiagnostics-color=always",
      "-g",
      "-Wall",
      "-Wextra",
      "-O0",
      "${workspaceFolder}/hello.cpp",
      "-o",
      "${fileDirname}/$hello1",
    ],
    "options": {
         "shell": {  
          "executable":"bash",
          "args":["-c","ls -lrt *.txt"],
           }  

        }

这个配置在运行任务时选择执行g++任务时，实际执行的指令为：

bash '-c' 'ls -lrt *.txt' 'g++ -fdiagnostics-color=always -g -Wall -Wextra -O0 /home/administrator/E_DRIVER/vcwork/test/hello.cpp -o /home/administrator/E_DRIVER/vcwork/test/.vscode/$hello1'

具体信息请见如下截图：
在这里插入图片描述