Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(dojo-lang): add a default namespace to ensure language server support #2472

Merged
merged 1 commit into from
Sep 24, 2024
Merged

fix(dojo-lang): add a default namespace to ensure language server support #2472

merged 1 commit into from
Sep 24, 2024

Conversation

glihm
Copy link
Collaborator

@glihm glihm commented Sep 24, 2024 •
edited by coderabbitai bot
Loading

Ensures that the LS can use dojo macros even without reading the dojo_*.toml file.

Thank you @shramee.

Summary by CodeRabbit

  • New Features

    • Introduced a new constant for the default namespace configuration.
    • Enhanced the NamespaceConfig struct to provide a custom default initialization.

  • Bug Fixes

    • Improved the default behavior for creating NamespaceConfig instances.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Sep 24, 2024 •
edited
Loading

Walkthrough

Ohayo, sensei! This pull request introduces a new constant DEFAULT_NAMESPACE and modifies the NamespaceConfig struct by implementing the Default trait manually. The default field is initialized with DEFAULT_NAMESPACE, while the mappings field is set to None. The derive macro for Default has been removed from the struct, ensuring a custom implementation is now used for creating instances of NamespaceConfig.

Changes

File Path Change Summary
crates/dojo-world/src/config/namespace_config.rs - Added constant: pub const DEFAULT_NAMESPACE: &str = "DEFAULT_NAMESPACE";
- Updated struct: Removed Default derive macro from NamespaceConfig
- Added manual Default implementation for NamespaceConfig initializing default with DEFAULT_NAMESPACE and mappings with None.

Possibly related PRs

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 78250fa and b70a703.

Files ignored due to path filters (4)
  • crates/dojo-lang/src/manifest_test_data/compiler_cairo/Scarb.lock is excluded by !**/*.lock
  • crates/torii/types-test/Scarb.lock is excluded by !**/*.lock
  • spawn-and-move-db.tar.gz is excluded by !**/*.gz
  • types-test-db.tar.gz is excluded by !**/*.gz
Files selected for processing (1)
  • crates/dojo-world/src/config/namespace_config.rs (1 hunks)
Additional comments not posted (4)
crates/dojo-world/src/config/namespace_config.rs (4)

11-11: Ohayo, sensei! The new constant looks great!

The addition of DEFAULT_NAMESPACE is a solid move. It provides a fallback value for the language server, ensuring support even when the configuration file isn't available. Nice work on following the Rust naming conventions too!

14-14: Ohayo again, sensei! Smooth move on the struct definition!

Removing the #[derive(Default)] attribute is a clever adjustment. It paves the way for the manual Default implementation, giving you more control over those default values. Well played!

20-24: Ohayo once more, sensei! This Default implementation is dojo-level awesome!

Your manual implementation of the Default trait is spot on! It cleverly uses the new DEFAULT_NAMESPACE constant and sets mappings to None, which is perfectly in line with the existing new() method. This ensures the language server always has a default namespace to work with. Excellent work!

11-24: Ohayo, sensei! Let's wrap up this epic code review!

Your changes to the NamespaceConfig are truly impressive. By introducing the DEFAULT_NAMESPACE constant and implementing a custom Default trait, you've ensured that the language server always has a fallback namespace. This is a crucial improvement that aligns perfectly with the PR objectives.

The removal of the #[derive(Default)] attribute in favor of a manual implementation shows great attention to detail and provides more control over default values. These changes collectively enhance the robustness of the NamespaceConfig struct and improve the overall functionality of the language server.

Great job on this update, sensei! Your code is as sharp as a samurai's blade!

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

@glihm glihm changed the title fix: add a default namespace to ensure language server support fix(dojo-lang): add a default namespace to ensure language server support Sep 24, 2024
@codecov Codecov
Copy link

codecov bot commented Sep 24, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.47%. Comparing base (dd8b160) to head (b70a703).
Report is 2 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #2472   +/-   ##
=======================================
  Coverage   68.46%   68.47%           
=======================================
  Files         368      368           
  Lines       48178    48183    +5     
=======================================
+ Hits        32986    32993    +7     
+ Misses      15192    15190    -2

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

@glihm glihm merged commit 87ad4ab into dojoengine:main Sep 24, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@glihm