Initial commit

Copy/pasted from Codama monorepo as-is.

Author: lorisleiva

.gitignore

@@ -0,0 +1 @@
+dist/

.prettierignore

@@ -0,0 +1,5 @@
+dist/
+test/e2e/
+test-ledger/
+target/
+CHANGELOG.md

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Codama
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,32 @@
+# Codama ➤ Renderers ➤ Demo
+
+[![npm][npm-image]][npm-url]
+[![npm-downloads][npm-downloads-image]][npm-url]
+
+[npm-downloads-image]: https://img.shields.io/npm/dm/@codama/renderers-demo.svg?style=flat
+[npm-image]: https://img.shields.io/npm/v/@codama/renderers-demo.svg?style=flat&label=%40codama%2Frenderers-demo
+[npm-url]: https://www.npmjs.com/package/@codama/renderers-demo
+
+This package provides a demo implementation of a Codama renderer to help developers create their own.
+
+## Installation
+
+```sh
+pnpm install @codama/renderers-demo
+```
+
+## Usage
+
+Add the following script to your Codama configuration file.
+
+```json
+{
+    // ...
+    "scripts": {
+        "demo": {
+            "from": "@codama/renderers-demo",
+            "args": ["docs"]
+        }
+    }
+}
+```

package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@codama/renderers-demo",
+  "version": "1.0.1",
+  "description": "Demo renderer to help creating new ones",
+  "exports": {
+    "types": "./dist/types/index.d.ts",
+    "react-native": "./dist/index.react-native.mjs",
+    "browser": {
+      "import": "./dist/index.browser.mjs",
+      "require": "./dist/index.browser.cjs"
+    },
+    "node": {
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.cjs"
+    }
+  },
+  "browser": {
+    "./dist/index.node.cjs": "./dist/index.browser.cjs",
+    "./dist/index.node.mjs": "./dist/index.browser.mjs"
+  },
+  "main": "./dist/index.node.cjs",
+  "module": "./dist/index.node.mjs",
+  "react-native": "./dist/index.react-native.mjs",
+  "types": "./dist/types/index.d.ts",
+  "type": "commonjs",
+  "files": [
+    "./dist/types",
+    "./dist/index.*"
+  ],
+  "sideEffects": false,
+  "keywords": [
+    "solana",
+    "framework",
+    "standard",
+    "renderers",
+    "demo"
+  ],
+  "scripts": {
+    "build": "rimraf dist && tsup && tsc -p ./tsconfig.declarations.json",
+    "dev": "vitest --project node",
+    "lint": "eslint . && prettier --check .",
+    "lint:fix": "eslint --fix . && prettier --write .",
+    "test": "pnpm test:types && pnpm test:treeshakability && pnpm test:unit && pnpm test:e2e && pnpm test:exports",
+    "test:e2e": "./test/e2e/test.sh",
+    "test:exports": "node ./test/exports/module.mjs && node ./test/exports/commonjs.cjs",
+    "test:treeshakability": "for file in dist/index.*.mjs; do agadoo $file; done",
+    "test:types": "tsc --noEmit",
+    "test:unit": "vitest run"
+  },
+  "dependencies": {
+    "@codama/errors": "workspace:*",
+    "@codama/nodes": "workspace:*",
+    "@codama/renderers-core": "workspace:*",
+    "@codama/visitors-core": "workspace:*",
+    "@solana/codecs": "^3.0.3"
+  },
+  "devDependencies": {
+    "@codama/cli": "workspace:*"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/codama-idl/codama"
+  },
+  "bugs": {
+    "url": "http://github.com/codama-idl/codama/issues"
+  },
+  "browserslist": [
+    "supports bigint and not dead",
+    "maintained node versions"
+  ]
+}

src/fragments/accountPage.ts

@@ -0,0 +1,36 @@
+import { AccountNode, PdaNode, titleCase } from '@codama/nodes';
+import { visit } from '@codama/visitors-core';
+
+import {
+    Fragment,
+    fragment,
+    getCodeBlockFragment,
+    getFrontmatterFragment,
+    getPageFragment,
+    getTitleAndDescriptionFragment,
+} from '../utils';
+import { TypeVisitor } from '../visitors/getTypeVisitor';
+import { getPdaFunctionUsageFragment } from './pdaFunctionUsage';
+
+export function getAccountPageFragment(
+    node: AccountNode,
+    typeVisitor: TypeVisitor,
+    size?: number,
+    pda?: PdaNode,
+): Fragment {
+    const title = titleCase(node.name);
+    const type = visit(node, typeVisitor);
+
+    return getPageFragment(
+        [
+            getFrontmatterFragment(title, `Overview of the ${title} account`),
+            getTitleAndDescriptionFragment(title, node.docs),
+            fragment`## Account data`,
+            getCodeBlockFragment(type, 'ts'),
+            ...(size ? [fragment`This account has a fixed size of ${size} bytes.`] : []),
+            ...(pda ? [fragment`## PDA`, getCodeBlockFragment(getPdaFunctionUsageFragment(pda), 'ts')] : []),
+        ],
+        // Generated accounts are within the same directory.
+        { generatedAccounts: '.' },
+    );
+}

