vscode debugger 扩展

简介: vscode debugger 扩展

debugger-extension 文档

扩展调试插件官方示例

contributes

// 为vscode提供一个调试器
"debuggers": [
      {
        "type": "my-debug-type", // ./vscode/launch.json 中的唯一ID
        "label": "my-debug-label",// 在UI中显示的调试器名字
        "program": "./out/debugAdapter.js", // 指向实现vscode调试协议的可执行程序
        "runtime": "node",// 指向实现vscode调试协议的运行时
        "languages": [ // 语言默认的调试器
          "typescript"
        ],
        "configurationAttributes": { // 启动配置参数的格式以及属性
          "launch": {}
        },
        "initialConfigurations": [ // 填充launch.json的初始配置参数
          {
            "type": "my-debug-type",
            "request": "launch",
            "name": "initialConfigurations-name",
            "program": ""
          }
        ],
        "configurationSnippets":[ // 当编辑launch.json时,列出来智能感知的调试配置
        ]
      }
    ]
复制代码

configurationSnippets

如下配置:

{
    "label": "cc-plugin-debugger",
    "description": "描述",
    "body": {
      "type": "node",
      "request": "attach",
      "port": 5263
    }
}
复制代码

当我们修改launch.json时,就会感知到这个调试器配置

网络异常,图片无法展示
|

注册配置并运行

当插件激活时,注册配置,这样在launch.json就能识别到这个type,这里的注册类型需要和launch.json中对应

const type = 'cc-plugin-debugger';
const provider = new MyDebugCfgProvider();
context.subscriptions.push(vscode.debug.registerDebugConfigurationProvider(type, provider));
复制代码

当我们运行配置时:

网络异常,图片无法展示
|

就会触发resolveDebugConfiguration

import { CancellationToken, DebugConfiguration, DebugConfigurationProvider, ProviderResult, WorkspaceFolder } from 'vscode';
export class MyDebugCfgProvider implements DebugConfigurationProvider {
    resolveDebugConfiguration(folder: WorkspaceFolder | undefined, debugConfiguration: DebugConfiguration, token?: CancellationToken | undefined): ProviderResult<DebugConfiguration> {
        return debugConfiguration;
    }
    dispose() {
    }
}
复制代码
/**
 * 为特定的调试类型注册调试配置提供程序。
 * 可选的triggerKind可以用来指定何时触发提供程序的' provideDebugConfigurations '方法。
 * 当前可能有两种触发器类型:带有' Initial '值(或者如果没有给定触发器类型参数)的' provideDebugConfigurations '方法用于提供要复制到新创建的launch.json中的初始调试配置。
 * 对于触发器类型' Dynamic ', ' provideDebugConfigurations '方法用于动态地决定呈现给用户的调试配置(除了launch.json中的静态配置)。
 * 请注意,' triggerKind '参数只适用于' provideDebugConfigurations '方法:所以' resolveDebugConfiguration '方法根本不受影响。
 * 将单个提供者注册为针对不同触发器类型的解析方法,将导致多次调用相同的解析方法。
 * 可以为同一类型注册多个提供者。
 *
 * @param type 提供程序为其注册的调试类型。
 * @param provider 要注册的调试配置提供程序。
 * @param triggerKind 为其注册提供程序的“提供调试配置”方法的触发器。如果“触发类型”缺失,则值“调试配置提供程序触发类型”。最初的假设。
 * @return 释放时取消注册此提供程序的disposable对象。
 */
export function registerDebugConfigurationProvider(debugType: string, provider: DebugConfigurationProvider, triggerKind?: DebugConfigurationProviderTriggerKind): Disposable;
/**
 * 为特定的调试类型注册一个调试适配器描述符工厂。
 * 扩展只允许为扩展定义的调试类型注册调试适配器描述符工厂。
 * 否则将抛出一个错误。
 * 为一个调试类型注册多个调试适配器描述符工厂会导致错误。
 *
 * @param debugType 工厂注册的调试类型。
 * @param factory 要注册的debug适配器描述符工厂。
 * @return 丢弃时取消该工厂的注册。
 只有注册了这个函数,才会调用DebugSession里面的initializeRequest
 */
export function registerDebugAdapterDescriptorFactory(debugType: string, factory: DebugAdapterDescriptorFactory): Disposable;
复制代码

调试器初始化请求

protected initializeRequest(response: DebugProtocol.InitializeResponse, args: DebugProtocol.InitializeRequestArguments): void {}
复制代码

详细的参数含义:

