1.0.1 • Published 8 months ago
@codama/renderers-js v1.0.1
Codama ➤ Renderers ➤ JavaScript
This package generates JavaScript clients from your Codama IDLs. The generated clients are compatible with the soon-to-be-released 2.0 line of @solana/web3.js.
Installation
pnpm install @codama/renderers-js!NOTE This package is not included in the main
codamapackage.However, note that the
rendererspackage re-exports therenderVisitorfunction of this package asrenderJavaScriptVisitor.
Usage
Once you have a Codama IDL, you can use the renderVisitor of this package to generate JavaScript clients. You will need to provide the base directory where the generated files will be saved and an optional set of options to customize the output.
// node ./codama.mjs
import { renderVisitor } from '@codama/renderers-js';
const pathToGeneratedFolder = path.join(__dirname, 'clients', 'js', 'src', 'generated');
const options = {}; // See below.
codama.accept(renderVisitor(pathToGeneratedFolder, options));Options
The renderVisitor accepts the following options.
| Name | Type | Default | Description |
|---|---|---|---|
deleteFolderBeforeRendering | boolean | true | Whether the base directory should be cleaned before generating new files. |
formatCode | boolean | true | Whether we should use Prettier to format the generated code. |
prettierOptions | PrettierOptions | {} | The options to use when formatting the code using Prettier. |
asyncResolvers | string[] | [] | The exhaustive list of ResolverValueNode's names whose implementation is asynchronous in JavaScript. |
customAccountData | string[] | [] | The names of all AccountNodes whose data should be manually written in JavaScript. |
customInstructionData | string[] | [] | The names of all InstructionNodes whose data should be manually written in JavaScript. |
linkOverrides | Record<'accounts' \| 'definedTypes' \| 'instructions' \| 'pdas' \| 'programs' \| 'resolvers', Record<string, string>> | {} | A object that overrides the import path of link nodes. For instance, { definedTypes: { counter: 'hooked' } } uses the hooked folder to import any link node referring to the counter type. |
dependencyMap | Record<string, string> | {} | A mapping between import aliases and their actual package name or path in JavaScript. |
internalNodes | string[] | [] | The names of all nodes that should be generated but not exported by the index.ts files. |
nameTransformers | Partial<NameTransformers> | {} | An object that enables us to override the names of any generated type, constant or function. |
nonScalarEnums | string[] | [] | The names of enum variants with no data that should be treated as a data union instead of a native enum type. This is only useful if you are referencing an enum value in your Codama IDL. |
renderParentInstructions | boolean | false | When using nested instructions, whether the parent instructions should also be rendered. When set to false (default), only the instruction leaves are being rendered. |
useGranularImports | boolean | false | Whether to import the @solana/web3.js library using sub-packages such as @solana/addresses or @solana/codecs-strings. When set to true, the main @solana/web3.js library is used which enables generated clients to install it as a peerDependency. |