src/fragments/definedTypePage.ts

@@ -0,0 +1,28 @@
+import { DefinedTypeNode, titleCase } from '@codama/nodes';
+import { visit } from '@codama/visitors-core';
+
+import {
+    Fragment,
+    fragment,
+    getCodeBlockFragment,
+    getFrontmatterFragment,
+    getPageFragment,
+    getTitleAndDescriptionFragment,
+} from '../utils';
+import { TypeVisitor } from '../visitors/getTypeVisitor';
+
+export function getDefinedTypePageFragment(node: DefinedTypeNode, typeVisitor: TypeVisitor): Fragment {
+    const title = titleCase(node.name);
+    const type = visit(node, typeVisitor);
+
+    return getPageFragment(
+        [
+            getFrontmatterFragment(title, `Overview of the ${title} type`),
+            getTitleAndDescriptionFragment(title, node.docs),
+            fragment`## Type definition`,
+            getCodeBlockFragment(type, 'ts'),
+        ],
+        // Generated types are within the same directory.
+        { generatedTypes: '.' },
+    );
+}

src/fragments/index.ts

@@ -0,0 +1,9 @@
+export * from './accountPage';
+export * from './definedTypePage';
+export * from './instructionAccounts';
+export * from './instructionPage';
+export * from './pdaFunctionUsage';
+export * from './pdaPage';
+export * from './pdaSeeds';
+export * from './programErrors';
+export * from './programPage';

src/fragments/instructionAccounts.ts

@@ -0,0 +1,23 @@
+import { camelCase, InstructionAccountNode } from '@codama/nodes';
+
+import { Fragment, getTableFragment } from '../utils';
+
+export function getInstructionAccountsFragment(accounts: InstructionAccountNode[]): Fragment | undefined {
+    if (accounts.length === 0) return;
+
+    const hasDescriptions = (accounts ?? []).some(account => account.docs && account.docs.length > 0);
+    const accountHeaders = ['Name', 'Signer', 'Writable', 'Required', ...(hasDescriptions ? ['Description'] : [])];
+    const accountRows = accounts.map(account => [
+        `\`${camelCase(account.name)}\``,
+        formatBoolean(account.isSigner ?? false),
+        formatBoolean(account.isWritable ?? false),
+        formatBoolean(!(account.isOptional ?? false)),
+        ...(hasDescriptions ? [(account.docs ?? []).join(' ')] : []),
+    ]);
+
+    return getTableFragment(accountHeaders, accountRows);
+}
+
+function formatBoolean(value: boolean | 'either') {
+    return value === 'either' ? value : value ? '✅' : '❌';
+}

src/fragments/instructionPage.ts

@@ -0,0 +1,33 @@
+import { InstructionNode, titleCase } from '@codama/nodes';
+import { visit } from '@codama/visitors-core';
+
+import {
+    Fragment,
+    fragment,
+    getCodeBlockFragment,
+    getFrontmatterFragment,
+    getPageFragment,
+    getTitleAndDescriptionFragment,
+} from '../utils';
+import { TypeVisitor } from '../visitors/getTypeVisitor';
+import { getInstructionAccountsFragment } from './instructionAccounts';
+
+export function getInstructionPageFragment(node: InstructionNode, typeVisitor: TypeVisitor): Fragment {
+    const title = titleCase(node.name);
+    const type = visit(node, typeVisitor);
+    const accountsFragment = getInstructionAccountsFragment(node.accounts);
+    const hasArguments = node.arguments.length > 0;
+
+    return getPageFragment(
+        [
+            getFrontmatterFragment(title, `Overview of the ${title} instruction`),
+            getTitleAndDescriptionFragment(title, node.docs),
+            fragment`## Instruction accounts`,
+            accountsFragment ? accountsFragment : fragment`_This instruction has no accounts._`,
+            fragment`## Instruction arguments`,
+            hasArguments ? getCodeBlockFragment(type, 'ts') : fragment`_This instruction has no arguments._`,
+        ],
+        // Generated instructions are within the same directory.
+        { generatedInstructions: '.' },
+    );
+}