科达马 · · · 渲染器 · · JavaScript Umi
此软件包从您的 Codama IDL 生成 JavaScript 客户端 。 生成的客户端与 Metaplex 兼容 UMI 框架。 。 。 .
安装
pnpm install @codama/renderers-js-umi
使用量
在您的 Codama 配置文件中添加以下脚本 .
{
"scripts": {
"js": {
"from": "@codama/renderers-js-umi",
"args": ["clients/js/src/generated"]
}
}
}
一个对象可以被传递作为第二个参数来进一步配置渲染器. 见 选项 详细情况见下文.
选项
这个 renderVisitor 接受以下选项.
| 名称 | 类型 | 默认 | 说明 |
|---|---|---|---|
deleteFolderBeforeRendering | boolean | true | 是否在生成新文件之前要清理基准目录 . |
formatCode | boolean | true | 我们是否应该使用 Pretier 格式化生成的代码 . |
prettierOptions | PrettierOptions | {} | 使用 Pretier 格式化代码时使用的选项 . |
throwLevel | 'debug' | 'trace' | 'info' | 'warn' | 'error' | 'error' | 校验 Codama IDL 时, 校验应投出错误的级别 . |
customAccountData | string[] | [] | 所有人的名字 AccountNodes 其数据应手动用 JavaScript 写入 . |
customInstructionData | string[] | [] | 所有人的名字 InstructionNodes 其数据应手动用 JavaScript 写入 . |
linkOverrides | Record<'accounts' | 'definedTypes' | 'instructions' | 'pdas' | 'programs' | 'resolvers', Record<string, string>> | {} | 覆盖链接节点导入路径的对象 。 比如说, { definedTypes: { counter: 'hooked' } } 使用该 hooked 文件夹以导入任何提及此文件夹的链接节点 counter 类型. |
dependencyMap | Record<string, string> | {} | 在 JavaScript 中将导入化名和它们实际的软件包名称或路径进行映射. |
internalNodes | string[] | [] | 用于生成但不导出的所有节点的名称 index.ts 文档. |
nonScalarEnums | string[] | [] | 没有数据应作为数据联盟而不是本地数据联盟的enum变体的名称 enum 类型。 只有当您在您的 Codama IDL 中引用一个 enum 值时,此选项才有用 . |
renderParentInstructions | boolean | false | 使用嵌入式指令时,是否还应当提供母指令. 设定为 false (默认),只提供指示叶. |