docs icon indicating copy to clipboard operation
docs copied to clipboard

fix: fix regex to support both quote types in `href`

Open 0xkg opened this issue 10 months ago • 2 comments

Description:
In the getBreadcrumbCards function, the regular expression used to match href attributes only accounted for double quotes (") around the URL. This update modifies the regex to handle both double (") and single quotes ('), ensuring more robust matching.

Tests:
This change does not require new tests but ensures compatibility with URLs using either quote type (", ') in href attributes.

Additional context:
This fix improves the robustness of breadcrumb card parsing when handling different quote types in HTML attributes.

0xkg avatar Mar 12 '25 17:03 0xkg

Deploy Preview for docs-optimism ready!

Built without sensitive environment variables

Name Link
Latest commit eb813e2b9350fc94d54005cb13fb2f1da198ea36
Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/67d1c603cead6d000888ea42
Deploy Preview https://deploy-preview-1497--docs-optimism.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Mar 12 '25 17:03 netlify[bot]

📝 Walkthrough

Walkthrough

The update adjusts the regular expression in the getBreadcrumbCards function located in utils/breadcrumbs.ts. The regex originally matched href attributes with double quotes only (i.e., href="([^"]+)"). It has now been modified to match both single and double quotes (i.e., href=['"]([^'"]+)['"]). This change allows the function to correctly capture URLs from <Card> elements regardless of the quote style used in the HTML content. The rest of the function's logic, including the handling of matches and the return structure (a Set of URLs), remains unchanged. Additionally, no changes were made to the exported or public entity declarations.

Suggested reviewers

  • sbvegan

📜 Recent review details

Configuration used: .coderabbit.yaml Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3d1f46e9028e627c2e698116848e6a75f8466290 and eb813e2b9350fc94d54005cb13fb2f1da198ea36.

📒 Files selected for processing (1)
  • utils/breadcrumbs.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - docs-optimism
  • GitHub Check: Header rules - docs-optimism
  • GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (1)
utils/breadcrumbs.ts (1)

84-84: Good improvement to support both quote types!

The regex has been updated to correctly match <Card> elements with href attributes that use either single quotes (') or double quotes ("), which makes the parser more robust.

✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

coderabbitai[bot] avatar Mar 12 '25 17:03 coderabbitai[bot]

We migrated docs platforms so this PR is no longer valid. Thank you for taking the time to open it!

sbvegan avatar Oct 28 '25 07:10 sbvegan