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
目录
相关文章
|
8月前
|
人工智能 自然语言处理 Java
DeepSeek 满血版在 VScode 和 IDEA 中怎么用?手把手教程来了
沉默王二分享了通义灵码的使用教程,这款插件集成了DeepSeek-R1和Qwen等模型,支持Java、Python、Go等多种编程语言,适用于IDEA、VSCode等开发环境。它不仅能提供智能问答、代码补全和Bug修复功能,还能通过“AI程序员”实现多文件代码修改。体验流畅,算力充足,无需担心限流问题。文章详细介绍了安装步骤及各项功能的实际操作,展示了其在提升开发效率方面的强大实力。目前,通义灵码正持续优化,未来将带来更多惊喜。
1493 1
|
4月前
|
Ubuntu 网络安全 PHP
如何使用vscode的Docker插件管理ubuntu 拉取服务器的镜像以及创建容器
本测试镜像旨在记录使用vscode的Docker插件拉取病创建Dockerfile,以及拉取镜像。
|
自然语言处理 API C++
阿里通义推出SmartVscode插件,自然语言控制VS Code,轻松开发应用,核心技术开源!
SmartVscode插件深度解析:自然语言控制VS Code的革命性工具及其开源框架App-Controller
1707 1
阿里通义推出SmartVscode插件,自然语言控制VS Code,轻松开发应用,核心技术开源!
|
10月前
|
机器学习/深度学习 人工智能 自然语言处理
|
9月前
|
人工智能 网络安全 开发工具
vscode代码推送到github库菜鸡专用教程
vscode代码推送到github库菜鸡专用教程
|
8月前
|
JavaScript 前端开发 程序员
甚至用不了五分钟就能学会vscode插件开发
本文介绍了VSCode插件的开发流程,从创建项目到最终发布。首先通过安装`yo`和`generator-code`脚手架工具初始化项目,选择JavaScript语言配置基础信息。接着,在`extension.js`中实现业务逻辑,例如将中文“变量”替换为“var”。通过F5进入调试模式验证功能。完成后使用`vsce`工具进行打包,解决可能遇到的版本不兼容或README文档问题。最后生成`.vsix`文件,可通过VSCode的“从VSIX安装”加载插件,实现开发闭环。进一步可将插件发布至官方市场供更多开发者使用。
|
10月前
|
人工智能 自然语言处理 前端开发
通义灵码插件在VSCode中的运用
借助通义灵码插件在VSCode构建新闻网,实现效率与智能的融合。VSCode作为前端开发的“瑞士军刀”,提供实时预览、智能辅助和高效管理功能;通义灵码插件通过自然语言交互生成代码,简化复杂任务并优化代码质量。两者结合形成从设计到部署的高效闭环,大幅减少基础编码时间,降低开发门槛,助力开发者聚焦业务逻辑与创新。
|
10月前
|
人工智能 小程序 程序员
【视频测评 DEMO 参考】VSCode 神级 AI 插件通义灵码:完全免费+实战教程+微信贪吃蛇小程序
VSCode 神级 AI 插件通义灵码:完全免费+实战教程+微信贪吃蛇小程序
734 8
|
开发工具 C++ git
利用VS Code提升开发效率的五大插件推荐
本文推荐了五款能显著提升开发效率的VS Code插件:ESLint用于代码质量和风格检查;Prettier自动格式化代码;GitLens增强Git功能;Live Server提供前端实时预览;Docker支持容器管理。
|
JavaScript 前端开发 开发者
如何在 Visual Studio Code (VSCode) 中使用 ESLint 和 Prettier 检查代码规范并自动格式化 Vue.js 代码,包括安装插件、配置 ESLint 和 Prettier 以及 VSCode 设置的具体步骤
随着前端开发技术的快速发展,代码规范和格式化工具变得尤为重要。本文介绍了如何在 Visual Studio Code (VSCode) 中使用 ESLint 和 Prettier 检查代码规范并自动格式化 Vue.js 代码,包括安装插件、配置 ESLint 和 Prettier 以及 VSCode 设置的具体步骤。通过这些工具,可以显著提升编码效率和代码质量。
2387 4