Improve rust modules (#63)

* Add kaigan crate reference

* Add self to module use statements

* Remove blank line

* Reference RemainderVec from kaigan crate

* Add changeset

.changeset/healthy-adults-teach.md

@@ -0,0 +1,5 @@
+---
+'@metaplex-foundation/kinobi': patch
+---
+
+Improve rust modules

src/renderers/rust/GetRustRenderMapVisitor.ts

@@ -91,9 +91,7 @@ export class GetRustRenderMapVisitor extends BaseThrowVisitor<RenderMap> {
       map.add('instructions/mod.rs', this.render('instructionsMod.njk', ctx));
     }
     if (definedTypesToExport.length > 0) {
-      map
-        .add('types/mod.rs', this.render('definedTypesMod.njk', ctx))
-        .add('types/helper/mod.rs', this.render('sharedPage.njk', ctx));
+      map.add('types/mod.rs', this.render('definedTypesMod.njk', ctx));
     }
 
     return map

src/renderers/rust/GetRustTypeManifestVisitor.ts

@@ -126,7 +126,7 @@ export class GetRustTypeManifestVisitor implements Visitor<RustTypeManifest> {
     }
 
     if (arrayType.size.kind === 'remainder') {
-      childManifest.imports.add('crate::types::helper::RemainderVec');
+      childManifest.imports.add('kaigan::types::RemainderVec');
       return {
         ...childManifest,
         type: `RemainderVec<${childManifest.type}>`,

src/renderers/rust/templates/accountsMod.njk

@@ -3,10 +3,11 @@
 {% block main %}
 
 {% for account in accountsToExport | sort(false, false, 'name') %}
-mod {{ account.name | snakeCase }};
+pub mod {{ account.name | snakeCase }};
 {% endfor %}
 
 {% for account in accountsToExport | sort(false, false, 'name') %}
-pub use {{ account.name | snakeCase }}::*;
+pub use self::{{ account.name | snakeCase }}::*;
 {% endfor %}
-{% endblock %}
+
+{% endblock %}

src/renderers/rust/templates/definedTypesMod.njk

@@ -3,10 +3,11 @@
 {% block main %}
 
 {% for definedType in definedTypesToExport | sort(false, false, 'name') %}
-mod {{ definedType.name | snakeCase }};
+pub mod {{ definedType.name | snakeCase }};
 {% endfor %}
 
 {% for definedType in definedTypesToExport | sort(false, false, 'name') %}
-pub use {{ definedType.name | snakeCase }}::*;
+pub use self::{{ definedType.name | snakeCase }}::*;
 {% endfor %}
-{% endblock %}
+
+{% endblock %}

src/renderers/rust/templates/definedTypesPage.njk

@@ -6,9 +6,10 @@
 {{ imports }}
 
 {{ macros.docblock(definedType.docs) }}
-{{ typeManifest.type }}
+{{- typeManifest.type }}
 
 {% for nestedStruct in typeManifest.nestedStructs %}
 {{ nestedStruct }}
 {% endfor %}
+
 {% endblock %}

src/renderers/rust/templates/errorsMod.njk

@@ -3,10 +3,11 @@
 {% block main %}
 
 {% for program in programsToExport | sort(false, false, 'name') %}
-mod {{ program.name | snakeCase }};
+pub mod {{ program.name | snakeCase }};
 {% endfor %}
 
 {% for program in programsToExport | sort(false, false, 'name') %}
-pub use {{ program.name | snakeCase }}::{{ program.name | pascalCase }}Error;
+pub use self::{{ program.name | snakeCase }}::{{ program.name | pascalCase }}Error;
 {% endfor %}
-{% endblock %}
+
+{% endblock %}

src/renderers/rust/templates/errorsPage.njk

@@ -19,4 +19,5 @@ impl solana_program::program_error::PrintProgramError for {{ program.name | pasc
         solana_program::msg!(&self.to_string());
     }
 }
-{% endblock %}
+
+{% endblock %}

src/renderers/rust/templates/instructionsCpiPageBuilder.njk

@@ -89,4 +89,4 @@ struct {{ instruction.name | pascalCase }}CpiBuilderInstruction<'a> {
     {{ arg.name | snakeCase }}: {{ arg.type if arg.innerOptionType else 'Option<' + arg.type + '>' }},
   {% endif %}
 {% endfor %}
-}
+}

src/renderers/rust/templates/instructionsMod.njk

@@ -7,6 +7,7 @@ pub mod {{ instruction.name | snakeCase }};
 {% endfor %}
 
 {% for instruction in instructionsToExport | sort(false, false, 'name') %}
-pub use {{ instruction.name | snakeCase }}::*;
+pub use self::{{ instruction.name | snakeCase }}::*;
 {% endfor %}
-{% endblock %}
+
+{% endblock %}

src/renderers/rust/templates/programsMod.njk

@@ -9,4 +9,5 @@ use solana_program::{pubkey, pubkey::Pubkey};
 /// `{{ program.name | snakeCase }}` program ID.
 pub const {{ program.name | snakeCase | upper }}_ID: Pubkey = pubkey!("{{ program.publicKey }}");
 {% endfor %}
+
 {% endblock %}

src/renderers/rust/templates/rootMod.njk

@@ -21,6 +21,6 @@
 {% endif %}
 
 {% if programsToExport.length > 0 %}
-  pub use programs::*;
+  pub(crate) use programs::*;
 {% endif %}
 {% endblock %}

test/mpl_candy_machine_core.json

@@ -688,6 +688,29 @@
           }
         ]
       }
+    },
+    {
+      "name": "DummyLines",
+      "docs": [
+        "Dummy lines."
+      ],
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "lines",
+            "docs": [
+              "The dummy lines."
+            ],
+            "type": {
+              "vec": {
+                "defined": "ConfigLine"
+              },
+              "size": "remainder"
+            }
+          }
+        ]
+      }
     }
   ],
   "errors": [

test/packages/js/src/generated/types/dummyLines.ts

@@ -0,0 +1,42 @@
+/**
+ * This code was AUTOGENERATED using the kinobi library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun kinobi to update it.
+ *
+ * @see https://github.com/metaplex-foundation/kinobi
+ */
+
+import {
+  Serializer,
+  array,
+  struct,
+} from '@metaplex-foundation/umi/serializers';
+import { ConfigLine, ConfigLineArgs, getConfigLineSerializer } from '.';
+
+/** Dummy lines. */
+export type DummyLines = {
+  /** The dummy lines. */
+  lines: Array<ConfigLine>;
+};
+
+export type DummyLinesArgs = {
+  /** The dummy lines. */
+  lines: Array<ConfigLineArgs>;
+};
+
+/** @deprecated Use `getDummyLinesSerializer()` without any argument instead. */
+export function getDummyLinesSerializer(
+  _context: object
+): Serializer<DummyLinesArgs, DummyLines>;
+export function getDummyLinesSerializer(): Serializer<
+  DummyLinesArgs,
+  DummyLines
+>;
+export function getDummyLinesSerializer(
+  _context: object = {}
+): Serializer<DummyLinesArgs, DummyLines> {
+  return struct<DummyLines>(
+    [['lines', array(getConfigLineSerializer(), { size: 'remainder' })]],
+    { description: 'DummyLines' }
+  ) as Serializer<DummyLinesArgs, DummyLines>;
+}

test/packages/js/src/generated/types/index.ts

@@ -22,6 +22,7 @@ export * from './dataV2';
 export * from './delegateArgs';
 export * from './delegateRole';
 export * from './delegateState';
+export * from './dummyLines';
 export * from './escrowAuthority';
 export * from './extendedPayload';
 export * from './hiddenSettings';