Rename History extension to UndoRedo (#6172)

* rename history extension to undo-redo

* added changesets

* fix spacing in vue demo

Author: bdbch

.changeset/chilled-trees-agree.md

@@ -32,7 +32,7 @@
 '@tiptap/extension-underline': major
 '@tiptap/extension-document': major
 '@tiptap/extension-heading': major
-'@tiptap/extension-history': major
+'@tiptap/extension-undo-redo': major
 '@tiptap/extension-mention': major
 '@tiptap/extension-youtube': major
 '@tiptap/extension-italic': major

.changeset/chilly-lemons-remember.md

@@ -59,17 +59,17 @@ import { GapCursor } from '@tiptap/extensions'
 
 This extension adds undo and redo functionality to the editor.
 
-Migrate from `@tiptap/extension-history` to `@tiptap/extensions`:
+Migrate from `@tiptap/extension-undo-redo` to `@tiptap/extensions`:
 
 ```diff
-- import History from '@tiptap/extension-history'
+- import History from '@tiptap/extension-undo-redo'
 + import { History } from '@tiptap/extensions'
 ```
 
 Usage:
 
 ```ts
-import { History, HistoryOptions } from '@tiptap/extensions'
+import { UndoRedo, UndoRedoOptions } from '@tiptap/extensions'
 ```
 
 ## Placeholder

.changeset/cuddly-impalas-heal.md

@@ -22,7 +22,7 @@
 '@tiptap/extension-hard-break': patch
 '@tiptap/extension-heading': patch
 '@tiptap/extension-highlight': patch
-'@tiptap/extension-history': patch
+'@tiptap/extension-undo-redo': patch
 '@tiptap/extension-horizontal-rule': patch
 '@tiptap/extension-image': patch
 '@tiptap/extension-italic': patch

.changeset/pre.json

@@ -24,7 +24,7 @@
     "@tiptap/extension-hard-break": "2.11.4",
     "@tiptap/extension-heading": "2.11.4",
     "@tiptap/extension-highlight": "2.11.4",
-    "@tiptap/extension-history": "2.11.4",
+    "@tiptap/extension-undo-redo": "2.11.4",
     "@tiptap/extension-horizontal-rule": "2.11.4",
     "@tiptap/extension-image": "2.11.4",
     "@tiptap/extension-italic": "2.11.4",

.changeset/thirty-rockets-act.md

@@ -0,0 +1,5 @@
+---
+'@tiptap/extension-undo-redo': major
+---
+
+Rename history extension to undo-redo to clarify it's functionality and separate itself from other history-related extensions.

.vscode/settings.json

@@ -27,7 +27,7 @@
     "extension/hard-break",
     "extension/heading",
     "extension/highlight",
-    "extension/history",
+    "extension/undo-redo",
     "extension/horizontal-rule",
     "extension/image",
     "extension/italic",

codemods/tiptap-2-migrate-imports/README.md

@@ -1,5 +1,4 @@
-
-This is a [codemod](https://codemod.com) created with [```codemod init```](https://docs.codemod.com/deploying-codemods/cli#codemod-init).
+This is a [codemod](https://codemod.com) created with [`codemod init`](https://docs.codemod.com/deploying-codemods/cli#codemod-init).
 
 ## Using this codemod
 
@@ -12,54 +11,44 @@ npx codemod tiptap-2-migrate-imports
 ### Before
 
 ```ts
-import Table from '@tiptap/extension-table';
-import TableRow from '@tiptap/extension-table-row';
-import TableCell from '@tiptap/extension-table-cell';
-import TableHeader from '@tiptap/extension-table-header';
+import Table from "@tiptap/extension-table";
+import TableRow from "@tiptap/extension-table-row";
+import TableCell from "@tiptap/extension-table-cell";
+import TableHeader from "@tiptap/extension-table-header";
 ```
 
 ### After
 
 ```ts
-import {
-  Table,
-  TableRow,
-  TableCell,
-  TableHeader,
-} from '@tiptap/extension-table';
+import { Table, TableRow, TableCell, TableHeader } from "@tiptap/extension-table";
 ```
 
 ,
 
 ### Before
 
 ```ts
-import { Table } from '@tiptap/extension-table';
-import { TableRow } from '@tiptap/extension-table-row';
-import { TableCell } from '@tiptap/extension-table-cell';
-import { TableHeader } from '@tiptap/extension-table-header';
+import { Table } from "@tiptap/extension-table";
+import { TableRow } from "@tiptap/extension-table-row";
+import { TableCell } from "@tiptap/extension-table-cell";
+import { TableHeader } from "@tiptap/extension-table-header";
 ```
 
 ### After
 
 ```ts
-import {
-  Table,
-  TableRow,
-  TableCell,
-  TableHeader,
-} from '@tiptap/extension-table';
+import { Table, TableRow, TableCell, TableHeader } from "@tiptap/extension-table";
 ```
 
 ,
 
 ### Before
 
 ```ts
-import Table1 from '@tiptap/extension-table';
-import TableR from '@tiptap/extension-table-row';
-import TableCel from '@tiptap/extension-table-cell';
-import TableHead from '@tiptap/extension-table-header';
+import Table1 from "@tiptap/extension-table";
+import TableR from "@tiptap/extension-table-row";
+import TableCel from "@tiptap/extension-table-cell";
+import TableHead from "@tiptap/extension-table-header";
 ```
 
 ### After
@@ -70,51 +59,51 @@ import {
   TableRow as TableR,
   TableCell as TableCel,
   TableHeader as TableHead,
-} from '@tiptap/extension-table';
+} from "@tiptap/extension-table";
 ```
 
 ,
 
 ### Before
 
 ```ts
-import BulletList from '@tiptap/extension-bullet-list';
-import OrderedList from '@tiptap/extension-ordered-list';
-import ListItem from '@tiptap/extension-list-item';
+import BulletList from "@tiptap/extension-bullet-list";
+import OrderedList from "@tiptap/extension-ordered-list";
+import ListItem from "@tiptap/extension-list-item";
 ```
 
 ### After
 
 ```ts
-import { BulletList, OrderedList, ListItem } from '@tiptap/extension-list';
+import { BulletList, OrderedList, ListItem } from "@tiptap/extension-list";
 ```
 
 ,
 
 ### Before
 
 ```ts
-import TextStyle from '@tiptap/extension-text-style';
-import { Color } from '@tiptap/extension-color';
+import TextStyle from "@tiptap/extension-text-style";
+import { Color } from "@tiptap/extension-color";
 ```
 
 ### After
 
 ```ts
-import { TextStyle, Color } from '@tiptap/extension-text-style';
+import { TextStyle, Color } from "@tiptap/extension-text-style";
 ```
 
 ,
 
 ### Before
 
 ```ts
-import { PlaceHolder } from '@tiptap/extension-placeholder';
-import History from '@tiptap/extension-history';
+import { PlaceHolder } from "@tiptap/extension-placeholder";
+import UndoRedo from "@tiptap/extension-undo-redo";
 ```
 
 ### After
 
 ```ts
-import { PlaceHolder, History } from '@tiptap/extensions';
+import { PlaceHolder, UndoRedo } from "@tiptap/extensions";
 ```

codemods/tiptap-2-migrate-imports/__testfixtures__/fixture6.input

@@ -1,2 +1,2 @@
-import History from "@tiptap/extension-history";
+import UndoRedo from "@tiptap/extension-undo-redo";
 import { Placeholder } from "@tiptap/extension-placeholder";

codemods/tiptap-2-migrate-imports/__testfixtures__/fixture6.output

@@ -1 +1 @@
-import { History, Placeholder } from "@tiptap/extensions";
+import { UndoRedo, Placeholder } from "@tiptap/extensions";

codemods/tiptap-2-migrate-imports/src/index.ts

@@ -27,7 +27,7 @@ export default function transform(file: any, api: any) {
     "@tiptap/extension-dropcursor": "Dropcursor",
     "@tiptap/extension-gapcursor": "Gapcursor",
     "@tiptap/extension-focus": "Focus",
-    "@tiptap/extension-history": "History",
+    "@tiptap/extension-undo-redo": "UndoRedo",
     "@tiptap/extension-placeholder": "Placeholder",
   };
 
@@ -53,7 +53,7 @@ export default function transform(file: any, api: any) {
     "@tiptap/extension-dropcursor": "@tiptap/extensions",
     "@tiptap/extension-gapcursor": "@tiptap/extensions",
     "@tiptap/extension-focus": "@tiptap/extensions",
-    "@tiptap/extension-history": "@tiptap/extensions",
+    "@tiptap/extension-undo-redo": "@tiptap/extensions",
     "@tiptap/extension-placeholder": "@tiptap/extensions",
   };
 

demos/src/Demos/CollaborationSplitPane/React/Editor.jsx

@@ -95,7 +95,7 @@ const Editor = ({ ydoc, provider, room }) => {
     },
     extensions: [
       StarterKit.configure({
-        history: false,
+        undoRedo: false,
       }),
       Highlight,
       TaskList,

demos/src/Demos/SingleRoomCollab/React/index.jsx

@@ -67,7 +67,7 @@ export default () => {
   const editor = useEditor({
     extensions: [
       StarterKit.configure({
-        history: false,
+        undoRedo: false,
       }),
       CharacterCount.configure({
         limit: 10000,

demos/src/Examples/CollaborativeEditing/React/index.jsx

@@ -78,7 +78,7 @@ export default () => {
   const editor = useEditor({
     extensions: [
       StarterKit.configure({
-        history: false,
+        undoRedo: false,
       }),
       Highlight,
       TaskList,

demos/src/Experiments/All/Vue/index.vue

@@ -122,7 +122,7 @@ import Text from '@tiptap/extension-text'
 import TextAlign from '@tiptap/extension-text-align'
 import { Color, TextStyle } from '@tiptap/extension-text-style'
 import Underline from '@tiptap/extension-underline'
-import { Dropcursor, Gapcursor, History, Placeholder } from '@tiptap/extensions'
+import { Dropcursor, Gapcursor, Placeholder, UndoRedo } from '@tiptap/extensions'
 import { Editor, EditorContent } from '@tiptap/vue-3'
 import { all, createLowlight } from 'lowlight'
 
@@ -154,7 +154,7 @@ export default {
         Gapcursor,
         HardBreak,
         Heading,
-        History,
+        UndoRedo,
         HorizontalRule,
         Italic,
         ListItem,

demos/src/Extensions/History/React/index.html demos/src/Extensions/UndoRedo/React/index.html

@@ -3,16 +3,16 @@ import './styles.scss'
 import Document from '@tiptap/extension-document'
 import Paragraph from '@tiptap/extension-paragraph'
 import Text from '@tiptap/extension-text'
-import { History } from '@tiptap/extensions'
+import { UndoRedo } from '@tiptap/extensions'
 import { EditorContent, useEditor, useEditorState } from '@tiptap/react'
 import React from 'react'
 
 export default () => {
   const editor = useEditor({
-    extensions: [Document, Paragraph, Text, History],
+    extensions: [Document, Paragraph, Text, UndoRedo],
     content: `
         <p>
-          With the History extension the Editor will keep track of your changes. And if you think you made a mistake, you can redo your changes. Try it out, change the content and hit the undo button!
+          With the UndoRedo extension the Editor will keep track of your changes. And if you think you made a mistake, you can redo your changes. Try it out, change the content and hit the undo button!
         </p>
         <p>
           And yes, you can also use a keyboard shortcut to undo changes (Control/Cmd Z) or redo changes (Control/Cmd Shift Z).
@@ -38,10 +38,10 @@ export default () => {
     <>
       <div className="control-group">
         <div className="button-group">
-          <button onClick={() => editor.chain().focus().undo().run()} disabled={!canUndo}>
+          <button onClick={() => editor.chain().focus().undo().run()} disabled={!canUndo} type="button">
             Undo
           </button>
-          <button onClick={() => editor.chain().focus().redo().run()} disabled={!canRedo}>
+          <button onClick={() => editor.chain().focus().redo().run()} disabled={!canRedo} type="button">
             Redo
           </button>
         </div>

demos/src/Extensions/History/React/index.jsx demos/src/Extensions/UndoRedo/React/index.jsx

@@ -1,6 +1,6 @@
-context('/src/Extensions/History/React/', () => {
+context('/src/Extensions/UndoRedo/React/', () => {
   beforeEach(() => {
-    cy.visit('/src/Extensions/History/React/')
+    cy.visit('/src/Extensions/UndoRedo/React/')
     cy.get('.tiptap').then(([{ editor }]) => {
       editor.commands.setContent('<p>Mistake</p>')
     })

demos/src/Extensions/History/React/index.spec.js demos/src/Extensions/UndoRedo/React/index.spec.js

@@ -1,6 +1,6 @@
-context('/src/Extensions/History/Vue/', () => {
+context('/src/Extensions/UndoRedo/Vue/', () => {
   beforeEach(() => {
-    cy.visit('/src/Extensions/History/Vue/')
+    cy.visit('/src/Extensions/UndoRedo/Vue/')
     cy.get('.tiptap').then(([{ editor }]) => {
       editor.commands.setContent('<p>Mistake</p>')
     })

demos/src/Extensions/History/React/styles.scss demos/src/Extensions/UndoRedo/React/styles.scss

@@ -14,7 +14,7 @@
 import Document from '@tiptap/extension-document'
 import Paragraph from '@tiptap/extension-paragraph'
 import Text from '@tiptap/extension-text'
-import { History } from '@tiptap/extensions'
+import { UndoRedo } from '@tiptap/extensions'
 import { Editor, EditorContent } from '@tiptap/vue-3'
 
 export default {
@@ -30,10 +30,10 @@ export default {
 
   mounted() {
     this.editor = new Editor({
-      extensions: [Document, Paragraph, Text, History],
+      extensions: [Document, Paragraph, Text, UndoRedo],
       content: `
         <p>
-          With the History extension the Editor will keep track of your changes. And if you think you made a mistake, you can redo your changes. Try it out, change the content and hit the undo button!
+          With the UndoRedo extension the Editor will keep track of your changes. And if you think you made a mistake, you can redo your changes. Try it out, change the content and hit the undo button!
         </p>
         <p>
           And yes, you can also use a keyboard shortcut to undo changes (Control/Cmd Z) or redo changes (Control/Cmd Shift Z).

demos/src/Extensions/History/Vue/index.html demos/src/Extensions/UndoRedo/Vue/index.html

@@ -96,9 +96,9 @@ export const Collaboration = Extension.create<CollaborationOptions, Collaboratio
   },
 
   onCreate() {
-    if (this.editor.extensionManager.extensions.find(extension => extension.name === 'history')) {
+    if (this.editor.extensionManager.extensions.find(extension => extension.name === 'undoRedo')) {
       console.warn(
-        '[tiptap warn]: "@tiptap/extension-collaboration" comes with its own history support and is not compatible with "@tiptap/extension-history".',
+        '[tiptap warn]: "@tiptap/extension-collaboration" comes with its own history support and is not compatible with "@tiptap/extension-undo-redo".',
       )
     }
   },

demos/src/Extensions/History/Vue/index.spec.js demos/src/Extensions/UndoRedo/Vue/index.spec.js

@@ -1,8 +1,8 @@
-# @tiptap/extension-history
+# @tiptap/extension-undo-redo
 
-[![Version](https://img.shields.io/npm/v/@tiptap/extension-history.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-history)
-[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-history.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
-[![License](https://img.shields.io/npm/l/@tiptap/extension-history.svg)](https://www.npmjs.com/package/@tiptap/extension-history)
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-undo-redo.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-undo-redo)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-undo-redo.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
+[![License](https://img.shields.io/npm/l/@tiptap/extension-undo-redo.svg)](https://www.npmjs.com/package/@tiptap/extension-undo-redo)
 [![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
 
 ## Introduction

demos/src/Extensions/History/Vue/index.vue demos/src/Extensions/UndoRedo/Vue/index.vue

@@ -1,5 +1,5 @@
 {
-  "name": "@tiptap/extension-history",
+  "name": "@tiptap/extension-undo-redo",
   "description": "history extension for tiptap",
   "version": "3.0.0-next.6",
   "homepage": "https://tiptap.dev",
@@ -39,7 +39,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/ueberdosis/tiptap",
-    "directory": "packages/extension-history"
+    "directory": "packages/extension-undo-redo"
   },
   "scripts": {
     "build": "tsup",

packages/extension-collaboration/src/collaboration.ts

@@ -0,0 +1,6 @@
+import { UndoRedo } from '@tiptap/extensions'
+
+export type { UndoRedoOptions } from '@tiptap/extensions'
+export { UndoRedo } from '@tiptap/extensions'
+
+export default UndoRedo