cleanup

macalinao · macalinao · commit adb097fafb67 · 2025-08-22T16:09:28.000+08:00
diff --git a/clients/quarry/coda.config.mjs b/clients/quarry/coda.config.mjs
@@ -9,6 +9,9 @@ import { renameVisitor } from "@macalinao/codama-rename-visitor";
 
 export default defineConfig({
   outputDir: "./src/generated",
+  docs: {
+    npmPackageName: "@macalinao/clients-quarry",
+  },
 
   visitors: [
     addPdasVisitor({
diff --git a/clients/quarry/docs/quarry-merge-mine.md b/clients/quarry/docs/quarry-merge-mine.md
@@ -1,6 +1,9 @@
 # Quarry Merge Mine Program
 
+[![npm version](https://badge.fury.io/js/%40macalinao%2Fclients-quarry.svg)](https://www.npmjs.com/package/%40macalinao%2Fclients-quarry)
+
 - Program ID: `QMMD16kjauP5knBwxNUJRZ1Z5o3deBuFrqVjBVmmqto`
+- TypeScript Client: [`@macalinao/clients-quarry`](https://www.npmjs.com/package/@macalinao/clients-quarry)
 
 ## Table of Contents
 
diff --git a/clients/quarry/docs/quarry-mine.md b/clients/quarry/docs/quarry-mine.md
@@ -1,6 +1,9 @@
 # Quarry Mine Program
 
+[![npm version](https://badge.fury.io/js/%40macalinao%2Fclients-quarry.svg)](https://www.npmjs.com/package/%40macalinao%2Fclients-quarry)
+
 - Program ID: `QMNeHCGYnLVDn1icRAfQZpjPLBNkfGbSKRB83G5d8KB`
+- TypeScript Client: [`@macalinao/clients-quarry`](https://www.npmjs.com/package/@macalinao/clients-quarry)
 
 ## Table of Contents
 
diff --git a/clients/quarry/docs/quarry-mint-wrapper.md b/clients/quarry/docs/quarry-mint-wrapper.md
@@ -1,6 +1,9 @@
 # Quarry Mint Wrapper Program
 
+[![npm version](https://badge.fury.io/js/%40macalinao%2Fclients-quarry.svg)](https://www.npmjs.com/package/%40macalinao%2Fclients-quarry)
+
 - Program ID: `QMWoBmAyJLAsA1Lh9ugMTw2gciTihncciphzdNzdZYV`
+- TypeScript Client: [`@macalinao/clients-quarry`](https://www.npmjs.com/package/@macalinao/clients-quarry)
 
 ## Table of Contents
 
diff --git a/clients/quarry/docs/quarry-operator.md b/clients/quarry/docs/quarry-operator.md
@@ -1,6 +1,9 @@
 # Quarry Operator Program
 
+[![npm version](https://badge.fury.io/js/%40macalinao%2Fclients-quarry.svg)](https://www.npmjs.com/package/%40macalinao%2Fclients-quarry)
+
 - Program ID: `QoP6NfrQbaGnccXQrMLUkog2tQZ4C1RFgJcwDnT8Kmz`
+- TypeScript Client: [`@macalinao/clients-quarry`](https://www.npmjs.com/package/@macalinao/clients-quarry)
 
 ## Table of Contents
 
diff --git a/clients/quarry/docs/quarry-redeemer.md b/clients/quarry/docs/quarry-redeemer.md
@@ -1,6 +1,9 @@
 # Quarry Redeemer Program
 
+[![npm version](https://badge.fury.io/js/%40macalinao%2Fclients-quarry.svg)](https://www.npmjs.com/package/%40macalinao%2Fclients-quarry)
+
 - Program ID: `QRDxhMw1P2NEfiw5mYXG79bwfgHTdasY2xNP76XSea9`
+- TypeScript Client: [`@macalinao/clients-quarry`](https://www.npmjs.com/package/@macalinao/clients-quarry)
 
 ## Table of Contents
 
diff --git a/clients/quarry/docs/quarry-registry.md b/clients/quarry/docs/quarry-registry.md
@@ -1,6 +1,9 @@
 # Quarry Registry Program
 
+[![npm version](https://badge.fury.io/js/%40macalinao%2Fclients-quarry.svg)](https://www.npmjs.com/package/%40macalinao%2Fclients-quarry)
+
 - Program ID: `QREGBnEj9Sa5uR91AV8u3FxThgP5ZCvdZUW2bHAkfNc`
+- TypeScript Client: [`@macalinao/clients-quarry`](https://www.npmjs.com/package/@macalinao/clients-quarry)
 
 ## Table of Contents
 
diff --git a/clients/token-metadata/coda.config.mjs b/clients/token-metadata/coda.config.mjs
@@ -29,5 +29,8 @@ const addCustomPDAsVisitor = addPdasVisitor({
 
 export default defineConfig({
   outputDir: "./src/generated",
+  docs: {
+    npmPackageName: "@macalinao/clients-token-metadata",
+  },
   visitors: [addCustomPDAsVisitor],
 });
diff --git a/clients/token-metadata/docs/token-metadata.md b/clients/token-metadata/docs/token-metadata.md
@@ -1,6 +1,9 @@
 # Token Metadata Program
 
+[![npm version](https://badge.fury.io/js/%40macalinao%2Fclients-token-metadata.svg)](https://www.npmjs.com/package/%40macalinao%2Fclients-token-metadata)
+
 - Program ID: `metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s`
+- TypeScript Client: [`@macalinao/clients-token-metadata`](https://www.npmjs.com/package/@macalinao/clients-token-metadata)
 
 ## Table of Contents
 
diff --git a/packages/coda/src/bin/cli.ts b/packages/coda/src/bin/cli.ts
@@ -83,6 +83,13 @@ export default {
   // Optional: Output directory for generated client (overrides --output option)
   // outputDir: "./src/generated",
   
+  // Optional: Documentation generation options
+  // docs: {
+  //   // NPM package name for the TypeScript client
+  //   // If provided, will add an NPM badge and link to the package
+  //   npmPackageName: "@my-org/my-solana-client",
+  // },
+  
   // Optional: Add custom visitors to transform the Codama tree
   // Can be an array of visitors or a function that returns visitors
   // visitors: [
@@ -130,9 +137,12 @@ program
       const { codama, config } = await processIdls(options);
       const outputPath = resolve(config.docsPath ?? "./docs");
 
-      // Apply the markdown visitor
+      // Apply the markdown visitor with options from config
       console.log(`Generating documentation to ${outputPath}...`);
-      codama.accept(renderMarkdownVisitor(outputPath));
+      const markdownOptions = {
+        npmPackageName: config.docs?.npmPackageName,
+      };
+      codama.accept(renderMarkdownVisitor(outputPath, markdownOptions));
 
       console.log("✅ Documentation generated successfully!");
     } catch (error) {
diff --git a/packages/coda/src/config.ts b/packages/coda/src/config.ts
@@ -40,6 +40,18 @@ export interface CodaConfig {
    */
   docsPath?: string;
 
+  /**
+   * Documentation generation options.
+   */
+  docs?: {
+    /**
+     * NPM package name for the TypeScript client.
+     * If provided, will add an NPM badge and link to the package in the generated documentation.
+     * @example "@my-org/my-solana-client"
+     */
+    npmPackageName?: string;
+  };
+
   /**
    * Additional root node visitors to apply to the Codama nodes before generating code.
    * These visitors are applied in order after the initial Anchor IDL parsing.
diff --git a/packages/codama-renderers-markdown/src/renderers/renderProgram.test.ts b/packages/codama-renderers-markdown/src/renderers/renderProgram.test.ts
@@ -122,4 +122,54 @@ describe("renderProgram", () => {
     const markdown = renderProgram(program, contextNoToc);
     expect(markdown).not.toContain("## Table of Contents");
   });
+
+  test("renders NPM package badge and link when provided", async () => {
+    const program = programNode({
+      name: "myProgram",
+      publicKey: "11111111111111111111111111111111",
+      accounts: [],
+    });
+
+    const contextWithNpm: RenderContext = {
+      linkables: new LinkableDictionary(),
+      options: {
+        formatWithPrettier: true,
+        npmPackageName: "@my-org/my-solana-client",
+      },
+    };
+
+    const markdown = renderProgram(program, contextWithNpm);
+    const formatted = await prettier.format(markdown, { parser: "markdown" });
+
+    // Check for NPM badge
+    expect(formatted).toContain(
+      "[![npm version](https://badge.fury.io/js/%40my-org%2Fmy-solana-client.svg)](https://www.npmjs.com/package/%40my-org%2Fmy-solana-client)",
+    );
+
+    // Check for TypeScript client link
+    expect(formatted).toContain(
+      "- TypeScript Client: [`@my-org/my-solana-client`](https://www.npmjs.com/package/@my-org/my-solana-client)",
+    );
+  });
+
+  test("does not render NPM badge when not provided", () => {
+    const program = programNode({
+      name: "myProgram",
+      publicKey: "11111111111111111111111111111111",
+      accounts: [],
+    });
+
+    const contextWithoutNpm: RenderContext = {
+      linkables: new LinkableDictionary(),
+      options: {
+        formatWithPrettier: false,
+      },
+    };
+
+    const markdown = renderProgram(program, contextWithoutNpm);
+
+    // Should not contain NPM badge or client link
+    expect(markdown).not.toContain("npm version");
+    expect(markdown).not.toContain("TypeScript Client:");
+  });
 });
diff --git a/packages/codama-renderers-markdown/src/renderers/renderProgram.ts b/packages/codama-renderers-markdown/src/renderers/renderProgram.ts
@@ -27,6 +27,16 @@ export function renderProgram(
   lines.push(`# ${titleCase} Program`);
   lines.push("");
 
+  // NPM Package Badge (if provided)
+  if (context.options.npmPackageName) {
+    const packageName = context.options.npmPackageName;
+    const encodedPackageName = encodeURIComponent(packageName);
+    lines.push(
+      `[![npm version](https://badge.fury.io/js/${encodedPackageName}.svg)](https://www.npmjs.com/package/${encodedPackageName})`,
+    );
+    lines.push("");
+  }
+
   // Description
   if (program.docs?.length) {
     lines.push("## Description");
@@ -44,6 +54,14 @@ export function renderProgram(
     lines.push(`- Program ID: \`${address}\``);
   }
 
+  // TypeScript Client Link (if NPM package provided)
+  if (context.options.npmPackageName) {
+    const packageName = context.options.npmPackageName;
+    lines.push(
+      `- TypeScript Client: [\`${packageName}\`](https://www.npmjs.com/package/${packageName})`,
+    );
+  }
+
   // Table of Contents
   if (context.options.renderTableOfContents !== false) {
     lines.push("## Table of Contents");
diff --git a/packages/codama-renderers-markdown/src/types.ts b/packages/codama-renderers-markdown/src/types.ts
@@ -13,6 +13,9 @@ export interface RenderMarkdownOptions {
   /** Whether to hide discriminators from the documentation (default: true) */
   hideDiscriminators?: boolean;
 
+  /** NPM package name for the TypeScript client */
+  npmPackageName?: string;
+
   /** Prettier configuration options */
   prettierOptions?: {
     printWidth?: number;
