feat: remove fieldOrder in ts bindgen

[MartianGreed]

Summary by CodeRabbit

• Refactor
  • Simplified the generation of TypeScript type declarations by eliminating redundant type wrappers and properties, resulting in clearer and more consistent schema outputs.

[coderabbitai]

Ohayo sensei!

Below is the summary of the pull request changes:

Walkthrough

This PR removes the WITH_FIELD_ORDER_TYPE_DEF constant definition and its associated usage in the TypeScript generator. The changes include deleting the constant in constants.rs, removing the add_input_type method from the TsInterfaceGenerator in interface.rs, and updating both the type initialization in mod.rs and the schema generation in schema.rs to omit the fieldOrder property and WithFieldOrder wrapper.

Changes

File(s)	Change Summary
.../constants.rs, .../interface.rs	Removed the WITH_FIELD_ORDER_TYPE_DEF constant and its import, along with the corresponding add_input_type method from TsInterfaceGenerator.
.../mod.rs, .../schema.rs	Modified type generation by eliminating the fieldOrder property and the WithFieldOrder wrapper from the generated output.

Sequence Diagram(s)

sequenceDiagram
    participant BM as BindgenModelGenerator
    participant TI as TsInterfaceGenerator
    participant Buf as Buffer

    BM->>TI: generate()
    Note right of TI: Field order handling removed
    TI->>Buf: Write TS types (without add_input_type)

Loading

sequenceDiagram
    participant SG as SchemaGenerator
    participant Buf as Buffer

    SG->>Buf: Generate TS schema
    Note right of SG: WithFieldOrder wrapper omitted

Loading

Possibly related PRs

• feat: Improve bindgen types #2773: Involved similar removals of WITH_FIELD_ORDER_TYPE_DEF constant and related functionality in the TS generator.
• Feat/bindgen improve types #2816: Introduced a new constant for handling TS type definitions without the fieldOrder property, directly related to these changes.
• Fix/bindgen types improvements #2832: Updated the add_input_type method in a similar context to align with the removal of the constant.

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 c60392a and 58d2e02.

📒 Files selected for processing (4)

• crates/dojo/bindgen/src/plugins/typescript/generator/constants.rs (0 hunks)
• crates/dojo/bindgen/src/plugins/typescript/generator/interface.rs (1 hunks)
• crates/dojo/bindgen/src/plugins/typescript/generator/mod.rs (1 hunks)
• crates/dojo/bindgen/src/plugins/typescript/generator/schema.rs (7 hunks)

💤 Files with no reviewable changes (1)

• crates/dojo/bindgen/src/plugins/typescript/generator/constants.rs

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

• GitHub Check: fmt

🔇 Additional comments (4)

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

3-3: Ohayo! Import cleanup looks good, sensei!

The removal of the WITH_FIELD_ORDER_TYPE_DEF import aligns with the PR objective.

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

29-30: Ohayo! Schema type changes look good, sensei!

The removal of the WithFieldOrder wrapper from the schema type definition aligns with the PR objective.

---

66-69: Ohayo! Schema const changes look clean, sensei!

The simplification of the schema const generation by removing field order handling is well-implemented.

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

36-37: Ohayo! Type initialization looks perfect, sensei!

The simplification of the type initialization format by removing field order handling is clean and consistent with the PR objective.

---

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. (Beta)
• @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

All modified and coverable lines are covered by tests ✅

Project coverage is 56.22%. Comparing base (c60392a) to head (58d2e02).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3024      +/-   ##
==========================================
- Coverage   56.23%   56.22%   -0.02%     
==========================================
  Files         436      436              
  Lines       58829    58809      -20     
==========================================
- Hits        33083    33065      -18     
+ Misses      25746    25744       -2     

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