默认配置

很多插件是需要一些额外配置才能工作的,设置默认配置同样在package.json里:

"contributes": {
  "configuration": { // 默认配置
    "type": "object",
    "title": "",
    "required": [
      "sid"
    ],
    "properties": {
      "includes": {
        "type": "Array",
        "default": [
          "json"
        ],
        "description": "文件类型过滤器"
      }
    }
  },
}

默认配置是json schema格式,在覆盖默认配置时如果校验出错会有提示。

插件中使用getConfiguration来读取配置:

function getConfig() {
  const config = vscode.workspace.getConfiguration();
  const includes: string[] | undefined = config.get('includes'); // 获取指定配置项

  return {
    includes: includes || [],
  };
}
© 2017~ 随风逐叶 all right reserved,powered by Gitbook文章修订时间: 2021-10-20 16:11:05

results matching ""

    No results matching ""