VS Code API：扩展设置如何支持自定义变量及读取配置？

嘿，我来帮你搞定这个配置读取的问题！首先得纠正你代码里的一个小误区：vscode.workspace.getConfiguration('settings') 这么写不对，因为getConfiguration的参数应该是你的扩展的唯一ID，而不是通用的settings。下面一步步教你实现自定义配置的读取：

1. 先在package.json里声明你的配置项 #

首先得让VS Code知道你的扩展支持哪些自定义配置，打开扩展根目录的package.json，添加contributes.configuration字段，把你需要的对齐位置、填充字符都定义进去：

{
  "contributes": {
    "configuration": {
      "title": "C-style Comment Formatter",
      "properties": {
        "cCommentFormatter.alignmentPosition": {
          "type": "number",
          "default": 90,
          "description": "The column position where comments should be aligned."
        },
        "cCommentFormatter.fillCharacter": {
          "type": "string",
          "default": "-",
          "description": "The character used to fill the space before the aligned comment."
        }
      }
    }
  }
}

这里cCommentFormatter是你的扩展ID（要和package.json里的name字段完全一致），这样用户就能在VS Code的设置面板里轻松找到你的扩展配置项了。

2. 正确读取配置值 #

现在你可以在TypeScript代码里通过扩展ID来获取配置：

// 获取扩展专属的配置对象
const extensionConfig = vscode.workspace.getConfiguration('cCommentFormatter');

// 读取具体配置项，用泛型保证类型安全，同时带默认值兜底
const alignmentPosition = extensionConfig.get<number>('alignmentPosition', 90);
const fillCharacter = extensionConfig.get<string>('fillCharacter', '-');

// 接下来就可以用这些值来生成符合用户需求的注释了
console.log(`将注释对齐到第${alignmentPosition}列，填充字符为${fillCharacter}`);

第二个参数是默认值，能防止用户未配置时程序出现异常。

3. 监听配置变化（可选但推荐） #

如果用户在使用你的扩展过程中修改了配置，你可以监听配置变化事件，实时更新配置值，不用让用户重启VS Code：

// 订阅配置变化事件
const disposable = vscode.workspace.onDidChangeConfiguration(event => {
  if (event.affectsConfiguration('cCommentFormatter')) {
    // 重新读取最新配置
    const newConfig = vscode.workspace.getConfiguration('cCommentFormatter');
    alignmentPosition = newConfig.get<number>('alignmentPosition', 90);
    fillCharacter = newConfig.get<string>('fillCharacter', '-');
    // 这里可以添加更新逻辑，比如自动重新格式化当前文档的注释
  }
});

// 记得把disposable加入上下文订阅，确保扩展卸载时能正确清理资源
context.subscriptions.push(disposable);

这样用户修改配置后，你的扩展就能立刻响应新的设置啦！

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