Fix blocking on async thread and add formatting in CI

[Dodecahedr0x]

Summary by CodeRabbit

• CI/CD

  • Added a new job run_cargo_checks to perform code formatting and linting checks.
  • Enhanced CI process with rustfmt and cargo clippy validations.

• Documentation

  • Minor grammatical corrections in README.md.

• Code Improvements

  • Converted start_simnet function to asynchronous implementation.
  • Updated error handling in CLI module.
  • Reformatted code for improved readability across multiple files.

• Chores

  • Added import for GlobalState in RPC module.
  • Minor file formatting adjustments.

[coderabbitai]

Walkthrough

The pull request introduces several modifications across multiple files in a Rust project. The primary changes include adding a new GitHub Actions workflow job for Rust code checks, updating the README with minor grammatical corrections, and converting several functions from synchronous to asynchronous implementations. The modifications focus on improving code quality, readability, and workflow automation.

Changes

File	Change Summary
.github/workflows/rust.yml	Added new run_cargo_checks job for code formatting and linting
README.md	Minor grammatical and formatting corrections
crates/cli/src/cli/mod.rs	Code formatting adjustments and simplified error handling
crates/cli/src/cli/simnet/mod.rs	Updated handle_start_simnet_command to use async call
crates/cli/src/main.rs	Added newline at end of file
crates/core/src/lib.rs	Converted start_simnet to async function
crates/core/src/rpc/mod.rs	Reinstated GlobalState import

Sequence Diagram

sequenceDiagram
    participant CLI as CLI
    participant Core as Core Module
    participant Simnet as Simnet
    
    CLI->>Core: start_simnet() [async]
    Core->>Simnet: start()
    Simnet-->>Core: Complete
    Core-->>CLI: Return Result

Loading

Poem

🐰 Async rabbits hop and dance,
Code checks running at a glance,
Formatting tight, no clippy fright,
Our workflow leaps with pure delight!
Rust magic spinning, clean and bright! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f3b6e95 and 50fafbf.

📒 Files selected for processing (2)

• crates/cli/src/cli/simnet/mod.rs (1 hunks)
• crates/core/src/lib.rs (1 hunks)

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

• crates/cli/src/cli/simnet/mod.rs

🔇 Additional comments (1)

crates/core/src/lib.rs (1)

20-22: LGTM! The changes address the previous review comments.

The function has been properly converted to async and now includes error handling. The implementation correctly:

• Uses async/await syntax
• Propagates errors using the ? operator
• Returns a Result type

---

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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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: 2

🧹 Nitpick comments (1)

.github/workflows/rust.yml (1)

24-25: Configure Clippy with specific lints and treat warnings as errors.

Consider configuring Clippy with specific lints and treating warnings as errors to maintain high code quality standards.

Apply this diff to enhance the Clippy configuration:

-      - name: Run Cargo clippy
-        run: cargo clippy --all-targets --all-features
+      - name: Run Cargo clippy
+        run: |
+          cargo clippy --all-targets --all-features -- \
+            -D warnings \
+            -W clippy::all \
+            -W clippy::pedantic \
+            -W clippy::nursery \
+            -W clippy::cargo

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a20c54 and 5d1ae64.

📒 Files selected for processing (7)

• .github/workflows/rust.yml (1 hunks)
• README.md (1 hunks)
• crates/cli/src/cli/mod.rs (3 hunks)
• crates/cli/src/cli/simnet/mod.rs (1 hunks)
• crates/cli/src/main.rs (1 hunks)
• crates/core/src/lib.rs (1 hunks)
• crates/core/src/rpc/mod.rs (1 hunks)

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

• crates/cli/src/main.rs
• README.md
• crates/cli/src/cli/mod.rs
• crates/core/src/rpc/mod.rs

[lgalabru]

Looking sharp, thanks @Dodecahedr0x!