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: allow links in markdown hovers #263

Merged
merged 1 commit into from
Jan 23, 2025

Conversation

Hellebore
Copy link
Contributor

@Hellebore Hellebore commented Jan 23, 2025

Checklist

  • If package.json or yarn.lock have changed, then test the VSIX built by yarn run vsce package works from a direct install

Summary by Sourcery

New Features:

  • Allow links in Markdown hovers.

Copy link
Contributor

sourcery-ai bot commented Jan 23, 2025

Reviewer's Guide by Sourcery

This pull request enables the use of links in markdown hovers by setting the isTrusted property to true in the markdown client options.

Class diagram showing updated LanguageClientOptions configuration

classDiagram
    class LanguageClientOptions {
        +markdown: MarkdownOptions
        +diagnosticCollectionName: string
        +documentSelector: DocumentSelector[]
    }
    class MarkdownOptions {
        +isTrusted: boolean
    }
    LanguageClientOptions *-- MarkdownOptions
    note for LanguageClientOptions "Updated to include markdown options"
    note for MarkdownOptions "New configuration to enable trusted links"
Loading

File-Level Changes

Change Details Files
Enable links in markdown hovers.
  • Set isTrusted to true in the markdown client options.
src/extension.ts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot previously requested changes Jan 23, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Hellebore - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • [FILTERED by comment_validation]
    Setting markdown.isTrusted to true could expose the system to security vulnerabilities. (link)

Overall Comments:

  • Please document the security considerations of enabling trusted markdown. Confirm that markdown content from the language server is properly sanitized to prevent XSS risks.
Here's what I looked at during the review
  • 🟢 Functionality: all looks good
  • 🟢 General issues: all looks good
  • 🔴 Security: 1 blocking issue
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

LangSmith trace

Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

src/extension.ts Show resolved Hide resolved
@Hellebore Hellebore merged commit b3ae610 into main Jan 23, 2025
1 check passed
@Hellebore Hellebore deleted the nick/feat/allow-links-in-sourcery-markdown-hovers branch January 23, 2025 16:54
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