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.

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

Use snake case when locating wasm files - makes cargo odra so much #311

Closed
wants to merge 1 commit into from

Conversation

kubaplas
Copy link
Contributor

@kubaplas kubaplas commented Jan 9, 2024

easier

Summary by CodeRabbit

  • Refactor
    • Improved naming convention consistency by automatically converting input names to snake_case.

@kubaplas kubaplas requested a review from kpob January 9, 2024 14:44
Copy link
Contributor

coderabbitai bot commented Jan 9, 2024

Walkthrough

The recent update incorporates the convert_case crate into the project, enabling the conversion of input strings to snake_case. This functionality is specifically applied to the name variable, ensuring that the wasm_path is constructed with the standardized snake_case formatting.

Changes

File Path Change Summary
.../src/vm/casper_vm.rs Introduced convert_case crate to convert name to snake_case for wasm_path construction.

🐇✨
In the realm of code, a tiny tweak,
A snake slithers in, no longer unique.
Paths now in sync with a hiss and a case,
A rabbit's cheer for the codebase's grace. 🌟🐍

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

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 37650a3 and d8fa50b.
Files ignored due to filter (3)
  • Cargo.toml
  • odra-casper/test-vm/Cargo.toml
  • odra-macros/Cargo.toml
Files selected for processing (1)
  • odra-casper/test-vm/src/vm/casper_vm.rs (2 hunks)
Additional comments: 2
odra-casper/test-vm/src/vm/casper_vm.rs (2)
  • 1-1: The addition of the convert_case crate is noted and is in line with the PR's objective to standardize the naming convention of wasm files to snake_case.

  • 271-275: The conversion to snake_case using the convert_case crate appears to be implemented correctly. However, it's important to ensure that all wasm file names and references throughout the codebase are updated to reflect this new naming convention to avoid file not found errors.

Verification successful

The verification process has confirmed that the .wasm files and their references in the codebase adhere to the snake_case naming convention as intended by the PR. The changes made in the PR are consistent with the goal of simplifying the cargo odra process by standardizing the naming convention of wasm files.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify that all wasm file names follow the new snake_case naming convention.
fd '.wasm$' --exec bash -c 'if [[ ! "$(basename {})" =~ ^[a-z0-9_]+\.wasm$ ]]; then echo "Non-snake_case wasm file found: {}"; fi'
# Verify that all references to wasm files in the codebase use the new snake_case naming convention.
rg --type rust --glob '*.rs' '[a-zA-Z][a-zA-Z0-9]*\.wasm'

Length of output: 407



Script:

#!/bin/bash
# Search for any references to .wasm files in the codebase to ensure they follow the snake_case naming convention.
rg --type rust --glob '*.rs' '\b[a-zA-Z0-9_/]+\.wasm\b'

Length of output: 187

@kubaplas
Copy link
Contributor Author

kubaplas commented Jan 9, 2024

Not needed, as we are dropping name from contract section of Odra.toml

@kubaplas kubaplas closed this Jan 9, 2024
@kubaplas kubaplas deleted the feature/use-snake_case-wasm-files branch February 16, 2024 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants