如何在VSCode扩展中访问自定义配置并实时获取用户修改后的值

1 修正配置语法问题 #

你提供的package.json配置存在语法错误，属性名多了多余引号，建议调整命名避免空格，修正后示例如下：

{
  "contributes": {
    "configuration": [
      {
        "title": "Extension",
        "properties": {
          "Codegenx.aFloat": {
            "type": "number",
            "default": 1.0,
            "description": "A sample decimal number"
          }
        }
      }
    ]
  }
}

2 访问配置项 #

VSCode 提供了官方 API 读取配置，直接调用vscode.workspace.getConfiguration即可：

const vscode = require('vscode');

// 每次调用都会读取当前最新的配置值
function getAfloatConfig() {
  // 传入配置前缀，直接获取对应命名空间下的所有配置
  const extensionConfig = vscode.workspace.getConfiguration('Codegenx');
  return extensionConfig.get('aFloat'); // 未手动配置时会自动返回定义的默认值1.0
}

// 初始化使用示例
console.log('当前配置值：', getAfloatConfig());

如果你的业务逻辑不需要在配置变更时主动触发动作，每次需要用到配置时直接调用上面的方法即可，不需要额外处理，天然能拿到最新值。

3 监听配置变更主动更新 #

如果你需要在用户修改配置后立刻触发对应的业务逻辑，可以注册配置变更事件监听：

function activate(context) {
  // 其他扩展激活逻辑...

  // 注册配置变更监听
  const configListener = vscode.workspace.onDidChangeConfiguration(event => {
    // 只处理当前扩展相关的配置变更，避免不必要的性能消耗
    if (event.affectsConfiguration('Codegenx.aFloat')) {
      const newValue = getAfloatConfig();
      // 这里写你配置变更后需要执行的业务逻辑
      vscode.window.showInformationMessage(`配置已更新，当前aFloat值为：${newValue}`);
    }
  });

  // 把监听器加入订阅列表，扩展卸载时会自动销毁，避免内存泄漏
  context.subscriptions.push(configListener);
}

内容的提问来源于stack exchange，提问作者Aryagm