const args = {
    adapterID: 'cc-plugin-debugger',// 调试器的ID
    clientID: 'vscode', // 使用调试器的客户端ID
    clientName: 'Visual Studio Code',// 具有可读性的使用调试器客户端名字
    columnsStartAt1: true,// 如果为true,所有的列号从1开始,默认为true
    linesStartAt1: true,// 如果为true,所有的行号从1开始,默认为true
    locale: 'en', // 客户端区域
    pathFormat: 'path',// 路径的格式
    supportsArgsCanBeInterpretedByShell: true,// 客户端支持“runInTerminal”请求的“argsCanBeInterpretedByShell”属性。
    supportsInvalidatedEvent: true,// 客户端支持无效事件。
    supportsMemoryEvent: true,// 支持内存事件
    supportsMemoryReferences: true,// 客户端支持内存引用
    supportsProgressReporting: true,// 客户端支持进度报告
    supportsRunInTerminalRequest: true,// 客户端支持“runInTerminal”请求
    supportsVariablePaging: true,// 客户端支持变量的分页属性
    supportsVariableType: true, // 客户端支持变量的type属性
}
const res = {
    body: {}, // 调试器的功能
    command: 'initialize',
    request_seq: 1,
    seq: 0,
    success: true,
    type: 'response',
}
复制代码


目录
相关文章
|
Web App开发 JavaScript 前端开发
Vue系列教程(04)- VsCode断点调试(Debugger for Chrome)
Vue系列教程(04)- VsCode断点调试(Debugger for Chrome)
403 0
|
7月前
|
API C++ 容器
VSCode扩展
VSCode扩展
|
JavaScript 前端开发 Java
❤️5 个使重构变得容易的 VS Code 扩展❤️(建议收藏)
❤️5 个使重构变得容易的 VS Code 扩展❤️(建议收藏)
88 1
|
JavaScript API 开发者
为依赖Angular.js的上古项目给VSCode编写$scope定义跳转扩展插件
虽然Angular.js停止更新已经一年了,但依赖它的上古时代的项目并不少。由于都是使用js开发,很难为其提供很好的维护,所以直到今天开发维护也并不愉快。可以说没有开发插件的支持,再成熟老练的框架都发挥困难。
176 0
为依赖Angular.js的上古项目给VSCode编写$scope定义跳转扩展插件
|
前端开发
Web前端 — VSCode实用扩展插件
在Web前端开发中常用的 VSCode 插件 内容来源 前端VSCode常用插件-快捷键-以及常用技巧-pink老师 下面介绍插件如何下载和使用 如有帮助,请关注点赞支持博主,后期会出其他相关软件安装教程!!!
223 0
|
存储 机器学习/深度学习 传感器
vscode 常用的扩展插件有哪些?
VS Code有许多常用的扩展插件,下面是一些常见且受欢迎的扩展插件: 1. Live Server:提供了一个本地开发服务器,可以在编辑器中实时预览和调试HTML、CSS和JavaScript文件。 2. Prettier - Code formatter:自动格式化代码,使其符合一致的编码风格。 3. GitLens — Git supercharged:增强了对Git存储库的操作和视觉化,可以轻松查看文件的Git历史、作者信息以及行级别的注释和更改。 4. ESLint:集成了ESLint静态代码分析工具,用于在编写代码时捕获常见的错误和编码规范问题。 5. Visual St
301 0
|
Linux Go C++
VS CODE插件扩展无法使用的解决办法
VS CODE插件扩展无法使用的解决办法
2565 1
VS CODE插件扩展无法使用的解决办法
|
前端开发
前端知识学习案例7vs code-安装扩展
前端知识学习案例7vs code-安装扩展
77 0
前端知识学习案例7vs code-安装扩展
|
Ubuntu Linux
Ubuntu 20.04 右键扩展在vscode中打开
Ubuntu 20.04 右键扩展在vscode中打开
1000 0
Ubuntu 20.04 右键扩展在vscode中打开
|
JavaScript API
vscode 扩展开发从入门到颈椎病康复
  笔者从业以来,各路插件开发无算,而 vscode 把插件开发体验做到了极致。其开发体验,如沐春风,如丝般顺滑,经常写完了还想删掉再写一遍!   vscode 扩展的内置脚手架细心且精致,一键生成后即可运行。vscode 库类型完美,因此开发者可以仅通过 IDE 提示来猜到 API,省去了很多文档查阅成本。最后,vscode 扩展开发文档丰富、开发体系清
1754 0

热门文章

最新文章