add gill support to the cli init command

.changeset/busy-pots-cough.md

@@ -0,0 +1,5 @@
+---
+'@codama/cli': minor
+---
+
+add the `--gill` flag to the CLI allowing easy generation of gill based config files

README.md

@@ -62,7 +62,6 @@ Now that you have the perfect Codama IDL for your Solana program, you can benefi
 _Note that some features such as rendering CLIs are not yet available. However, because the Codama IDL is designed as a tree of nodes, these features are only a visitor away from being ready. Feel free to reach out if you’d like to contribute to this Codama ecosystem._
 
 - **Rendering client code**. Want people to start interacting with your Solana program? You can use special visitors that go through your Codama IDL and generate client code that you can then publish for your end-users. Currently, we have the following renderers available:
-
     - `@codama/renderers-js`: Renders a JavaScript client compatible with [`@solana/kit`](https://github.com/anza-xyz/kit).
     - `@codama/renderers-js-umi`: Renders a JavaScript client compatible with Metaplex’s [Umi](https://github.com/metaplex-foundation/umi) framework.
     - `@codama/renderers-rust`: Renders a Rust client that removes the need for publishing the program crate and offers a better developer experience.

packages/cli/README.md

@@ -20,6 +20,12 @@ pnpm codama init
 
 You will be prompted for the path of your IDL and asked to select any script presets you would like to use.
 
+To initialize a [gill based Codama](https://gill.site/docs/guides/codama) configuration file, run the `init` command with the `--gill` flag like so:
+
+```sh
+pnpm codama init --gill
+```
+
 ## `codama run`
 
 Once you have your codama config file, you can run your Codama scripts using the `codama run` command as follows:

packages/cli/src/commands/init.ts

@@ -10,33 +10,40 @@ export function setInitCommand(program: Command): void {
         .argument('[output]', 'Optional path used to output the configuration file')
         .option('-d, --default', 'Bypass prompts and select all defaults options')
         .option('--js', 'Forces the output to be a JavaScript file')
+        .option('--gill', 'Forces the output to be a gill based JavaScript file')
         .action(doInit);
 }
 
 type InitOptions = {
     default?: boolean;
     js?: boolean;
+    gill?: boolean;
 };
 
+type ConfigFileType = 'gill' | 'js' | 'json';
+
 async function doInit(explicitOutput: string | undefined, options: InitOptions) {
     const output = getOutputPath(explicitOutput, options);
-    const useJsFile = options.js || output.endsWith('.js');
+    let configFileType: ConfigFileType = output.endsWith('.js') ? 'js' : 'json';
+    if (options.gill) configFileType = 'gill';
+    else if (options.js) configFileType = 'js';
+
     if (await canRead(output)) {
         throw new Error(`Configuration file already exists at "${output}".`);
     }
 
     logBanner();
     const result = await getPromptResult(options);
-    const content = getContentFromPromptResult(result, useJsFile);
+    const content = getContentFromPromptResult(result, configFileType);
     await writeFile(output, content);
     logSuccess(`Configuration file created at "${output}".`);
 }
 
-function getOutputPath(explicitOutput: string | undefined, options: Pick<InitOptions, 'js'>): string {
+function getOutputPath(explicitOutput: string | undefined, options: Pick<InitOptions, 'gill' | 'js'>): string {
     if (explicitOutput) {
         return resolveRelativePath(explicitOutput);
     }
-    return resolveRelativePath(options.js ? 'codama.js' : 'codama.json');
+    return resolveRelativePath(options.js || options.gill ? 'codama.js' : 'codama.json');
 }
 
 type PromptResult = {
@@ -114,7 +121,7 @@ function getDefaultPromptResult(): PromptResult {
     };
 }
 
-function getContentFromPromptResult(result: PromptResult, useJsFile: boolean): string {
+function getContentFromPromptResult(result: PromptResult, configFileType: ConfigFileType): string {
     const scripts: Record<ScriptName, ScriptConfig> = {};
     if (result.scripts.includes('js')) {
         scripts.js = {
@@ -130,8 +137,16 @@ function getContentFromPromptResult(result: PromptResult, useJsFile: boolean): s
     }
     const content: Config = { idl: result.idlPath, before: [], scripts };
 
-    if (!useJsFile) {
+    if (configFileType == 'json') {
         return JSON.stringify(content, null, 4);
+    } else if (configFileType == 'gill') {
+        return `import { createCodamaConfig } from "gill";\n\n` +
+            `export default createCodamaConfig({ \n\t` +
+            `idl: "${result.idlPath}", \n\t` +
+            `clientJs: "${result.jsPath}", \n` +
+            result.scripts.includes('rust')
+            ? `clientRust: "${result.rustPath}", \n`
+            : `` + `});`;
     }
 
     return (