Skip to content

IDE内调试依赖库

1. 功能说明

为实现IDE中依赖库和本地项目文件的联调,开发者可将IDE中的依赖库相关资源代理至本地,并为本地依赖库项目启动调试模式,此时若项目文件有所更新,IDE中依赖库的调试效果便能同步实现更新,从而缩短依赖库项目开发起始到效果核验的链路、提高开发效率。

2. 前提条件

  1. 调试模式仅在依赖库项目中@lcap/builder版本 >=1.4.0 时支持。执行如下命令将 @lcap/builder 更新至最新版本。

    npm
    pnpm
    yarn
    sh
    $ npm install @lcap/builder@latest --save-dev
  2. 在初次调试之前,需要将待调试的本地依赖库项目发布至资产中心并引入到IDE内,否则在 IDE 内部将无法使用依赖库,进而也不能对其效果进行验收。依赖库的发布和使用具体请参考文档发布与使用

3. 功能实现

3.1 启动调试模式

  1. 在本地依赖库项目的 package.json 文件中手动添加watch命令。

    json
    {
    "scripts": {
        "watch": "lcap-scripts watch"
    }
    }
  2. 在终端运行如下命令为本地依赖库项目启动调试模式。

    sh
    npm run watch

3.2 代理资源到本地

  1. 安装代理插件,如XSwitch。

    点击展开:如何将XSwitch添加至Chrome扩展程序
    1. 下载XSwitch并进行解压。

    2. 访问chrome://extensions/管理扩展程序,开启开发者模式,点击“加载已解压的扩展程序”,选择项目文件夹,完成安装。

  2. 配置代理插件。

    markdown
    
    {
      // Use IntelliSense to learn about possible links.
      // Type `rule` to quick insert rule.
      // 输入 rule 来快速插入规则
      // For more information, visit: https://github.com/yize/xswitch
      "proxy": [
        [
          "[PLATFORM_URL]/api/v1/asset-center/library/[name]/version/[version]",
          "http://127.0.0.1:8080/api/library/schema"
        ],
        [
          "[STATIC_URL]/packages/extension/[name]@[version]/",
          "http://127.0.0.1:8080/"
        ],
      ],
    }

    注意替换如上配置为有效信息:

  • [PLATFORM_URL]:将其替换为可视化平台访问地址。

  • [STATIC_URL]:将其替换为静态资源地址。打开浏览器调试工具,在控制台中打印window.appInfo.STATIC_URL即可获取静态资源地址,使用时注意为打印结果补全协议部分,即 https://。

  • [name]:将其替换为依赖库的名称。

  • [version]:将其替换为依赖库版本号。在IDE的更多->依赖库管理中即可查看已导入依赖库的名称和版本号。

4. 效果演示

  • 确认代理配置正确,重新刷新浏览器即可开始在IDE内调试依赖库。
  • 若修改本地依赖库项目文件,保存更改后,调试模式下会自动监听文件变化并重新构建。刷新页面在依赖库管理中移除该依赖库后重新引入,即可根据本地依赖库项目同步更新IDE中的依赖库。