feat: add getText() and generateText() methods (fix #1428)

[philippkuehn]

This PR adds two methods getText() and generateText(). You can define text rendering of nodes with the renderText config. This is mostly useful for atom nodes like hard breaks, mentions etc.

const HardBreak = Node.create({
  name: 'hardBreak',

  renderText() {
    return '\n'
  },

  // ...
})

usage of getText()

// basic usage
const text = editor.getText()

// with some options
const text = editor.getText({
  // define a custom block separator if you want to
  blockSeparator: '\n',
  // overwrite `renderText` method of nodes
  textSerializers: {
    hardBreak: () => '\n',
  },
})

usage of generateText()

import { generateText } from '@tiptap/core'
import Document from '@tiptap/extension-document'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
import HardBreak from '@tiptap/extension-hard-break'

const json = {} // ProseMirror JSON

// basic usage
const text = generateText(json, [
  Document,
  Paragraph,
  Text,
  HardBreak,
  // other extensions …
])

// with some options
const text = generateText(json, [
  Document,
  Paragraph,
  Text,
  HardBreak,
  // other extensions …
], {
  // define a custom block separator if you want to
  blockSeparator: '\n',
  // overwrite `renderText` method of nodes
  textSerializers: {
    hardBreak: () => '\n',
  },
})

[lostdesign]

Oh damn 🙌 Very nice addition. Comes in handy as I won't need the tokeniser for flexsearch anymore!

[BrianHung]

@philippkuehn I think the clipboardTextSerializer should only be serializing the given slice as opposed to the entire doc.

[philippkuehn]

@BrianHung But I serialize only a part of the doc based on the current selection. Is there any issue with the current solution?

[BrianHung]

But I serialize only a part of the doc based on the current selection. Is there any issue with the current solution?

Ah nevermind; I see the range = {from, to} as opposed to the slice. 😅

[tsl1127]

Is there any way to make the positions of the text output by getText() the same as the positons in the editor? Especially the text in the table