如何在Node-RED贡献包的Monaco编辑器中添加全局常量模块

问题背景 #

已将私有作用域框架@scope/x-framework注入Node.js vm沙箱，Function节点代码可正常运行，但Monaco编辑器无智能提示，仅消除了红色下划线。

解决方案 #

1. 为框架添加TypeScript类型定义文件

Monaco编辑器的智能提示依赖类型定义，哪怕你的框架是纯JavaScript编写，也可以手动创建.d.ts类型文件：

• 在框架根目录创建x-framework.d.ts，定义好模块的导出结构，示例：

  declare module '@scope/x-framework' {
    export class ModbusClient {
      connect(ip: string, port: number): Promise<void>;
      readHoldingRegisters(address: number, count: number): Promise<number[]>;
      writeSingleRegister(address: number, value: number): Promise<void>;
    }
    // 根据你的框架实际API补充其他类、方法、属性定义
  }
  

2. 配置Node-RED加载类型定义

修改Node-RED的settings.js文件，找到editorTheme配置项，添加Monaco的类型定义路径：

editorTheme: {
  monaco: {
    libs: [
      {
        module: "@scope/x-framework",
        var: "xFramework",
        types: "/absolute/path/to/x-framework.d.ts"
        // 或者如果把.d.ts放到Node-RED的public目录下，用相对路径："/x-framework.d.ts"
      }
    ]
  }
}

配置完成后重启Node-RED，让设置生效。

3. 单节点临时解决方案

如果不想修改全局配置，可在单个Function节点代码开头添加类型声明注释，强制Monaco识别框架类型：

/**
 * @type {import('@scope/x-framework')}
 */
const xFramework = global.get('xFramework'); // 对应你的框架注入方式

内容的提问来源于stack exchange，提问作者JoelKrec