[Unity][小技巧]vscode快速导入"csharp"命名空间中的类型

[throw-out]

截至目前, vscode(v1.67.1)不支持import { xx } = xxx解构声明写法, 当我们需要使用csharp模块中命名空间下的类型时, 往往需要写很多额外声明语句, 例如:

import * as csharp from "csharp";
import GameObject = csharp.UnityEngine.GameObject;
import Transform = csharp.UnityEngine.Transform;

import { GameObject, Transform } = csharp.UnityEngine;		//error,

我们可以将csharp下的命名空间重新包装成新的模块csharp.namespace, import语句格式如下:

import { GameObject, Transform } from "csharp.UnityEngine";

生成工具(适用于commonjs和esm)

此功能旨在让puerts esm模块也能使用解构声明语法, 让commonjs和esm模块在typescript层语法一致, 如此我们就能自由转换工程为commonjs模块或esm模块而无需额外修改代码. 同时为csharp namespace创建额外的模块, 从而快速导入其中的类型.

puerts依赖: [2023/03/20]需使用commit 8dc1af4之后的版本

查看工具地址: GeneratorECMAScript

实现代码(仅适用于commonjs):

• modules.d.ts声明文件

/**
 * 此处仅声明接口, 运行时实现在modules.ts中
 */
declare module "csharp.System" {
    import * as csharp from "csharp";
    export = csharp.System;
}
declare module "csharp.UnityEngine" {
    import * as csharp from "csharp";
    export = csharp.UnityEngine;
}
declare module "csharp.UnityEngine.UI" {
    import * as csharp from "csharp";
    export = csharp.UnityEngine.UI;
}

• module.ts运行时文件

/**
 * modules定义实现, 在程序启动时调用
 */
import * as csharp from "csharp";

let namespaces = new Map<string, any>();
namespaces.set("csharp.System", csharp.System);
namespaces.set("csharp.UnityEngine", csharp.UnityEngine);
namespaces.set("csharp.UnityEngine.UI", csharp.UnityEngine.UI);

(function () {
    let puerts = (this ?? globalThis)["puerts"];
    namespaces.forEach((module, name) => {
        module.default = module;
        puerts.registerBuildinModule(name, module);
    });
})();

打包工具

使用webpack等打包工具时, 编译会报错Can't resolve 'xxx' in ...同样通过配置externals列表解决

 /** 忽略编辑的第三方库 */
    externals: {
        csharp: "commonjs2 csharp",
        puerts: "commonjs2 puerts",
        "csharp.System": "commonjs2 csharp.System",
        "csharp.UnityEngine": "commonjs2 csharp.UnityEngine",
        "csharp.UnityEngine.UI": "commonjs2 csharp.UnityEngine.UI",
    }

[bluedoom]

(function () {
    let puerts = (this ?? globalThis)["puerts"];
    namespaces.forEach((module, name) => {
        module.default = module;
        puerts.registerBuildinModule(name, module);
    });
})();

为啥要 module.default = module; 我试了试，下面这样也可以工作

import * as CS from "csharp";
puerts.registerBuildinModule("CS.UnityEngine.UI", CS.UnityEngine.UI)

[throw-out]

兼容import module, { typeA, typeB} from "module path";默认导入语法