fluxon-functions.json,供 VS Code 补全、文档与其他工具共享。
本页是关于函数目录结构的 canonical 参考页。其他页面如需引用字段定义,应链接到这里而不是重复粘贴。
文件位置
默认输出:core/build/fluxon-functions.json(由 :core:dumpFluxonCatalog 任务生成)。
结构定义
目录由org.tabooproject.fluxon.tool.FunctionDumper 输出,包含三个顶级字段:
generatedAt:生成时间戳(ISO-8601)。system:系统函数清单(全局函数;是否需要import由条目中的namespace决定)。extensions:扩展函数清单,按宿主类型分组(键为Class#getName()),用于target::method()的补全与检索。
函数条目字段
| 字段 | 说明 |
|---|---|
name | 函数名(脚本侧的调用名)。 |
namespace | 可选。若存在,脚本侧需要 import 'namespace' 才能解析到该函数/扩展。 |
params | 合法的参数个数列表(用于补全与语义检查,不包含参数类型)。 |
async | 是否异步函数。若为 true,调用通常会返回异步句柄,并需要在支持的上下文中 await。 |
primarySync | 是否强制在“主线程执行器”上运行(由宿主通过 FluxonRuntime#setPrimaryThreadExecutor 提供执行器)。 |
如何生成
推荐使用 Gradle 任务(自动准备 classpath):何时重新导出
- 新增 / 删除 / 重命名运行时函数或扩展函数。
- 变更参数个数、命名空间或同步/异步属性。
- 发布 VS Code 扩展或更新文档参考页前。
典型消费方
vscode-extension/scripts/sync-catalog.js:将目录复制到扩展数据目录,驱动补全。- 文档:用于说明内置函数与扩展函数的“可用性边界”(但字段定义仅以本页为准)。
- 外部工具:可按字段含义解析 JSON,自行生成提示或校验。