vscode插件快餐教程(10) - 设置

最新推荐文章于 2025-06-09 12:55:01 发布

Jtag特工

最新推荐文章于 2025-06-09 12:55:01 发布

阅读量2.8k

点赞数

CC 4.0 BY-SA版权

分类专栏： vscode IDE

本文链接：https://blog.youkuaiyun.com/lusing/article/details/103836216

IDE 同时被 2 个专栏收录

9 篇文章

订阅专栏

vscode

4 篇文章

订阅专栏

本文详细介绍如何在VSCode插件中读写配置项，包括使用getConfiguration()获取配置、update()更新配置以及在package.json中添加自定义配置项的方法。同时讲解了配置项的优先级和默认值设定。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

vscode插件快餐教程(10) - 设置

在插件中，根据用户的环境和个性化的不同，需要增加一些配置项。

读写配置项

可以通过vscode.workspace.getConfiguration()方法来获取所有的设置项。

let config: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration();

设置项可以分类，可以指定某一类前缀，来获取这一类的所有属性，例：

let config2: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration('launch');

获取的配置对象将包括：launch.configurations:Array和launch.compounds等子项。

取得到全部或者分类之后，就可以根据名称来通过get方法来读取配置项的值了：

例，我们读取一个tab等于多少个空格的选项：

	let editorConfig: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration('editor');
	let tabsize = editorConfig.get<number>('tabSize');

同样，我们可以通过WorkspaceConfiguration的update方法来更新配置项，例：

	editorConfig.update('tabSize',4);

添加自己的配置项

在package.json中，contributes下通过configuration来添加设置项，例：

	"contributes": {
		"configuration": {
			"title": "BanmaOS CodeComplete Configuration",
			"properties": {
				"banmaos.enableCodeCompletion": {
					"type": "boolean",
					"default": false,
					"description": "Whether to enable AliOS code completion"
				},
				"banmaos.codeCompletionServer": {
					"type": "string",
					"default": "",
					"description": "Server list for code completion"
				}
			}
		}
	}

运行后打开settings，显示出来是这个样子的：

指定缺省值

自己设置的配置项可能都设了默认值，但是如果是依赖别人的配置项，可能因为环境不同就没有这个项目。这时有三个解决方案：

假设存在，然后判断undefined
先用has方法判断下存不存在
指定一个默认值, get方法的第二个函数就是干这个的：

let whatisthis = editorConfig.get<string>('notExisted',"Unknown value");

因为这个项目就是没定义，所以返回值为Unknown value。

值的优先级

在目前的版本中，配置项的值有4种：默值值、全局值、工作区值、工作区目录值。
除了默认值不能改之外，其他三个值的类型叫做ConfigurationTarget，分为Global，Workspace和WorkspaceFolder三种。
前面讲到的update方法的第三个参数就是ConfigurationTarget值。可以直接指定ConfigurationTarget，也可以给一个布尔值，true表示Global，false表示Workspace。如果为空或者undefined，则优先选WorkspaceFolder，如果不适用则自动适配为Workspace.

例：带有ConfigurationTarget的更新：

	editorConfig.update('tabSize',4, vscode.ConfigurationTarget.Global);
	editorConfig.update('tabSize',4, true);

值这么多有点乱哈，所以vscode为我们提供了一个方法去检查这个配置项的所有值，即inspect方法。我们看个例子：

console.log(editorConfig.inspect<string>('tabSize'));

输出的对象类似这样：

key:"editor.tabSize"
defaultValue:4
globalValue:4
workspaceValue:4