VSCode插件通过setting项允许用户自定义的设置_vscode.workspace.getconfiguration() settings.json

定义

在插件的package.json文件中添加一个contributes字段，该字段包含了您的插件所提供的贡献。其中，contributes.configuration节点定义了您的插件所提供的配置项。例如，以下是一个简单的示例：

{
    "contributes": {
        "configuration": {
            "type": "object",
            "title": "My Extension",
            "properties": {
                "myExtension.setting": {
                    "type": "string",
                    "default": "",
                    "description": "Setting for My Extension"
                }
            }
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

这将在设置中添加一个名为“myExtension.setting”的字符串设置。

使用

您可以使用以下代码获取设置项的值：

const mySetting = vscode.workspace.getConfiguration('myExtension').get('myExtension.setting');
1

其中，'myExtension’是您的插件名称，'myExtension.setting’是您的设置项名称。

有关更多详细信息，请参见VS Code文档。