10.自定义插件首选项配置，根据配置执行不同逻辑—例子

[PDKSophia]

场景

每一个插件都可以自行添加首选项的配置，当打开 vscode 时，根据首选项选择的配置，执行不同的逻辑，接下来说说如何实现此效果

代码展示

我们现在 package.json 中配置一下我们首选项参数

{
   "contributes": {
      "configuration": {
        "title": "sugar-demo-vscod",
        "properties": {
          "sugar-demo-vscode.matchConfig": {
            "type": "string",
            "description": "sugar-demo-vscod 配置，默认低配版本",
            "enum": [
              "lowMatch",
              "middleMatch",
              "highMatch"
            ],
            "default": "lowMatch",
            "scope": "window"
          }
        }
      }
  }
}

这里需要注意，名称 sugar-demo-vscode 要一致！

上面我们已经实现了首选项配置，看看效果

我们再获取配置，然后执行不同逻辑

    // 获取用户配置的版本设置
    const matchConfig = vscode.workspace.getConfiguration().get('vscode-beehive-extension.matchConfig')
    if (matchConfig === MATCH_CONFIG_MAPS.LOW) {
       console.log('低配')
    } else if (matchConfig === MATCH_CONFIG_MAPS.MIDDLE) {
        console.log('中配')
    } else if (matchConfig === MATCH_CONFIG_MAPS.HIGH) {
        console.log('高配')
    } else {
      vscode.window.showErrorMessage(`unknown error`)
    }

如果要通过代码修改 matchConfig 内容，可以通过

// 最后一个参数，为true时表示写入全局配置，为false或不传时则只写入工作区配置
vscode.workspace.getConfiguration().update('vscode-beehive-extension.matchConfig', 'middleMatch, true);

源码展示

• beehive-cusomUserConfig.ts