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

Rename CollaborationCursor extension to CollaborationCaret #6173

Merged
merged 2 commits into from
Mar 12, 2025

Conversation

bdbch
Copy link
Member

@bdbch bdbch commented Mar 12, 2025

Changes Overview

This PR renames the collaboration-cursor extension to collaboration-caret to clarify what kind of cursors this extension is implementing.

Implementation Approach

I renamed all occurrences of the CollaborationCursor extensions, updated imports, builds and demos.

Testing Done

I tested my changes locally in our demos and ran tests locally to make sure this is not breaking anything.

Verification Steps

See above

Additional Notes

This PR is a breaking change for 3.0.0

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.

@bdbch bdbch self-assigned this Mar 12, 2025
Copy link

changeset-bot bot commented Mar 12, 2025

🦋 Changeset detected

Latest commit: c13172f

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

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

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 Mar 12, 2025

Deploy Preview for tiptap-embed ready!

Name Link
🔨 Latest commit c13172f
🔍 Latest deploy log https://app.netlify.com/sites/tiptap-embed/deploys/67d18d6d953c350008e79904
😎 Deploy Preview https://deploy-preview-6173--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.

Choose a reason for hiding this comment

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

Pull Request Overview

This PR renames the CollaborationCursor extension to CollaborationCaret to improve clarity regarding its functionality.

  • Updated changesets to reflect the new package name.
  • Renamed import paths, test paths, and associated UI usage in both React and Vue demos.
  • Adjusted CSS class names in Vue demos to match the new extension name.

Reviewed Changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated no comments.

Show a summary per file
File Description
.changeset/many-laws-vanish.md Updated changeset file to list the new extension name.
demos/src/Extensions/CollaborationCaret/React/index.spec.js Updated React test paths from CollaborationCursor to CollaborationCaret.
demos/src/Extensions/CollaborationCaret/Vue/index.spec.js Updated Vue test paths from CollaborationCursor to CollaborationCaret.
.changeset/eighty-gifts-matter.md Reflects the new extension name in the changeset.
demos/src/Demos/SingleRoomCollab/React/index.jsx Updated import and runtime references from CollaborationCursor to CollaborationCaret.
.changeset/chilled-trees-agree.md Updated changeset file for new naming.
demos/src/Examples/CollaborativeEditing/React/index.jsx Updated import and runtime references from CollaborationCursor to CollaborationCaret.
.changeset/cuddly-impalas-heal.md Updated changeset file for the renamed extension.
demos/src/Demos/CollaborationSplitPane/React/Editor.jsx Updated import and runtime references for the renamed extension.
demos/src/Extensions/CollaborationCaret/React/index.jsx Updated React component usage and provider naming.
demos/src/Extensions/CollaborationCaret/Vue/index.vue Updated Vue component usage and CSS class names for the renamed extension.
demos/src/Examples/CollaborativeEditing/Vue/index.vue Updated Vue example usage including CSS class updates.
Comments suppressed due to low confidence (2)

.changeset/many-laws-vanish.md:5

  • Consider updating the explanation text by replacing 'cursor' with 'caret' for consistency with the new naming.
+Renamed `@tiptap/extension-collaboration-cursor` to `@tiptap/extension-collaboration-caret` to clarify what kind of cursor this extension is implementing.

demos/src/Extensions/CollaborationCaret/Vue/index.vue:94

  • [nitpick] The CSS class name 'collaboration-carets__label' uses a plural form that may be inconsistent with the singular 'CollaborationCaret'. Consider aligning the CSS naming convention with the new extension name.
+  .collaboration-carets__label {
@bdbch bdbch merged commit 25ec82e into next Mar 12, 2025
14 of 15 checks passed
@bdbch bdbch deleted the refactor/rename-collaboration-cursor-ext branch March 12, 2025 14: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.

2 participants