fix(bindgen): use world namespace for imported models in TypeScript S…

[MartianGreed]

…chemaType

Related issue

#3218

Summary by CodeRabbit

• New Features
  • Added support for overriding the namespace in generated TypeScript schema types and constants using a special marker comment.
• Tests
  • Introduced tests to verify that the namespace override works when the marker is present in the buffer.
• Documentation
  • Cleaned up formatting in example code comments for improved readability.

[coderabbitai]

Walkthrough

Ohayo sensei! This update introduces a mechanism for overriding the namespace used in TypeScript schema generation by inserting a special comment marker containing the world name into the code generation buffer. The generator now scans for this marker and uses its value as the namespace if present, otherwise defaulting to the original namespace.

Changes

File(s)	Change Summary
crates/dojo/bindgen/src/plugins/typescript/generator/schema.rs	Added method to extract a world name from buffer marker for namespace override; updated schema type and const handling; added tests.
crates/dojo/bindgen/src/plugins/typescript/writer.rs	Prepends and removes a special world name marker line in buffer during TypeScript code generation.
crates/macros/merge-options/src/lib.rs	Removed trailing whitespace line in doc comment example; no logic changes.

Sequence Diagram(s)

sequenceDiagram
    participant Writer
    participant Buffer
    participant SchemaGenerator

    Writer->>Buffer: Insert "// WORLD_NAME:<world_name>" marker
    Writer->>SchemaGenerator: Generate schema types/constants
    SchemaGenerator->>Buffer: Scan for "// WORLD_NAME:" marker
    alt Marker found
        SchemaGenerator->>SchemaGenerator: Use marker value as namespace
    else Marker not found
        SchemaGenerator->>SchemaGenerator: Use original namespace
    end
    Writer->>Buffer: Remove "// WORLD_NAME:" marker
    Writer->>Writer: Output final TypeScript code

Loading

Suggested reviewers

• glihm

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27b97a1 and 2b0d139.

📒 Files selected for processing (3)

• crates/dojo/bindgen/src/plugins/typescript/generator/schema.rs (4 hunks)
• crates/dojo/bindgen/src/plugins/typescript/writer.rs (1 hunks)
• crates/macros/merge-options/src/lib.rs (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• crates/macros/merge-options/src/lib.rs

🚧 Files skipped from review as they are similar to previous changes (2)

• crates/dojo/bindgen/src/plugins/typescript/writer.rs
• crates/dojo/bindgen/src/plugins/typescript/generator/schema.rs

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: fmt

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

crates/dojo/bindgen/src/plugins/typescript/writer.rs (1)

75-78: Ohayo sensei! Add a trailing newline to the marker for cleaner diff & predictable joins.

initial_buffer.push(format!("// WORLD_NAME:{}", data.world.name));
Without a terminating \n, the marker and the first line subsequently inserted at index 0 may be concatenated when someone forgets to add their own newline, producing hard-to-spot formatting glitches.
A one-char tweak keeps every buffer entry visually isolated.

-        initial_buffer.push(format!("// WORLD_NAME:{}", data.world.name));
+        initial_buffer.push(format!("// WORLD_NAME:{}\n", data.world.name));

crates/dojo/bindgen/src/plugins/typescript/generator/schema.rs (1)

105-113: Ohayo sensei! Cache the world name once instead of scanning the buffer per model.

get_world_name_from_buffer linearly scans the buffer for every single token.
In large projects this quickly becomes O(models × buffer_len).
Consider extracting the world name once (e.g., on the first call, or pass it from the writer via a dedicated field) and store it inside the generator to make subsequent look-ups O(1).

Not blocking but worth a follow-up for performance.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 03aa6c4 and 27b97a1.

📒 Files selected for processing (2)

• crates/dojo/bindgen/src/plugins/typescript/generator/schema.rs (4 hunks)
• crates/dojo/bindgen/src/plugins/typescript/writer.rs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: fmt

[coderabbitai]

🛠️ Refactor suggestion

Ohayo sensei! Avoid cloning the composite vectors on every generator pass.

[m_composites.clone(), e_composites.clone()].concat() allocates twice per generator and can balloon for large worlds.
Iterate by chaining references instead—zero extra allocations, same behaviour.

-        let mut code_buffer = self.generators.iter().fold(initial_buffer, |mut acc, g| {
-            [m_composites.clone(), e_composites.clone()].concat().iter().for_each(|c| {
+        let mut code_buffer = self.generators.iter().fold(initial_buffer, |mut acc, g| {
+            m_composites.iter().chain(e_composites.iter()).for_each(|c| {

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	[m_composites.clone(), e_composites.clone()].concat().iter().for_each(|c| {
	match g.generate(c, &mut acc) {
	Ok(code) => {
	if !code.is_empty() {
	acc.push(code)
	}
	};
	});
	acc
	})
	.join("\n");
	}
	Err(_e) => {
	log::error!("Failed to generate code for model {}", c.type_path);
	}
	};
	});
	acc
	let mut code_buffer = self.generators.iter().fold(initial_buffer, |mut acc, g| {
	m_composites.iter().chain(e_composites.iter()).for_each(|c| {
	match g.generate(c, &mut acc) {
	Ok(code) => {
	if !code.is_empty() {
	acc.push(code)
	}
	}
	Err(_e) => {
	log::error!("Failed to generate code for model {}", c.type_path);
	}
	};
	});
	acc
	});

🤖 Prompt for AI Agents

In crates/dojo/bindgen/src/plugins/typescript/writer.rs around lines 80 to 92,
avoid cloning the m_composites and e_composites vectors before concatenation as
it causes unnecessary allocations. Instead, iterate by chaining references to
these vectors using an iterator chain, which eliminates extra allocations while
preserving the same iteration behavior. Replace the current cloning and
concatenation with a chained iterator over references to the composites.