首页 > 解决方案 > 如何在 vscode 上添加扩展设置架构?

问题描述

VS Code 中的设置支持如下图形面板:

在此处输入图像描述

我正在 vscode 中开发一个扩展,但我找不到说明如何添加这些设置的文档或示例。有没有我可以阅读的教程?

我尝试了以下配置,但 GUI 没有显示这些字段的面板:

"configuration": [
      {
        "type": "object",
        "title": "MongoDB Runner Configuration",
        "properties": {
          "mongoRunner": {
            "type": "object",
            "default": {},
            "description": "Complete connection configuration for your MongoDB.",
            "properties": {
              "connection": {
                "title": "MongoDB Runner Configuration",
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "default": "mongodb://",
                    "description": "MongoDB URI"
                  },
                  "activeOnStartUp": {
                    "type": "boolean",
                    "default": false,
                    "description": "whether launch mongodb runner on start up"
                  }
                }
              }
            }
          }
        }
      }
    ]

下面是我需要支持的json文件格式:

"mongoRunner": {
        "connection": {
            "activeOnStartUp": true,
            "url": "mongodb://localhost:27017"
        }
    },

标签: visual-studio-codevscode-settingsvscode-extensions

解决方案


这是要找的吗?您可以在描述中使用 markdown(属性markdownDescription),并使用boolean类型显示复选框。

例子:

"configuration": {
        "type": "object",
        "title": "Test configuration",
        "properties": {
                "test.usingUI": {
                        "type": "boolean",
                        "default": false,
                        "markdownDescription": "**Some bold text**\nYes or no?"
                },
                "test.text": {
                        "type": ["string", "null"],
                        "default": null,
                        "description": "You can't edit me now!"
                }
        }
    },

像这样查看 UI


编辑 - 2:

在这种情况下,您的语法格式不正确,请尝试以下操作:

    "configuration": {
        "type": "object",
        "title": "MongoDB Runner Configuration",
        "properties": {
            "mongoRunner.url": {
                "type": "string",
                "default": "mongodb://",
                "description": "MongoDB URI"
            },
            "mongoRunner.activeOnStartUp": {
                "type": "boolean",
                "default": false,
                "description": "whether launch mongodb runner on start up"
            }
        }
    },

-> 用户界面


推荐阅读