vscode插件快餐教程(10) - 设置

简介: vscode中新增和读写配置项的方法

vscode插件快餐教程(10) - 设置

在插件中,根据用户的环境和个性化的不同,需要增加一些配置项。

读写配置项

可以通过vscode.workspace.getConfiguration()方法来获取所有的设置项。

let config: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration();

设置项可以分类,可以指定某一类前缀,来获取这一类的所有属性,例:

let config2: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration('launch');

获取的配置对象将包括:launch.configurations:Array和launch.compounds等子项。

取得到全部或者分类之后,就可以根据名称来通过get方法来读取配置项的值了:

例,我们读取一个tab等于多少个空格的选项:

    let editorConfig: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration('editor');
    let tabsize = editorConfig.get<number>('tabSize');

同样,我们可以通过WorkspaceConfiguration的update方法来更新配置项,例:

    editorConfig.update('tabSize',4);

添加自己的配置项

在package.json中,contributes下通过configuration来添加设置项,例:

    "contributes": {
        "configuration": {
            "title": "BanmaOS CodeComplete Configuration",
            "properties": {
                "banmaos.enableCodeCompletion": {
                    "type": "boolean",
                    "default": false,
                    "description": "Whether to enable AliOS code completion"
                },
                "banmaos.codeCompletionServer": {
                    "type": "string",
                    "default": "",
                    "description": "Server list for code completion"
                }
            }
        }
    }

运行后打开settings,显示出来是这个样子的:
setting

指定缺省值

自己设置的配置项可能都设了默认值,但是如果是依赖别人的配置项,可能因为环境不同就没有这个项目。这时有三个解决方案:

  1. 假设存在,然后判断undefined
  2. 先用has方法判断下存不存在
  3. 指定一个默认值, get方法的第二个函数就是干这个的:
let whatisthis = editorConfig.get<string>('notExisted',"Unknown value");

因为这个项目就是没定义,所以返回值为Unknown value。

值的优先级

在目前的版本中,配置项的值有4种:默值值、全局值、工作区值、工作区目录值。
除了默认值不能改之外,其他三个值的类型叫做ConfigurationTarget,分为Global,Workspace和WorkspaceFolder三种。
前面讲到的update方法的第三个参数就是ConfigurationTarget值。可以直接指定ConfigurationTarget,也可以给一个布尔值,true表示Global,false表示Workspace。如果为空或者undefined,则优先选WorkspaceFolder,如果不适用则自动适配为Workspace.

例:带有ConfigurationTarget的更新:

    editorConfig.update('tabSize',4, vscode.ConfigurationTarget.Global);
    editorConfig.update('tabSize',4, true);

值这么多有点乱哈,所以vscode为我们提供了一个方法去检查这个配置项的所有值,即inspect方法。我们看个例子:

console.log(editorConfig.inspect<string>('tabSize'));

输出的对象类似这样:

key:"editor.tabSize"
defaultValue:4
globalValue:4
workspaceValue:4
目录
相关文章
|
2月前
|
iOS开发 MacOS
【Mac系统】解决Vscode中LeetCode插件不能刷剑指offer题库
文章讨论了解决Mac系统中Vscode里LeetCode插件无法刷剑指Offer题库的问题,并提供了一些相关的使用技巧和资源链接。
134 1
|
2月前
|
前端开发 Go
vscode10大常用插件
本文介绍了前端开发中常用的工具及VSCode必备插件。推荐使用VSCode作为入门工具,并介绍了WebStorm和HBuilder等其他选项。VSCode插件包括:Open-In-Browser、live-server、Beautify、Code Runner、Image Preview、Path Intellisense、Turbo Console Log、css-auto-prefix、Bracket Pair Colorizer 和 Auto Rename Tag,这些插件能够显著提升开发效率和代码质量。此外,还提供了录制Gif图的工具GifCam。
79 5
vscode10大常用插件
|
26天前
|
人工智能 C++ 开发者
verilog vscode 与AI 插件
【9月更文挑战第11天】在Verilog开发中,使用Visual Studio Code(VS Code)结合AI插件能显著提升效率。VS Code提供强大的编辑功能,如语法高亮、自动补全和代码格式化;便捷的调试功能,支持多种调试器;以及丰富的插件生态。AI插件则可自动生成代码、优化现有代码、检测并修复错误,还能自动生成文档。常用插件包括Verilog AI Assistant和Verilog Language Server,可根据需求选择合适的工具组合,提高开发效率和代码质量。
2022最新最详细必成功的在Vscode中设置背景图、同时解决不受支持的问题
这篇文章提供了在VScode中设置背景图的详细步骤,包括下载background插件、编辑setting.json文件、配置背景样式,并解决了设置后出现的不支持提示的问题。
2022最新最详细必成功的在Vscode中设置背景图、同时解决不受支持的问题
|
2月前
|
前端开发 IDE 开发工具
OpenSumi问题之OpenSumi 对于 VS Code 插件生态要如何支持
OpenSumi问题之OpenSumi 对于 VS Code 插件生态要如何支持
Vscode设置标签页多行显示
这篇文章提供了在VSCode中设置标签页多行显示的方法,以提高编辑效率。
Vscode设置标签页多行显示
|
2月前
|
编译器 C++
VS Code设置C++编译器路径
VS Code设置C++编译器路径
32 0
|
2月前
|
JSON 前端开发 JavaScript
这 2 个插件,让你的 vscode更牛逼
这 2 个插件,让你的 vscode更牛逼
|
2月前
vscode——Prettier插件保存自动格式化
vscode——Prettier插件保存自动格式化
52 0
|
2月前
|
JavaScript Linux iOS开发
【Mac系统】Vscode使用LeetCode插件报错‘leetcode.toggleLeetCodeCn‘ not found
在Mac系统下使用VSCode的LeetCode插件时遇到“leetcode.toggleleetcodecn”命令找不到的错误解决方法,主要是通过从Nodejs官网下载并安装最新版本的Node.js来解决环境配置问题。
148 0