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 History extension to UndoRedo #6172

Merged
merged 3 commits into from
Mar 12, 2025
Merged

Conversation

bdbch
Copy link
Member

@bdbch bdbch commented Mar 12, 2025

Changes Overview

This PR renames the history extension and all it's occurrences to UndoRedo.

This is done because there were a few other functionalities and extensions also named 'History' for example CollaborationHistory or the Prosemirror history plugin.

Implementation Approach

I replaced all occurences of the history extension with it's undo-redo counterparts, updated the demo, tests and builds.

Testing Done

I've tested a few demos using the undo-redo extension locally & ran through tests locally.

Verification Steps

See above

Additional Notes

This is a breaking change for our 3.0.0 release.

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: 6cafe00

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-cursor 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-undo-redo 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 6cafe00
🔍 Latest deploy log https://app.netlify.com/sites/tiptap-embed/deploys/67d182f7d34e140008a7b90d
😎 Deploy Preview https://deploy-preview-6172--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.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request renames the history extension to UndoRedo throughout the codebase to resolve naming conflicts with other history-related extensions.

  • Renames import paths from "@tiptap/extension-history" to "@tiptap/extension-undo-redo" and updates related configuration properties.
  • Updates demo files and codemods documentation to reflect the new naming convention.

Reviewed Changes

Copilot reviewed 39 out of 39 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
.changeset/thirty-rockets-act.md Updated changeset description to reflect renaming.
codemods/tiptap-2-migrate-imports/src/index.ts Replaced import mappings for History with UndoRedo accordingly.
demos/src/Extensions/UndoRedo/Vue/index.spec.js Updated test context and visit paths to the new UndoRedo extension.
demos/src/Extensions/UndoRedo/React/index.spec.js Updated test context and visit paths to the new UndoRedo extension.
demos/src/Demos/CollaborationSplitPane/React/Editor.jsx Modified StarterKit configuration property from history to undoRedo.
codemods/tiptap-2-migrate-imports/README.md Updated import examples to use double quotes and reflect renaming.
.changeset/chilly-lemons-remember.md Adjusted migration instructions from History to UndoRedo.
demos/src/Examples/CollaborativeEditing/React/index.jsx Updated StarterKit configuration property from history to undoRedo.
.changeset/chilled-trees-agree.md Updated changeset dependency from history to undoRedo.
.changeset/cuddly-impalas-heal.md Updated changeset dependency from history to undoRedo.
demos/src/Demos/SingleRoomCollab/React/index.jsx Updated StarterKit configuration property from history to undoRedo.
demos/src/Extensions/UndoRedo/React/index.jsx Updated import name from History to UndoRedo and added button types.
demos/src/Experiments/All/Vue/index.vue Updated import statement to replace History with UndoRedo; minor formatting noted.

@bdbch bdbch merged commit d8a3d93 into next Mar 12, 2025
14 of 15 checks passed
@bdbch bdbch deleted the refactor/rename-history-ext branch March 12, 2025 13:55
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