我是否正确理解此 VS Code API 行为？ 非默认 *object* 设置（如果提供）总是合并？

Question

我正在开发一个 VS 代码扩展，我想也许我在文档中遗漏了一些东西，或者我看到的行为没有在那里指定，我的假设是错误的......？

我已经为我的扩展定义了一些默认设置，就像这样......

package.json

  "contributes": {
    "configuration": {
      "title": "ToggleSettingsChanges",
      "properties": {
        "toggleSettingsChanges.settingsToToggle": {
          "scope": "resource",
          "type": "object",
          "default": {
            "window.zoomLevel": 2,
            "editor.fontSize": 22,
            "terminal.integrated.fontSize": 16,
            "scm.diffDecorations": "none",
            "workbench.statusBar.visible": false,
            "editor.cursorBlinking": "solid",
            "workbench.activityBar.visible": false
          },
          "description": "[ snip ]"
        }
      }
    }
  },

扩展.js

// In the "main" method that runs when a command is activated:

const config = vscode.workspace.getConfiguration("toggleSettingsChanges");
const settingsToToggle = config.get("settingsToToggle");
const inspectedSettingsToToggle = config.inspect("settingsToToggle");

console.log("settingsToToggle:", JSON.stringify(settingsToToggle), "\n\n")
console.log("inspected settingsToToggle:", JSON.stringify(inspectedSettingsToToggle), "\n\n")
return;

在扩展主机实例中，我可以调整和调整设置，包括：

用户或工作区设置 JSON

// ... 
"toggleSettingsChanges.settingsToToggle": {
  "editor.fontSize": 11,
  "pumpkins_are_great": true
},

在控制台 output 中，我看到以下内容：

settingsToToggle: {"window.zoomLevel":2,"editor.fontSize":11,"terminal.integrated.fontSize":16,"scm.diffDecorations":"none","workbench.statusBar.visible":false,"editor.cursorBlinking":"solid","workbench.activityBar.visible":false,"pumpkins_are_great":true} 

inspected settingsToToggle: {"key":"toggleSettingsChanges.settingsToToggle","defaultValue":{"window.zoomLevel":2,"editor.fontSize":22,"terminal.integrated.fontSize":16,"scm.diffDecorations":"none","workbench.statusBar.visible":false,"editor.cursorBlinking":"solid","workbench.activityBar.visible":false},"globalValue":{"editor.fontSize":11,"pumpkins_are_great":true}} 

对于settingsToToggle行，我希望只看到以下设置：

{"editor.fontSize":11,"pumpkins_are_great":true}

似乎如果您提供 object 默认值，则提供的任何配置都会与该 object 合并，而不是完全替换它。

是这样吗？ 我在文档中错过了这个吗？

在我看来，一个值（甚至是一个对象）会被覆盖，而不是简单地合并。

Answer 1

自发布此问题以来，文档可能已更新。 它现在的写法，对我来说似乎很清楚。 我正在写，因为我觉得我在 API 中发现了一个差异，这可能有助于 OP。

参考

注意：只有 object 值类型被合并，所有其他值类型被覆盖。

-- VS 代码 API - 工作区配置

---

附加信息

如上所述，我希望将我的默认值与用户设置合并。 看到我的默认设置被覆盖，我感到很困惑。 这个问题帮助我理解了正在发生的事情。 我会分享我的方法，因为 OP 可能会感兴趣。 我的观察：

• package.json中提供的默认值与用户设置合并，如文档（上面的链接）中所述。

• 使用WorkspaceConfiguration.get(section, defaultValue)以编程方式传递的默认值不表现出合并行为。 目前尚不清楚这是否是故意的。 更新：此行为按预期工作，参考#105598 。