fix: sozo build --typescript now properly orders contracts.gen.ts

[MartianGreed]

Description

Related issue

#2943

Summary by CodeRabbit

• Refactor
  • Improved the ordering of functions in generated contracts, ensuring a more intuitive grouping based on both the contract context and function names. This enhancement leads to clearer and more consistent output for users.

[coderabbitai]

Ohayo sensei! Here’s the detailed summary of the pull request:

Walkthrough

The changes update the TypeScript writer in the Dojo bindgen crate. A new import for the naming module from dojo_world::contracts is introduced. The sorting logic for functions has been enhanced: instead of sorting solely by function names, the code now retrieves contract names using naming::get_name_from_tag and creates composite names (contract and function names concatenated with an underscore) for sorting. The overall control flow remains the same.

Changes

Files	Change Summary
crates/dojo/bindgen/.../typescript/writer.rs	- Added import: use dojo_world::contracts::naming; - Modified the write method in TsFileContractWriter to sort functions by a composite key consisting of the contract name (retrieved via naming::get_name_from_tag) and the function name

Sequence Diagram(s)

sequenceDiagram
  participant Writer as TsFileContractWriter
  participant Naming as naming::get_name_from_tag
  participant Sort as Sorting Logic

  Writer->>Writer: Collect functions list
  loop For each function
      Writer->>Naming: Retrieve contract name using function tag
      Naming-->>Writer: Return contract name
      Writer->>Writer: Form composite name (contract_function)
  end
  Writer->>Sort: Sort functions using composite names
  Sort-->>Writer: Return sorted function list
  Writer->>Writer: Write functions in new order

Loading

Possibly related PRs

• fix: contracts function name clashing #2603: Enhances function naming by integrating contract names similar to the modifications in this PR.
• fix(dojo-bindgen): ensure typescript plugin output deterministic order #2359: Addresses sorting logic improvements to ensure deterministic output in the TypeScript plugin.
• feat: add events in typescript bindgen + sort functions by name #2853: Directly relates to adjusting the sorting mechanism in TsFileContractWriter.

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 60e0a6b and 58d3f5c.

📒 Files selected for processing (1)

• crates/dojo/bindgen/src/plugins/typescript/writer.rs (2 hunks)

🔇 Additional comments (2)

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

4-4: Ohayo! New dependency added appropriately.

The import for dojo_world::contracts::naming module has been correctly added at the top of the file, which is now used in the sorting logic below.

---

153-160: Excellent improvement to sorting logic, sensei!

The new sorting approach is much more deterministic and logical. By constructing composite names from both contract and function names, we ensure that functions are first grouped by their contract and then ordered alphabetically within each contract group. This addresses the issue mentioned in the PR title where contract functions weren't being properly ordered in the generated TypeScript file.

The implementation correctly:

1. Extracts contract names using naming::get_name_from_tag
2. Creates composite keys with contract_name_function_name format
3. Performs the comparison using these composite keys

This change will make the generated TypeScript code more organized and predictable.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 9 lines in your changes missing coverage. Please review.

Project coverage is 57.39%. Comparing base (9b93308) to head (58d3f5c).
Report is 8 commits behind head on main.

Files with missing lines	Patch %	Lines
...ates/dojo/bindgen/src/plugins/typescript/writer.rs	0.00%	9 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3074      +/-   ##
==========================================
- Coverage   57.49%   57.39%   -0.11%     
==========================================
  Files         439      440       +1     
  Lines       59820    59971     +151     
==========================================
+ Hits        34392    34418      +26     
- Misses      25428    25553     +125     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.