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

feat(components): add tooltip to main full editor file #1219

Merged
merged 5 commits into from
Feb 4, 2025

Conversation

Poafs1
Copy link
Collaborator

@Poafs1 Poafs1 commented Feb 4, 2025

Summary by CodeRabbit

  • New Features
    • Introduced interactive tooltips in the editor sidebar to provide clear context for main files and library contracts.
    • Enhanced file navigation by integrating external library data into the display, making it easier to identify and access key files.

Copy link

vercel bot commented Feb 4, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
celatone-frontend-staging ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 4, 2025 7:57am
6 Skipped Deployments
Name Status Preview Comments Updated (UTC)
celatone-frontend-main ⬜️ Ignored (Inspect) Visit Preview Feb 4, 2025 7:57am
initia-celatone-frontend ⬜️ Ignored (Inspect) Visit Preview Feb 4, 2025 7:57am
neutron-celatone-frontend ⬜️ Ignored (Inspect) Visit Preview Feb 4, 2025 7:57am
osmosis-celatone-frontend ⬜️ Ignored (Inspect) Visit Preview Feb 4, 2025 7:57am
sei-celatone-frontend ⬜️ Ignored (Inspect) Visit Preview Feb 4, 2025 7:57am
terra-celatone-frontend ⬜️ Ignored (Inspect) Visit Preview Feb 4, 2025 7:57am

Copy link

coderabbitai bot commented Feb 4, 2025

Warning

Rate limit exceeded

@Poafs1 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 37 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 87e555c and 7052897.

📒 Files selected for processing (3)
  • src/lib/components/editor/FullEditor.tsx (1 hunks)
  • src/lib/components/editor/helpers.ts (3 hunks)
  • src/lib/pages/evm-contract-details/components/evm-contract-details-contract-info/ContractCode.tsx (1 hunks)

Walkthrough

A new tooltip feature has been added to the full editor sidebar. The changelog now documents the addition of this tooltip, and several components have been updated. In the UI, tooltips now envelop specific icons for main verified contract files and library contracts. The FullEditor component and its associated helper functions have been modified to accept a new libraries property, and the source tree nodes include an isLib flag. Additionally, the ContractCode component has been updated to pass the libraries prop to FullEditor.

Changes

File(s) Change Summary
CHANGELOG.md Added a new tooltip feature entry under "Features" in the "Unreleased" section (#1219).
src/lib/components/editor/EditorFileBody.tsx Imported Tooltip and modified rendering logic to wrap icons in tooltips with labels for main verified and library contracts; added a conditional Flex wrapper.
src/lib/components/editor/FullEditor.tsx, src/lib/components/editor/helpers.ts, src/lib/components/editor/types.ts Added a new libraries: string[] property to FullEditorProps; updated generateSourceTree to include the libraries parameter; extended SourceTreeNode with an isLib boolean property.
src/lib/pages/evm-contract-details/.../ContractCode.tsx Updated the FullEditor component invocation to include a libraries prop derived from library contract paths.

Sequence Diagram(s)

sequenceDiagram
    participant FE as FullEditor
    participant GS as generateSourceTree
    participant EF as EditorFileBody
    participant T as Tooltip

    FE->>GS: Call generateSourceTree(filesPath, initialFilePath, libraries)
    GS-->>FE: Return source tree nodes with isLib flag
    FE->>EF: Render file nodes
    EF->>EF: Evaluate node properties (isFolder, isLib)
    alt Node requires tooltip
        EF->>T: Wrap CustomIcon in Tooltip with label ("Main verified contract file" or "Library contract")
    else
        EF->>EF: Render CustomIcon without Tooltip
    end
Loading

Possibly related PRs

Suggested reviewers

  • evilpeach
  • songwongtp

Poem

I'm a rabbit with ears so keen,
Celebrating changes crisp and clean.
Tooltips now guide with a gentle nudge,
Libraries join the coding judge.
Hop along as our code takes flight,
In a world of bytes so merry and bright!
🐇🌟


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

@evilpeach evilpeach merged commit 4b63edf into develop Feb 4, 2025
13 checks passed
@evilpeach evilpeach deleted the feature/tooltip-code-sidebar branch February 4, 2025 07:59
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