@puredesktop/platform-editor 1.0.0-beta.1 → 2.1.0

package/src/extensions/slashCommands.test.ts

@@ -1,170 +1,170 @@
-import { describe, expect, it, vi } from 'vitest'
-import {
-  createDefaultSlashCommands,
-  type SlashCommandItem,
-} from './slashCommands.js'
-
-function createEditor() {
-  const chain = {
-    focus: vi.fn(() => chain),
-    deleteRange: vi.fn(() => chain),
-    setTextSelection: vi.fn(() => chain),
-    setParagraph: vi.fn(() => chain),
-    setNode: vi.fn(() => chain),
-    toggleBold: vi.fn(() => chain),
-    toggleItalic: vi.fn(() => chain),
-    toggleUnderline: vi.fn(() => chain),
-    toggleCode: vi.fn(() => chain),
-    toggleBulletList: vi.fn(() => chain),
-    toggleOrderedList: vi.fn(() => chain),
-    toggleTaskList: vi.fn(() => chain),
-    sinkListItem: vi.fn(() => chain),
-    liftListItem: vi.fn(() => chain),
-    toggleBlockquote: vi.fn(() => chain),
-    toggleCodeBlock: vi.fn(() => chain),
-    insertTable: vi.fn(() => chain),
-    insertFootnote: vi.fn(() => chain),
-    toggleIndexMarker: vi.fn(() => chain),
-    insertMermaidBlock: vi.fn(() => chain),
-    run: vi.fn(() => true),
-  }
-  const editor = {
-    chain: vi.fn(() => chain),
-  }
-  return { editor, chain }
-}
-
-function runCommand(item: SlashCommandItem) {
-  const { editor, chain } = createEditor()
-  item.run({
-    editor: editor as never,
-    range: { from: 2, to: 8 },
-    query: item.title,
-    source: 'typed',
-  })
-  return { editor, chain }
-}
-
-function runSelectionCommand(item: SlashCommandItem) {
-  const { editor, chain } = createEditor()
-  item.run({
-    editor: editor as never,
-    range: { from: 2, to: 8 },
-    query: item.title,
-    source: 'selection',
-  })
-  return { editor, chain }
-}
-
-describe('createDefaultSlashCommands', () => {
-  it('provides the default PureWriter content command inventory', () => {
-    expect(createDefaultSlashCommands().map(item => item.id)).toEqual([
-      'paragraph',
-      'heading-1',
-      'heading-2',
-      'heading-3',
-      'bold',
-      'italic',
-      'underline',
-      'inline-code',
-      'link',
-      'bullet-list',
-      'numbered-list',
-      'task-list',
-      'indent-list',
-      'outdent-list',
-      'quote',
-      'code-block',
-      'table',
-      'footnote',
-      'index-marker',
-      'inline-equation',
-      'display-equation',
-      'mermaid',
-    ])
-  })
-
-  it('turns slash text into a paragraph', () => {
-    const paragraph = createDefaultSlashCommands().find(
-      item => item.id === 'paragraph',
-    )
-    expect(paragraph).toBeDefined()
-
-    const { chain } = runCommand(paragraph!)
-
-    expect(chain.deleteRange).toHaveBeenCalledWith({ from: 2, to: 8 })
-    expect(chain.setParagraph).toHaveBeenCalledOnce()
-    expect(chain.run).toHaveBeenCalledOnce()
-  })
-
-  it('turns slash text into headings', () => {
-    const commands = createDefaultSlashCommands()
-
-    const h1 = runCommand(commands.find(item => item.id === 'heading-1')!)
-    const h2 = runCommand(commands.find(item => item.id === 'heading-2')!)
-    const h3 = runCommand(commands.find(item => item.id === 'heading-3')!)
-
-    expect(h1.chain.setNode).toHaveBeenCalledWith('heading', { level: 1 })
-    expect(h2.chain.setNode).toHaveBeenCalledWith('heading', { level: 2 })
-    expect(h3.chain.setNode).toHaveBeenCalledWith('heading', { level: 3 })
-  })
-
-  it('turns slash text into mark, list, and block commands', () => {
-    const commands = createDefaultSlashCommands()
-
-    const bold = runCommand(commands.find(item => item.id === 'bold')!)
-    const italic = runCommand(commands.find(item => item.id === 'italic')!)
-    const underline = runCommand(
-      commands.find(item => item.id === 'underline')!,
-    )
-    const inlineCode = runCommand(
-      commands.find(item => item.id === 'inline-code')!,
-    )
-    const bullet = runCommand(commands.find(item => item.id === 'bullet-list')!)
-    const numbered = runCommand(
-      commands.find(item => item.id === 'numbered-list')!,
-    )
-    const task = runCommand(commands.find(item => item.id === 'task-list')!)
-    const indent = runCommand(commands.find(item => item.id === 'indent-list')!)
-    const outdent = runCommand(
-      commands.find(item => item.id === 'outdent-list')!,
-    )
-    const quote = runCommand(commands.find(item => item.id === 'quote')!)
-    const code = runCommand(commands.find(item => item.id === 'code-block')!)
-    const table = runCommand(commands.find(item => item.id === 'table')!)
-    const footnote = runCommand(commands.find(item => item.id === 'footnote')!)
-    const index = runCommand(
-      commands.find(item => item.id === 'index-marker')!,
-    )
-    const mermaid = runCommand(commands.find(item => item.id === 'mermaid')!)
-
-    expect(bold.chain.toggleBold).toHaveBeenCalledOnce()
-    expect(italic.chain.toggleItalic).toHaveBeenCalledOnce()
-    expect(underline.chain.toggleUnderline).toHaveBeenCalledOnce()
-    expect(inlineCode.chain.toggleCode).toHaveBeenCalledOnce()
-    expect(bullet.chain.toggleBulletList).toHaveBeenCalledOnce()
-    expect(numbered.chain.toggleOrderedList).toHaveBeenCalledOnce()
-    expect(task.chain.toggleTaskList).toHaveBeenCalledOnce()
-    expect(indent.chain.sinkListItem).toHaveBeenCalledWith('listItem')
-    expect(outdent.chain.liftListItem).toHaveBeenCalledWith('listItem')
-    expect(quote.chain.toggleBlockquote).toHaveBeenCalledOnce()
-    expect(code.chain.toggleCodeBlock).toHaveBeenCalledOnce()
-    expect(table.chain.insertTable).toHaveBeenCalledWith({
-      rows: 3,
-      cols: 3,
-      withHeaderRow: true,
-    })
-    expect(footnote.chain.insertFootnote).toHaveBeenCalledOnce()
-    expect(index.chain.toggleIndexMarker).toHaveBeenCalledOnce()
-    expect(mermaid.chain.insertMermaidBlock).toHaveBeenCalledOnce()
-  })
-
-  it('does not delete selected text when a slash command is run on a selection', () => {
-    const commands = createDefaultSlashCommands()
-    const bold = runSelectionCommand(commands.find(item => item.id === 'bold')!)
-
-    expect(bold.chain.deleteRange).not.toHaveBeenCalled()
-    expect(bold.chain.setTextSelection).toHaveBeenCalledWith({ from: 2, to: 8 })
-    expect(bold.chain.toggleBold).toHaveBeenCalledOnce()
-  })
-})
+import { describe, expect, it, vi } from 'vitest'
+import {
+  createDefaultSlashCommands,
+  type SlashCommandItem,
+} from './slashCommands.js'
+
+function createEditor() {
+  const chain = {
+    focus: vi.fn(() => chain),
+    deleteRange: vi.fn(() => chain),
+    setTextSelection: vi.fn(() => chain),
+    setParagraph: vi.fn(() => chain),
+    setNode: vi.fn(() => chain),
+    toggleBold: vi.fn(() => chain),
+    toggleItalic: vi.fn(() => chain),
+    toggleUnderline: vi.fn(() => chain),
+    toggleCode: vi.fn(() => chain),
+    toggleBulletList: vi.fn(() => chain),
+    toggleOrderedList: vi.fn(() => chain),
+    toggleTaskList: vi.fn(() => chain),
+    sinkListItem: vi.fn(() => chain),
+    liftListItem: vi.fn(() => chain),
+    toggleBlockquote: vi.fn(() => chain),
+    toggleCodeBlock: vi.fn(() => chain),
+    insertTable: vi.fn(() => chain),
+    insertFootnote: vi.fn(() => chain),
+    toggleIndexMarker: vi.fn(() => chain),
+    insertMermaidBlock: vi.fn(() => chain),
+    run: vi.fn(() => true),
+  }
+  const editor = {
+    chain: vi.fn(() => chain),
+  }
+  return { editor, chain }
+}
+
+function runCommand(item: SlashCommandItem) {
+  const { editor, chain } = createEditor()
+  item.run({
+    editor: editor as never,
+    range: { from: 2, to: 8 },
+    query: item.title,
+    source: 'typed',
+  })
+  return { editor, chain }
+}
+
+function runSelectionCommand(item: SlashCommandItem) {
+  const { editor, chain } = createEditor()
+  item.run({
+    editor: editor as never,
+    range: { from: 2, to: 8 },
+    query: item.title,
+    source: 'selection',
+  })
+  return { editor, chain }
+}
+
+describe('createDefaultSlashCommands', () => {
+  it('provides the default PureWriter content command inventory', () => {
+    expect(createDefaultSlashCommands().map(item => item.id)).toEqual([
+      'paragraph',
+      'heading-1',
+      'heading-2',
+      'heading-3',
+      'bold',
+      'italic',
+      'underline',
+      'inline-code',
+      'link',
+      'bullet-list',
+      'numbered-list',
+      'task-list',
+      'indent-list',
+      'outdent-list',
+      'quote',
+      'code-block',
+      'table',
+      'footnote',
+      'index-marker',
+      'inline-equation',
+      'display-equation',
+      'mermaid',
+    ])
+  })
+
+  it('turns slash text into a paragraph', () => {
+    const paragraph = createDefaultSlashCommands().find(
+      item => item.id === 'paragraph',
+    )
+    expect(paragraph).toBeDefined()
+
+    const { chain } = runCommand(paragraph!)
+
+    expect(chain.deleteRange).toHaveBeenCalledWith({ from: 2, to: 8 })
+    expect(chain.setParagraph).toHaveBeenCalledOnce()
+    expect(chain.run).toHaveBeenCalledOnce()
+  })
+
+  it('turns slash text into headings', () => {
+    const commands = createDefaultSlashCommands()
+
+    const h1 = runCommand(commands.find(item => item.id === 'heading-1')!)
+    const h2 = runCommand(commands.find(item => item.id === 'heading-2')!)
+    const h3 = runCommand(commands.find(item => item.id === 'heading-3')!)
+
+    expect(h1.chain.setNode).toHaveBeenCalledWith('heading', { level: 1 })
+    expect(h2.chain.setNode).toHaveBeenCalledWith('heading', { level: 2 })
+    expect(h3.chain.setNode).toHaveBeenCalledWith('heading', { level: 3 })
+  })
+
+  it('turns slash text into mark, list, and block commands', () => {
+    const commands = createDefaultSlashCommands()
+
+    const bold = runCommand(commands.find(item => item.id === 'bold')!)
+    const italic = runCommand(commands.find(item => item.id === 'italic')!)
+    const underline = runCommand(
+      commands.find(item => item.id === 'underline')!,
+    )
+    const inlineCode = runCommand(
+      commands.find(item => item.id === 'inline-code')!,
+    )
+    const bullet = runCommand(commands.find(item => item.id === 'bullet-list')!)
+    const numbered = runCommand(
+      commands.find(item => item.id === 'numbered-list')!,
+    )
+    const task = runCommand(commands.find(item => item.id === 'task-list')!)
+    const indent = runCommand(commands.find(item => item.id === 'indent-list')!)
+    const outdent = runCommand(
+      commands.find(item => item.id === 'outdent-list')!,
+    )
+    const quote = runCommand(commands.find(item => item.id === 'quote')!)
+    const code = runCommand(commands.find(item => item.id === 'code-block')!)
+    const table = runCommand(commands.find(item => item.id === 'table')!)
+    const footnote = runCommand(commands.find(item => item.id === 'footnote')!)
+    const index = runCommand(
+      commands.find(item => item.id === 'index-marker')!,
+    )
+    const mermaid = runCommand(commands.find(item => item.id === 'mermaid')!)
+
+    expect(bold.chain.toggleBold).toHaveBeenCalledOnce()
+    expect(italic.chain.toggleItalic).toHaveBeenCalledOnce()
+    expect(underline.chain.toggleUnderline).toHaveBeenCalledOnce()
+    expect(inlineCode.chain.toggleCode).toHaveBeenCalledOnce()
+    expect(bullet.chain.toggleBulletList).toHaveBeenCalledOnce()
+    expect(numbered.chain.toggleOrderedList).toHaveBeenCalledOnce()
+    expect(task.chain.toggleTaskList).toHaveBeenCalledOnce()
+    expect(indent.chain.sinkListItem).toHaveBeenCalledWith('listItem')
+    expect(outdent.chain.liftListItem).toHaveBeenCalledWith('listItem')
+    expect(quote.chain.toggleBlockquote).toHaveBeenCalledOnce()
+    expect(code.chain.toggleCodeBlock).toHaveBeenCalledOnce()
+    expect(table.chain.insertTable).toHaveBeenCalledWith({
+      rows: 3,
+      cols: 3,
+      withHeaderRow: true,
+    })
+    expect(footnote.chain.insertFootnote).toHaveBeenCalledOnce()
+    expect(index.chain.toggleIndexMarker).toHaveBeenCalledOnce()
+    expect(mermaid.chain.insertMermaidBlock).toHaveBeenCalledOnce()
+  })
+
+  it('does not delete selected text when a slash command is run on a selection', () => {
+    const commands = createDefaultSlashCommands()
+    const bold = runSelectionCommand(commands.find(item => item.id === 'bold')!)
+
+    expect(bold.chain.deleteRange).not.toHaveBeenCalled()
+    expect(bold.chain.setTextSelection).toHaveBeenCalledWith({ from: 2, to: 8 })
+    expect(bold.chain.toggleBold).toHaveBeenCalledOnce()
+  })
+})