VSCode
打开本地目录或工作空间
命令ID vscode.openFolder
,打开一个目录或者工作空间。可以在当前窗口打开,或者新建窗口打开。
参数
uri
,Uri类型,可选,目录(工作空间)路径。如果不提供,那么将会弹出一个原生的目录选择对话框newWindow
,可选,是否打开一个新的窗口
// 在新窗口打开/some/path/to/folder
let uri = vscode.Uri.file("/some/path/to/folder");
vscode.commands.executeCommand("vscode.openFolder",uri,true);
当前活动的Terminal(Shell终端)
内置方法vscode.window.activeTerminal
创建Terminal(Shell终端)
使用内置方法vscode.window.createTerminal
,它有三个重载函数, 返回值均为vscode.Terminal
- createTerminal(name?: string, shellPath?: string, shellArgs?: string[] | string): Terminal
参数 | 解释 |
---|---|
name | 可选 ,终端创建后显示在UI上的名字 |
shellPath | 可选,自定义shell终端的执行路径 |
shellArgs | 可选 ,传递给自定义终端的执行参数。 只对Windows生效 |
shellArgs 详细格式参见https://msdn.microsoft.com/en-au/08dfcab2-eb6e-49a4-80eb-87d4076c98c6
- createTerminal(options: TerminalOptions): Terminal
参数 | 解释 |
---|---|
options | 必选 ,TerminalOptions配置参数 |
TerminalOptions
可用的值
参数 | 解释 |
---|---|
占位占位占位占位占位占位占位占位占位占位占位占位占位 | |
cwd | 可选 ,string 或 Uri ,终端的工作目录 |
env | 可选 ,object ,添加到终端中的环境变量 |
hideFromUser | 可选 ,boolean ,如果设置为true,终端将正常运行,但直到调用Terminal.show时,才会对用户公开。 通常的用法是在需要运行可能需要交互性,但只想在需要交互时对用户公开 |
name | 可选 ,string ,终端创建后显示在UI上的名字 |
shellArgs | 可选 , string[] 或 string ,传递给自定义终端的执行参数 只对Windows生效 |
shellPath | 可选 , string ,自定义shell终端的执行路径 |
strictEnv | 可选 , boolean ,终端环境是否应完全与TerminalOptions.env中提供的一致。 如果为false(默认),则环境将基于窗口的环境,并且还会在顶部应用配置的平台设置,例如terminal.integrated.windows.env。 如果true,则必须提供完整的环境。 |
- createTerminal(options: ExtensionTerminalOptions): Terminal
此方法将创建一个由插件(扩展)控制输入输出的终端环境
参数 | 解释 |
---|---|
options | 必选 ,ExtensionTerminalOptions配置参数 |
ExtensionTerminalOptions
可用的值
参数 | 解释 |
---|---|
name | 必选 ,string ,终端创建后显示在UI上的名字 |
pty | 必选 , Pseudoterminal 配置参数 |
Pseudoterminal
可用的值
参数 | 解释 |
---|---|
name | 必选 ,string ,终端创建后显示在UI上的名字 |
pty | 必选 , Pseudoterminal 配置参数 |
Pseudoterminal 参见https://code.visualstudio.com/api/references/vscode-api#Pseudoterminal
参考
https://code.visualstudio.com/api/references/commands
https://code.visualstudio.com/api/references/vscode-api