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

fix: create dojo contract manifest path #356

Merged
merged 1 commit into from
Dec 13, 2024
Merged

Conversation

MartianGreed
Copy link
Collaborator

@MartianGreed MartianGreed commented Dec 13, 2024

Closes #

Introduced changes

Checklist

  • Linked relevant issue
  • Updated relevant documentation
  • Added relevant tests
  • Add a dedicated CI job for new examples
  • Performed self-review of the code

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling with enhanced warning messages during file updates.
  • Chores

    • Updated path references for the manifest file to reflect a new directory structure.

Copy link

coderabbitai bot commented Dec 13, 2024

Walkthrough

The changes in this pull request focus on modifying the start.ts file within the packages/create-dojo/src/commands directory. The main update involves altering the import statement for the dojoConfig.ts file in the rewriteDojoConfigFile function to reference the manifest_dev.json file directly from the contract directory. Additionally, error handling has been improved with a warning message for issues encountered during the file update process. The overall structure and functionality of the command remain unchanged.

Changes

File Path Change Summary
packages/create-dojo/src/commands/start.ts Updated import statement in rewriteDojoConfigFile to reference manifest_dev.json directly; enhanced error handling with a warning message.

Possibly related PRs

  • fix: create-dojo + update manifest path #338: This PR modifies the start.ts file to introduce a new function rewriteDojoConfigFile, which updates the import paths for the manifest file, directly relating to the changes made in the main PR regarding the path structure for the manifest file.
  • fix: dojoConfig manifest path for onchain-dash #344: This PR also addresses changes to the manifest path, specifically for the dojoConfig, which aligns with the updates made in the main PR regarding the import statement for the manifest_dev.json file.

🐰 In the code we hop and play,
Paths are changed, come what may!
Warnings now will softly chime,
As we code, we dance in rhyme.
With each fix, our joy will grow,
In our burrow, new paths flow! 🌟


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

Copy link

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1db6e14 and a6fb293.

📒 Files selected for processing (1)
  • packages/create-dojo/src/commands/start.ts (1 hunks)
🔇 Additional comments (2)
packages/create-dojo/src/commands/start.ts (2)

124-126: 🛠️ Refactor suggestion

Enhance error handling with specific error messages

The current error handling could be more informative to help users troubleshoot issues.

Consider this improvement:

     } catch (error) {
-        console.warn(`Warning: Could not update dojoConfig.ts: ${error}`);
+        if (error.code === 'ENOENT') {
+            console.error(`Error: dojoConfig.ts not found in ${clientPath}`);
+        } else if (error.code === 'EACCES') {
+            console.error(`Error: Permission denied accessing dojoConfig.ts`);
+        } else {
+            console.error(`Error updating dojoConfig.ts: ${error.message}`);
+        }
+        throw new Error('Failed to configure project. Please check the errors above.');
     }

Likely invalid or redundant comment.


Line range hint 123-127: Verify manifest path existence and improve error handling

The current implementation assumes the manifest path exists and continues silently on errors. This could lead to runtime issues.

Let's verify the manifest path assumptions:

@@ -120,7 +120,7 @@ async function rewriteDojoConfigFile(clientPath: string) {
// Update relative imports to account for new directory structure
content = content.replace(
/from ['"]\.{0,2}\/.*manifest(?:_dev)?\.json['"]/g,
'from "../contract/target/dev/manifest.json"'
'from "../contract/manifest_dev.json"'
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Consider making the manifest path configurable

The hardcoded path "../contract/manifest_dev.json" reduces flexibility. Different projects might have varying directory structures or environment-specific manifest files.

Consider:

  1. Making the path configurable through project settings
  2. Restoring the regex pattern for flexibility
  3. Supporting environment-specific paths
-            'from "../contract/manifest_dev.json"'
+            // Read from project config or fall back to default
+            `from "${config.manifestPath || '../contract/manifest_dev.json'}"`

Committable suggestion skipped: line range outside the PR's diff.

@MartianGreed MartianGreed merged commit 8668587 into main Dec 13, 2024
2 of 3 checks passed
@MartianGreed MartianGreed deleted the fix/create-dojo branch December 13, 2024 10:31
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.

1 participant