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

refactor: adjust validate and add shouldAutoLink to improve URL handling #5808

Merged
merged 6 commits into from
Nov 6, 2024

Conversation

guarmo
Copy link
Contributor

@guarmo guarmo commented Nov 6, 2024

Changes Overview

Added a new shouldAutoLink function to control the auto-linking of URLs based on specific criteria, such as disallowed domains, and enhanced the existing validate function to handle URLs more robustly.

Testing Done

  • Created tests to verify that shouldAutoLink does not auto-link URLs with disallowed domains and correctly auto-links valid URLs.
  • Updated integration tests for validate to ensure URLs are correctly validated with or without protocols. Verified that URLs with disallowed protocols and domains are not linked.

Checklist

  • I have created a changeset for this PR if necessary.
  • My changes do not break the library.
  • I have added tests where applicable.
  • I have followed the project guidelines.
  • I have fixed any lint issues.

Related Issues

#5564

Copy link

changeset-bot bot commented Nov 6, 2024

🦋 Changeset detected

Latest commit: 585f6ef

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 55 packages
Name Type
@tiptap/extension-link Patch
tiptap-demos Patch
@tiptap/core Patch
@tiptap/extension-blockquote Patch
@tiptap/extension-bold Patch
@tiptap/extension-bubble-menu Patch
@tiptap/extension-bullet-list Patch
@tiptap/extension-character-count Patch
@tiptap/extension-code-block-lowlight Patch
@tiptap/extension-code-block Patch
@tiptap/extension-code Patch
@tiptap/extension-collaboration-cursor Patch
@tiptap/extension-collaboration Patch
@tiptap/extension-color Patch
@tiptap/extension-document Patch
@tiptap/extension-dropcursor Patch
@tiptap/extension-floating-menu Patch
@tiptap/extension-focus Patch
@tiptap/extension-font-family Patch
@tiptap/extension-gapcursor Patch
@tiptap/extension-hard-break Patch
@tiptap/extension-heading Patch
@tiptap/extension-highlight Patch
@tiptap/extension-history Patch
@tiptap/extension-horizontal-rule Patch
@tiptap/extension-image Patch
@tiptap/extension-italic Patch
@tiptap/extension-list-item Patch
@tiptap/extension-list-keymap Patch
@tiptap/extension-mention Patch
@tiptap/extension-ordered-list Patch
@tiptap/extension-paragraph Patch
@tiptap/extension-placeholder Patch
@tiptap/extension-strike Patch
@tiptap/extension-subscript Patch
@tiptap/extension-superscript Patch
@tiptap/extension-table-cell Patch
@tiptap/extension-table-header Patch
@tiptap/extension-table-row Patch
@tiptap/extension-table Patch
@tiptap/extension-task-item Patch
@tiptap/extension-task-list Patch
@tiptap/extension-text-align Patch
@tiptap/extension-text-style Patch
@tiptap/extension-text Patch
@tiptap/extension-typography Patch
@tiptap/extension-underline Patch
@tiptap/extension-youtube Patch
@tiptap/html Patch
@tiptap/pm Patch
@tiptap/react Patch
@tiptap/starter-kit Patch
@tiptap/suggestion Patch
@tiptap/vue-2 Patch
@tiptap/vue-3 Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

netlify bot commented Nov 6, 2024

Deploy Preview for tiptap-embed ready!

Name Link
🔨 Latest commit 585f6ef
🔍 Latest deploy log https://app.netlify.com/sites/tiptap-embed/deploys/672b786a9e12930008b52c20
😎 Deploy Preview https://deploy-preview-5808--tiptap-embed.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.

@rfgamaral
Copy link
Contributor

@guarmo I can't afford to look into this carefully right now, but does this PR implement the proposed solution by @nperez0111 mentioned here (an older PR that aims to fix the same issue).

Copy link
Contributor

@nperez0111 nperez0111 left a comment

Choose a reason for hiding this comment

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

Once you've got that. This is gtg

@guarmo guarmo merged commit 8a2e548 into develop Nov 6, 2024
14 checks passed
@guarmo guarmo deleted the refactor/url-validation-and-autolink branch November 6, 2024 14:14
@SanderLeenders
Copy link
Contributor

SanderLeenders commented Nov 7, 2024

What about backward compatibility? For example, what if someone previously only wanted to autolink URLs starting with https://. They may have added a validation function like:

validate: url => url.startsWith('https://),

With the current change, only URLs starting with https:// would be valid, which is not the same behavior as before.

@nperez0111
Copy link
Contributor

What about backward compatibility? For example, what if someone previously only wanted to autolink URLs starting with https://. They may have added a validation function like:

validate: url => url.startsWith('https://),

With the current change, only URLs starting with https:// would be valid, which is not the same behavior as before.

Yep, you are totally right here. Good catch, will have to look into how it can be kept backwards compatible

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.

4 participants