@milkdown/preset-gfm 7.1.1 → 7.1.2-next.0

package/src/node/table/index.ts

@@ -7,6 +7,7 @@ import type { NodeType } from '@milkdown/prose/model'
 import { Selection, TextSelection } from '@milkdown/prose/state'
 import { CellSelection, addColumnAfter, addColumnBefore, deleteColumn, deleteRow, deleteTable, goToNextCell, isInTable, selectedRect, setCellAttr, tableNodes } from '@milkdown/prose/tables'
 import { $command, $inputRule, $nodeSchema, $useKeymap } from '@milkdown/utils'
+import { withMeta } from '../../__internal__'
 import { addRowWithAlignment, createTable, moveCol, moveRow, selectCol, selectRow, selectTable } from './utils'
 
 const originalSchema = tableNodes({
@@ -56,9 +57,18 @@ export const tableSchema = $nodeSchema('table', () => ({
       state.closeNode()
     },
   },
-
 }))
 
+withMeta(tableSchema.node, {
+  displayName: 'NodeSchema<table>',
+  group: 'Table',
+})
+
+withMeta(tableSchema.ctx, {
+  displayName: 'NodeSchemaCtx<table>',
+  group: 'Table',
+})
+
 /// Schema for table row node.
 export const tableRowSchema = $nodeSchema('table_row', () => ({
   ...originalSchema.table_row,
@@ -86,6 +96,16 @@ export const tableRowSchema = $nodeSchema('table_row', () => ({
   },
 }))
 
+withMeta(tableRowSchema.node, {
+  displayName: 'NodeSchema<tableRow>',
+  group: 'Table',
+})
+
+withMeta(tableRowSchema.ctx, {
+  displayName: 'NodeSchemaCtx<tableRow>',
+  group: 'Table',
+})
+
 /// Schema for table cell node.
 export const tableCellSchema = $nodeSchema('table_cell', () => ({
   ...originalSchema.table_cell,
@@ -109,6 +129,16 @@ export const tableCellSchema = $nodeSchema('table_cell', () => ({
   },
 }))
 
+withMeta(tableCellSchema.node, {
+  displayName: 'NodeSchema<tableCell>',
+  group: 'Table',
+})
+
+withMeta(tableCellSchema.ctx, {
+  displayName: 'NodeSchemaCtx<tableCell>',
+  group: 'Table',
+})
+
 /// Schema for table header node.
 export const tableHeaderSchema = $nodeSchema('table_header', () => ({
   ...originalSchema.table_header,
@@ -133,6 +163,16 @@ export const tableHeaderSchema = $nodeSchema('table_header', () => ({
   },
 }))
 
+withMeta(tableHeaderSchema.node, {
+  displayName: 'NodeSchema<tableHeader>',
+  group: 'Table',
+})
+
+withMeta(tableHeaderSchema.ctx, {
+  displayName: 'NodeSchemaCtx<tableHeader>',
+  group: 'Table',
+})
+
 /// A input rule for creating table.
 /// For example, `|2x2|` will create a 2x2 table.
 export const insertTableInputRule = $inputRule(() => new InputRule(
@@ -150,12 +190,27 @@ export const insertTableInputRule = $inputRule(() => new InputRule(
   },
 ))
 
+withMeta(insertTableInputRule, {
+  displayName: 'InputRule<insertTableInputRule>',
+  group: 'Table',
+})
+
 /// A command for moving cursor to previous cell.
 export const goToPrevTableCellCommand = $command('GoToPrevTableCell', () => () => goToNextCell(-1))
 
+withMeta(goToPrevTableCellCommand, {
+  displayName: 'Command<goToPrevTableCellCommand>',
+  group: 'Table',
+})
+
 /// A command for moving cursor to next cell.
 export const goToNextTableCellCommand = $command('GoToNextTableCell', () => () => goToNextCell(1))
 
+withMeta(goToNextTableCellCommand, {
+  displayName: 'Command<goToNextTableCellCommand>',
+  group: 'Table',
+})
+
 /// A command for splitting current table into two tables.
 /// If the selection is at the end of the table,
 /// it will just quit the table and insert a new paragraph node.
@@ -173,6 +228,11 @@ export const breakTableCommand = $command('BreakTable', () => () => (state, disp
   return true
 })
 
+withMeta(breakTableCommand, {
+  displayName: 'Command<breakTableCommand>',
+  group: 'Table',
+})
+
 /// A command for inserting a table.
 /// You can specify the number of rows and columns.
 /// By default, it will insert a 3x3 table.
@@ -188,6 +248,11 @@ export const insertTableCommand = $command('InsertTable', () => ({ row, col }: {
   return true
 })
 
+withMeta(insertTableCommand, {
+  displayName: 'Command<insertTableCommand>',
+  group: 'Table',
+})
+
 /// A command for moving a row in a table.
 /// You should specify the `from` and `to` index.
 export const moveRowCommand = $command('MoveRow', () => ({ from, to }: { from?: number; to?: number } = {}) => (state, dispatch) => {
@@ -197,6 +262,11 @@ export const moveRowCommand = $command('MoveRow', () => ({ from, to }: { from?:
   return Boolean(result)
 })
 
+withMeta(moveRowCommand, {
+  displayName: 'Command<moveRowCommand>',
+  group: 'Table',
+})
+
 /// A command for moving a column in a table.
 /// You should specify the `from` and `to` index.
 export const moveColCommand = $command('MoveCol', () => ({ from, to }: { from?: number; to?: number } = {}) => (state, dispatch) => {
@@ -206,6 +276,11 @@ export const moveColCommand = $command('MoveCol', () => ({ from, to }: { from?:
   return Boolean(result)
 })
 
+withMeta(moveColCommand, {
+  displayName: 'Command<moveColCommand>',
+  group: 'Table',
+})
+
 /// A command for selecting a row.
 export const selectRowCommand = $command<number, 'SelectRow'>('SelectRow', () => (index = 0) => (state, dispatch) => {
   const { tr } = state
@@ -214,6 +289,11 @@ export const selectRowCommand = $command<number, 'SelectRow'>('SelectRow', () =>
   return Boolean(result)
 })
 
+withMeta(selectRowCommand, {
+  displayName: 'Command<selectRowCommand>',
+  group: 'Table',
+})
+
 /// A command for selecting a column.
 export const selectColCommand = $command<number, 'SelectCol'>('SelectCol', () => (index = 0) => (state, dispatch) => {
   const { tr } = state
@@ -222,6 +302,11 @@ export const selectColCommand = $command<number, 'SelectCol'>('SelectCol', () =>
   return Boolean(result)
 })
 
+withMeta(selectColCommand, {
+  displayName: 'Command<selectColCommand>',
+  group: 'Table',
+})
+
 /// A command for selecting a table.
 export const selectTableCommand = $command('SelectTable', () => () => (state, dispatch) => {
   const { tr } = state
@@ -230,6 +315,11 @@ export const selectTableCommand = $command('SelectTable', () => () => (state, di
   return Boolean(result)
 })
 
+withMeta(selectTableCommand, {
+  displayName: 'Command<selectTableCommand>',
+  group: 'Table',
+})
+
 /// A command for deleting selected cells.
 /// If the selection is a row or column, the row or column will be deleted.
 /// If all cells are selected, the table will be deleted.
@@ -251,12 +341,27 @@ export const deleteSelectedCellsCommand = $command('DeleteSelectedCells', () =>
     return deleteRow(state, dispatch)
 })
 
+withMeta(deleteSelectedCellsCommand, {
+  displayName: 'Command<deleteSelectedCellsCommand>',
+  group: 'Table',
+})
+
 /// A command for adding a column before the current column.
 export const addColBeforeCommand = $command('AddColBefore', () => () => addColumnBefore)
 
+withMeta(addColBeforeCommand, {
+  displayName: 'Command<addColBeforeCommand>',
+  group: 'Table',
+})
+
 /// A command for adding a column after the current column.
 export const addColAfterCommand = $command('AddColAfter', () => () => addColumnAfter)
 
+withMeta(addColAfterCommand, {
+  displayName: 'Command<addColAfterCommand>',
+  group: 'Table',
+})
+
 /// A command for adding a row before the current row.
 export const addRowBeforeCommand = $command('AddRowBefore', () => () => (state, dispatch) => {
   if (!isInTable(state))
@@ -268,6 +373,11 @@ export const addRowBeforeCommand = $command('AddRowBefore', () => () => (state,
   return true
 })
 
+withMeta(addRowBeforeCommand, {
+  displayName: 'Command<addRowBeforeCommand>',
+  group: 'Table',
+})
+
 /// A command for adding a row after the current row.
 export const addRowAfterCommand = $command('AddRowAfter', () => () => (state, dispatch) => {
   if (!isInTable(state))
@@ -279,11 +389,21 @@ export const addRowAfterCommand = $command('AddRowAfter', () => () => (state, di
   return true
 })
 
+withMeta(addRowAfterCommand, {
+  displayName: 'Command<addRowAfterCommand>',
+  group: 'Table',
+})
+
 /// A command for setting alignment property for selected cells.
 /// You can specify the alignment as `left`, `center`, or `right`.
 /// It's `left` by default.
 export const setAlignCommand = $command<'left' | 'center' | 'right', 'SetAlign'>('SetAlign', () => (alignment = 'left') => setCellAttr('alignment', alignment))
 
+withMeta(setAlignCommand, {
+  displayName: 'Command<setAlignCommand>',
+  group: 'Table',
+})
+
 /// Keymap for table commands.
 /// - `<Mod-]>`/`<Tab>`: Move to the next cell.
 /// - `<Mod-[>`/`<Shift-Tab>`: Move to the previous cell.
@@ -315,4 +435,14 @@ export const tableKeymap = $useKeymap('tableKeymap', {
   },
 })
 
+withMeta(tableKeymap.ctx, {
+  displayName: 'KeymapCtx<table>',
+  group: 'Table',
+})
+
+withMeta(tableKeymap.shortcuts, {
+  displayName: 'Keymap<table>',
+  group: 'Table',
+})
+
 export * from './utils'

package/src/node/task-list-item.ts

@@ -3,6 +3,7 @@ import { expectDomTypeError } from '@milkdown/exception'
 import { listItemSchema } from '@milkdown/preset-commonmark'
 import { InputRule } from '@milkdown/prose/inputrules'
 import { $inputRule } from '@milkdown/utils'
+import { withMeta } from '../__internal__'
 
 /// This schema extends the [list item](/preset-commonmark#list-item) schema and add task list support for it.
 export const extendListItemSchemaForTask = listItemSchema.extendSchema((prev) => {
@@ -89,6 +90,11 @@ export const extendListItemSchemaForTask = listItemSchema.extendSchema((prev) =>
   }
 })
 
+withMeta(extendListItemSchemaForTask, {
+  displayName: 'NodeSchema<listItem>',
+  group: 'ListItem',
+})
+
 /// Input rule for wrapping a block in task list node.
 /// Users can type `[ ] ` or `[x] ` to wrap the block in task list node with checked status.
 export const wrapInTaskListInputRule = $inputRule(() => {
@@ -115,3 +121,8 @@ export const wrapInTaskListInputRule = $inputRule(() => {
     return tr
   })
 })
+
+withMeta(wrapInTaskListInputRule, {
+  displayName: 'InputRule<wrapInTaskListInputRule>',
+  group: 'ListItem',
+})

package/src/plugin/auto-insert-zero-space-plugin.ts

@@ -5,6 +5,7 @@ import { isInTable } from '@milkdown/prose/tables'
 import { Plugin, PluginKey } from '@milkdown/prose/state'
 import { paragraphSchema } from '@milkdown/preset-commonmark'
 import { $prose } from '@milkdown/utils'
+import { withMeta } from '../__internal__'
 
 /// This plugin is used to fix the bug of IME composing in table in Safari browser.
 /// original discussion in https://discuss.prosemirror.net/t/ime-composing-problems-on-td-or-th-element-in-safari-browser/4501
@@ -48,3 +49,8 @@ export const autoInsertZeroSpaceInTablePlugin = $prose(() => {
     },
   })
 })
+
+withMeta(autoInsertZeroSpaceInTablePlugin, {
+  displayName: 'Prose<autoInsertZeroSpaceInTablePlugin>',
+  group: 'Prose',
+})

package/src/plugin/column-resizing-plugin.ts

@@ -1,6 +1,12 @@
 /* Copyright 2021, Milkdown by Mirone. */
 import { columnResizing } from '@milkdown/prose/tables'
 import { $prose } from '@milkdown/utils'
+import { withMeta } from '../__internal__'
 
 /// This plugin is wrapping the `columnResizing` plugin from [prosemirror-tables](https://github.com/ProseMirror/prosemirror-tables).
 export const columnResizingPlugin = $prose(() => columnResizing({}))
+
+withMeta(columnResizingPlugin, {
+  displayName: 'Prose<columnResizingPlugin>',
+  group: 'Prose',
+})

package/src/plugin/remark-gfm-plugin.ts

@@ -1,6 +1,12 @@
 /* Copyright 2021, Milkdown by Mirone. */
 import { $remark } from '@milkdown/utils'
 import remarkGFM from 'remark-gfm'
+import { withMeta } from '../__internal__'
 
 /// This plugin is wrapping the [remark-gfm](https://github.com/remarkjs/remark-gfm).
 export const remarkGFMPlugin = $remark(() => remarkGFM)
+
+withMeta(remarkGFMPlugin, {
+  displayName: 'Remark<remarkGFMPlugin>',
+  group: 'Remark',
+})

package/src/plugin/table-editing-plugin.ts

@@ -1,6 +1,12 @@
 /* Copyright 2021, Milkdown by Mirone. */
 import { tableEditing } from '@milkdown/prose/tables'
 import { $prose } from '@milkdown/utils'
+import { withMeta } from '../__internal__'
 
 /// This plugin is wrapping the `tableEditing` plugin from [prosemirror-tables](https://github.com/ProseMirror/prosemirror-tables).
 export const tableEditingPlugin = $prose(() => tableEditing())
+
+withMeta(tableEditingPlugin, {
+  displayName: 'Prose<tableEditingPlugin>',
+  group: 'Prose',
+})