@dxos/react-ui-editor 0.3.11-main.cc2fe2c → 0.3.11-main.ccc0ca3

package/src/extensions/automerge/update-codemirror.ts

@@ -16,7 +16,7 @@ import {
   type SpliceTextPatch,
 } from '@dxos/automerge/automerge';
 
-import { reconcileAnnotationType } from './defs';
+import { reconcileAnnotation } from './defs';
 
 export const updateCodeMirror = (view: EditorView, selection: EditorSelection, target: Prop[], patches: Patch[]) => {
   for (const patch of patches) {
@@ -26,14 +26,14 @@ export const updateCodeMirror = (view: EditorView, selection: EditorSelection, t
       selection = selection.map(changeSet, 1);
       view.dispatch({
         changes: changeSet,
-        annotations: reconcileAnnotationType.of({}),
+        annotations: reconcileAnnotation.of(false),
       });
     }
   }
 
   view.dispatch({
     selection,
-    annotations: reconcileAnnotationType.of({}),
+    annotations: reconcileAnnotation.of(false),
   });
 };
 
@@ -57,7 +57,7 @@ const handleInsert = (target: Prop[], patch: InsertPatch): Array<ChangeSpec> =>
     return [];
   }
 
-  const text = patch.values.map((v) => (v ? v.toString() : '')).join('');
+  const text = patch.values.map((value) => (value ? value.toString() : '')).join('');
   return [{ from: index, to: index, insert: text }];
 };
 
@@ -88,7 +88,7 @@ const handlePut = (target: Prop[], patch: PutPatch, state: EditorState): Array<C
 
   const length = state.doc.length;
   if (typeof patch.value !== 'string') {
-    return []; // TODO(dmaretskyi): How to handle non string values?
+    return []; // TODO(dmaretskyi): How to handle non-string values?
   }
 
   return [{ from: 0, to: length, insert: patch.value as any }];

package/src/extensions/awareness.ts

@@ -38,7 +38,7 @@ const dummyProvider: AwarenessProvider = {
   update: () => {},
 };
 
-export const AwarenessProvider = Facet.define<AwarenessProvider, AwarenessProvider>({
+export const awarenessProvider = Facet.define<AwarenessProvider, AwarenessProvider>({
   combine: (providers) => providers[0] ?? dummyProvider,
 });
 
@@ -68,7 +68,7 @@ export type AwarenessState = {
  */
 export const awareness = (provider = dummyProvider): Extension => {
   return [
-    AwarenessProvider.of(provider),
+    awarenessProvider.of(provider),
     ViewPlugin.fromClass(RemoteSelectionsDecorator, {
       decorations: (value) => value.decorations,
     }),
@@ -91,7 +91,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
 
   constructor(view: EditorView) {
     this._cursorConverter = view.state.facet(Cursor.converter);
-    this._provider = view.state.facet(AwarenessProvider);
+    this._provider = view.state.facet(awarenessProvider);
     this._provider.open();
     this._provider.remoteStateChange.on(this._ctx, () => {
       view.dispatch({ annotations: [RemoteSelectionChangedAnnotation.of([])] });

package/src/extensions/basic.ts

@@ -10,6 +10,7 @@ import { oneDarkHighlightStyle } from '@codemirror/theme-one-dark';
 import { drawSelection, EditorView, highlightActiveLine, placeholder } from '@codemirror/view';
 
 import { type ThemeMode } from '@dxos/react-ui';
+import { isNotFalsy } from '@dxos/util';
 
 import { type TextEditorProps } from '../components';
 
@@ -17,21 +18,22 @@ export type BasicBundleOptions = {
   themeMode?: ThemeMode;
 } & Pick<TextEditorProps, 'placeholder' | 'lineWrapping'>;
 
-export const basicBundle = ({
+export const createBasicBundle = ({
   themeMode,
   placeholder: _placeholder,
   lineWrapping = true,
-}: BasicBundleOptions): Extension[] => [
-  lineWrapping ? EditorView.lineWrapping : [],
+}: BasicBundleOptions = {}): Extension[] =>
+  [
+    lineWrapping && EditorView.lineWrapping,
 
-  // https://codemirror.net/docs/ref/#codemirror.minimalSetup
-  bracketMatching(),
-  closeBrackets(),
-  drawSelection(),
-  highlightActiveLine(),
-  history(),
-  _placeholder ? placeholder(_placeholder) : [],
+    // https://codemirror.net/docs/ref/#codemirror.minimalSetup
+    bracketMatching(),
+    closeBrackets(),
+    drawSelection(),
+    highlightActiveLine(),
+    history(),
+    _placeholder && placeholder(_placeholder),
 
-  // https://github.com/codemirror/theme-one-dark
-  themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
-];
+    // https://github.com/codemirror/theme-one-dark
+    themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
+  ].filter(isNotFalsy);

package/src/extensions/comments.ts

@@ -2,13 +2,13 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type Extension, StateEffect, StateField, type Text } from '@codemirror/state';
+import { invertedEffects } from '@codemirror/commands';
+import { type Extension, Facet, StateEffect, StateField, type Text, type ChangeDesc } from '@codemirror/state';
 import { hoverTooltip, keymap, type Command, Decoration, EditorView, type Rect } from '@codemirror/view';
 import sortBy from 'lodash.sortby';
 import { useEffect } from 'react';
 
 import { debounce } from '@dxos/async';
-import { invariant } from '@dxos/invariant';
 import { nonNullable } from '@dxos/util';
 
 import { Cursor } from './cursor';
@@ -26,10 +26,8 @@ const styles = EditorView.baseTheme({
   },
 });
 
-const marks = {
-  highlight: Decoration.mark({ class: 'cm-comment' }),
-  highlightActive: Decoration.mark({ class: 'cm-comment-current' }),
-};
+const commentMark = Decoration.mark({ class: 'cm-comment' });
+const commentCurrentMark = Decoration.mark({ class: 'cm-comment-current' });
 
 type CommentState = {
   comment: Comment;
@@ -47,7 +45,7 @@ export type CommentsState = {
   selection: SelectionState;
 };
 
-export const setFocus = (view: EditorView, id: string, center = true) => {
+export const focusComment = (view: EditorView, id: string, center = true) => {
   const comment = view.state.field(commentsState).comments.find((range) => range.comment.id === id);
   if (!comment?.comment.cursor) {
     return;
@@ -115,7 +113,7 @@ const commentsState = StateField.define<CommentsState>({
 /**
  * Decorate ranges.
  */
-const highlightDecorations = EditorView.decorations.compute([commentsState], (state) => {
+const commentsDecorations = EditorView.decorations.compute([commentsState], (state) => {
   const {
     selection: { current },
     comments,
@@ -130,9 +128,9 @@ const highlightDecorations = EditorView.decorations.compute([commentsState], (st
       }
 
       if (comment.comment.id === current) {
-        return marks.highlightActive.range(range.from, range.to);
+        return commentCurrentMark.range(range.from, range.to);
       } else {
-        return marks.highlight.range(range.from, range.to);
+        return commentMark.range(range.from, range.to);
       }
     })
     .filter(nonNullable);
@@ -167,11 +165,11 @@ export type CommentsOptions = {
   onHover?: (el: Element, shortcut: string) => void;
 };
 
-// TODO(burdon): Handle cut/restore via undo (need to integrate with history?)
+type TrackedComment = { id: string; from: number; to: number };
+
 const trackPastedComments = (onUpdate: NonNullable<CommentsOptions['onUpdate']>) => {
   // Tracks indexed selections within text.
-  // TODO(burdon): Move to main state field?
-  let tracked: { text: Text; comments: { id: string; from: number; to: number }[] } | null = null;
+  let tracked: { text: Text; comments: TrackedComment[] } | null = null;
 
   // Track cut or copy (enables cut-and-paste and copy-delete-paste to restore comment selection).
   const handleTrack = (event: Event, view: EditorView) => {
@@ -201,16 +199,48 @@ const trackPastedComments = (onUpdate: NonNullable<CommentsOptions['onUpdate']>)
       copy: handleTrack,
     }),
 
-    // Handle paste.
-    EditorView.updateListener.of(({ view, state, transactions }) => {
+    // Track deleted comments.
+    invertedEffects.of((tr) => {
+      const { comments } = tr.startState.field(commentsState);
+      const effects: StateEffect<any>[] = [];
+      tr.changes.iterChangedRanges((fromA, toA) => {
+        for (const {
+          comment: { id },
+          range: { from, to },
+        } of comments) {
+          if (from < to && from >= fromA && to <= toA) {
+            effects.push(restoreCommentEffect.of({ id, from, to }));
+          }
+        }
+      });
+
+      return effects;
+    }),
+
+    // Handle paste or the undo of comment deletion.
+    EditorView.updateListener.of((update) => {
+      const restore: TrackedComment[] = [];
+
+      for (let i = 0; i < update.transactions.length; i++) {
+        const tr = update.transactions[i];
+        for (let j = 0; j < restore.length; j++) {
+          restore[j] = mapTrackedComment(restore[j], tr.changes);
+        }
+        for (const effect of tr.effects) {
+          if (effect.is(restoreCommentEffect)) {
+            restore.push(effect.value);
+          }
+        }
+      }
+
       if (tracked) {
-        const paste = transactions.find((tr) => tr.isUserEvent('input.paste'));
+        const paste = update.transactions.find((tr) => tr.isUserEvent('input.paste'));
         if (paste) {
           let found = -1;
           paste.changes.iterChanges((fromA, toA, fromB, toB, text) => {
             if (text.eq(tracked!.text)) {
-              for (let i = transactions.indexOf(paste!) + 1; i < transactions.length; i++) {
-                fromB = transactions[i].changes.mapPos(fromB);
+              for (let i = update.transactions.indexOf(paste!) + 1; i < update.transactions.length; i++) {
+                fromB = update.transactions[i].changes.mapPos(fromB);
               }
 
               found = fromB;
@@ -219,23 +249,78 @@ const trackPastedComments = (onUpdate: NonNullable<CommentsOptions['onUpdate']>)
 
           if (found > -1) {
             for (const moved of tracked.comments) {
-              const range = {
-                from: found + moved.from,
-                to: found + moved.to,
-              };
-
-              const cursor = Cursor.getCursorFromRange(state, range);
-              onUpdate(moved.id, cursor);
+              restore.push({ id: moved.id, from: found + moved.from, to: found + moved.to });
             }
           }
 
           tracked = null;
         }
       }
+
+      for (const comment of restore) {
+        const { comments } = update.startState.field(commentsState);
+        const exists = comments.some((c) => c.comment.id === comment.id && c.range.from < c.range.to);
+        if (!exists) {
+          const cursor = Cursor.getCursorFromRange(update.state, comment);
+          onUpdate(comment.id, cursor);
+        }
+      }
     }),
   ];
 };
 
+const mapTrackedComment = (comment: TrackedComment, changes: ChangeDesc) => ({
+  id: comment.id,
+  from: changes.mapPos(comment.from, 1),
+  to: changes.mapPos(comment.to, 1),
+});
+
+// These are attached to undone/redone transactions in the editor for the purpose of restoring comments
+// that were deleted by the original changes.
+const restoreCommentEffect = StateEffect.define<TrackedComment>({ map: mapTrackedComment });
+
+const optionsFacet = Facet.define<CommentsOptions, CommentsOptions>({
+  combine: (providers) => providers[0],
+});
+
+/**
+ * Create comment thread action.
+ */
+export const createComment: Command = (view) => {
+  const options = view.state.facet(optionsFacet);
+  const { from, to } = view.state.selection.main;
+  if (from === to) {
+    return false;
+  }
+
+  // Don't allow selection at end of document.
+  if (to === view.state.doc.length) {
+    view.dispatch({
+      changes: {
+        from: to,
+        insert: '\n',
+      },
+    });
+  }
+
+  const cursor = Cursor.getCursorFromRange(view.state, { from, to });
+  if (cursor) {
+    // Create thread via callback.
+    const id = options.onCreate?.(cursor, view.coordsAtPos(from));
+    if (id) {
+      // Update range.
+      view.dispatch({
+        effects: setSelection.of({ current: id }),
+        selection: { anchor: to },
+      });
+
+      return true;
+    }
+  }
+
+  return false;
+};
+
 /**
  * Comment threads.
  * 1). Updates the EditorModel to store relative selections for a set of comments threads.
@@ -252,47 +337,10 @@ export const comments = (options: CommentsOptions = {}): Extension => {
 
   const handleSelect = debounce((state: CommentsState) => options.onSelect?.(state), 200);
 
-  /**
-   * Create comment thread action.
-   */
-  const createCommentThread: Command = (view) => {
-    invariant(options.onCreate);
-    const { from, to } = view.state.selection.main;
-    if (from === to) {
-      return false;
-    }
-
-    // Don't allow selection at end of document.
-    if (to === view.state.doc.length) {
-      view.dispatch({
-        changes: {
-          from: to,
-          insert: '\n',
-        },
-      });
-    }
-
-    const cursor = Cursor.getCursorFromRange(view.state, { from, to });
-    if (cursor) {
-      // Create thread via callback.
-      const id = options.onCreate?.(cursor, view.coordsAtPos(from));
-      if (id) {
-        // Update range.
-        view.dispatch({
-          effects: setSelection.of({ current: id }),
-          selection: { anchor: from },
-        });
-
-        return true;
-      }
-    }
-
-    return false;
-  };
-
   return [
+    optionsFacet.of(options),
     commentsState,
-    highlightDecorations,
+    commentsDecorations,
     styles,
 
     //
@@ -302,7 +350,7 @@ export const comments = (options: CommentsOptions = {}): Extension => {
       ? keymap.of([
           {
             key: shortcut,
-            run: callbackWrapper(createCommentThread),
+            run: callbackWrapper(createComment),
           },
         ])
       : [],

package/src/extensions/markdown/bundle.ts

@@ -21,13 +21,14 @@ import {
 } from '@codemirror/view';
 
 import type { ThemeMode } from '@dxos/react-ui';
+import { isNotFalsy } from '@dxos/util';
 
 import { markdownHighlightStyle, markdownTagsExtensions } from './highlight';
 import { type TextEditorProps } from '../../components';
 
 export type MarkdownBundleOptions = {
   themeMode?: ThemeMode;
-} & Pick<TextEditorProps, 'placeholder'>;
+} & Pick<TextEditorProps, 'placeholder' | 'lineWrapping'>;
 
 /**
  * Markdown bundle.
@@ -36,11 +37,15 @@ export type MarkdownBundleOptions = {
  * https://codemirror.net/docs/ref/#codemirror.basicSetup
  */
 // TODO(burdon): Add Composer here: https://codemirror.net/docs/community
-export const markdownBundle = ({ themeMode, placeholder: _placeholder }: MarkdownBundleOptions): Extension[] => {
+export const createMarkdownExtensions = ({
+  themeMode,
+  placeholder: _placeholder,
+  lineWrapping = true,
+}: MarkdownBundleOptions = {}): Extension[] => {
   return [
+    lineWrapping && EditorView.lineWrapping,
     EditorState.allowMultipleSelections.of(true),
     EditorState.tabSize.of(2),
-    EditorView.lineWrapping,
 
     // https://github.com/codemirror/basic-setup
     bracketMatching(),
@@ -51,7 +56,7 @@ export const markdownBundle = ({ themeMode, placeholder: _placeholder }: Markdow
     highlightActiveLine(),
     history(),
     indentOnInput(),
-    _placeholder ? placeholder(_placeholder) : [],
+    _placeholder && placeholder(_placeholder),
 
     // Main extension.
     // https://github.com/codemirror/lang-markdown
@@ -92,5 +97,5 @@ export const markdownBundle = ({ themeMode, placeholder: _placeholder }: Markdow
       // https://codemirror.net/docs/ref/#commands.standardKeymap
       ...standardKeymap,
     ]),
-  ];
+  ].filter(isNotFalsy);
 };

package/src/extensions/markdown/code.ts

@@ -19,7 +19,6 @@ import { mx } from '@dxos/react-ui-theme';
 import { getToken } from '../../styles';
 
 // TODO(burdon): Reconcile with theme.
-// [aria-readonly="true"]
 const styles = EditorView.baseTheme({
   '& .cm-code': {
     paddingInline: '1rem !important',
@@ -28,20 +27,36 @@ const styles = EditorView.baseTheme({
   '& .cm-codeblock': {
     display: 'inline-block',
     width: '100%',
+    position: 'relative',
+    '&::after': {
+      content: '""',
+      position: 'absolute',
+      inset: 0,
+    },
   },
-  '&light .cm-codeblock, &light .cm-codeblock.cm-activeLine': {
-    background: getToken('extend.colors.neutral.25'),
+  '&light .cm-codeblock': {
+    '&::after': {
+      background: getToken('extend.semanticColors.input.light'),
+      mixBlendMode: 'darken',
+    },
   },
-  '&dark .cm-codeblock, &dark .cm-codeblock.cm-activeLine': {
-    background: getToken('extend.colors.neutral.850'),
+  '&dark .cm-codeblock': {
+    '&::after': {
+      background: getToken('extend.semanticColors.input.dark'),
+      mixBlendMode: 'lighten',
+    },
   },
   '& .cm-codeblock-first': {
-    borderTopLeftRadius: '.5rem',
-    borderTopRightRadius: '.5rem',
+    '&::after': {
+      borderTopLeftRadius: '.5rem',
+      borderTopRightRadius: '.5rem',
+    },
   },
   '& .cm-codeblock-last': {
-    borderBottomLeftRadius: '.5rem',
-    borderBottomRightRadius: '.5rem',
+    '&::after': {
+      borderBottomLeftRadius: '.5rem',
+      borderBottomRightRadius: '.5rem',
+    },
   },
 });
 

package/src/extensions/markdown/formatting.ts

@@ -0,0 +1,188 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { snippet } from '@codemirror/autocomplete';
+import { syntaxTree } from '@codemirror/language';
+import { type Extension, RangeSetBuilder } from '@codemirror/state';
+import {
+  type Command,
+  Decoration,
+  type DecorationSet,
+  type EditorView,
+  keymap,
+  ViewPlugin,
+  type ViewUpdate,
+} from '@codemirror/view';
+import { type SyntaxNodeRef, type SyntaxNode } from '@lezer/common';
+
+export type FormattingOptions = {};
+
+export const setHeading =
+  (level: number): Command =>
+  (view: EditorView) => {
+    const {
+      selection: { ranges },
+      doc,
+    } = view.state;
+    const changes = [];
+    for (const range of ranges) {
+      const { number } = doc.lineAt(range.anchor);
+      const { from, to } = doc.line(number);
+
+      // Check heading doesn't already exist.
+      const line = doc.sliceString(from, to);
+      const [_, marks, spaces] = line.match(/(#+)(\s+)/) ?? [];
+      const current = marks?.length ?? 0;
+      if (level !== current) {
+        changes.push({
+          from,
+          to: from + current + (spaces?.length ?? 0),
+          insert: '#'.repeat(level) + (level > 0 ? ' ' : ''),
+        });
+      }
+    }
+
+    if (changes.length) {
+      view.dispatch({ changes });
+    }
+
+    return true;
+  };
+
+export const toggleStyle =
+  (mark: string): Command =>
+  (view) => {
+    const { ranges } = view.state.selection;
+    for (const range of ranges) {
+      if (range.from === range.to) {
+        return false;
+      }
+
+      // TODO(burdon): Detect if already styled (or nested).
+      view.dispatch({
+        changes: [
+          {
+            from: range.from,
+            insert: mark,
+          },
+          {
+            from: range.to,
+            insert: mark,
+          },
+        ],
+      });
+    }
+
+    return true;
+  };
+
+// TODO(burdon): Define and trigger snippets for codeblock, table, etc.
+const snippets = {
+  codeblock: snippet(['```#{lang}', '\t#{}', '```'].join('\n')),
+  table: snippet(
+    ['| #{col1} | #{col2} |', '| ---- | ---- |', '| #{val1} | #{val2} |', '| #{val3} | #{val4} |'].join('\n'),
+  ),
+};
+
+export const insertCodeblock = (view: EditorView) => {
+  const {
+    selection: { main },
+    doc,
+  } = view.state;
+  const { number } = doc.lineAt(main.anchor);
+  const { from } = doc.line(number);
+  snippets.codeblock(view, null, from, from);
+};
+
+export const insertTable = (view: EditorView) => {
+  const {
+    selection: { main },
+    doc,
+  } = view.state;
+  const { number } = doc.lineAt(main.anchor);
+  const { from } = doc.line(number);
+  snippets.table(view, null, from, from);
+};
+
+export const toggleBold = toggleStyle('**');
+export const toggleItalic = toggleStyle('_');
+export const toggleStrikethrough = toggleStyle('~~');
+
+export const toggleList = (view: EditorView) => {};
+
+export const formatting = (options: FormattingOptions = {}): Extension => {
+  return [
+    keymap.of([
+      {
+        key: 'meta-b',
+        run: toggleBold,
+      },
+    ]),
+    styling(),
+  ];
+};
+
+// https://github.github.com/gfm
+// https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
+const styling = (): Extension => {
+  const buildDecorations = (view: EditorView): DecorationSet => {
+    const builder = new RangeSetBuilder<Decoration>();
+    const { state } = view;
+    const cursor = state.selection.main.head;
+
+    // TODO(burdon): Bug if '***foo***' (since StrongEmphasis is nested inside EmphasisMark).
+    //  Ranges must be added sorted by `from` position and `startSide`.
+    const replace = (node: SyntaxNodeRef, marks: SyntaxNode[]) => {
+      if (cursor <= node.from || cursor >= node.to) {
+        for (const mark of marks) {
+          builder.add(mark.from, mark.to, Decoration.replace({}));
+        }
+      }
+    };
+
+    for (const { from, to } of view.visibleRanges) {
+      syntaxTree(state).iterate({
+        enter: (node) => {
+          switch (node.name) {
+            case 'Emphasis':
+            case 'StrongEmphasis': {
+              const marks = node.node.getChildren('EmphasisMark');
+              replace(node, marks);
+              break;
+            }
+
+            case 'Strikethrough': {
+              const marks = node.node.getChildren('StrikethroughMark');
+              replace(node, marks);
+              break;
+            }
+          }
+        },
+        from,
+        to,
+      });
+    }
+
+    return builder.finish();
+  };
+
+  return [
+    ViewPlugin.fromClass(
+      class {
+        decorations: DecorationSet;
+        constructor(view: EditorView) {
+          this.decorations = buildDecorations(view);
+        }
+
+        update(update: ViewUpdate) {
+          this.decorations = buildDecorations(update.view);
+        }
+      },
+      {
+        decorations: (value) => value.decorations,
+      },
+    ),
+  ];
+};

package/src/extensions/markdown/heading.ts

@@ -23,7 +23,7 @@ const buildDecorations = (view: EditorView): DecorationSet => {
           case 'ATXHeading6': {
             const mark = node.node.getChild('HeaderMark');
             if (mark) {
-              if (view.state.readOnly || cursor < node.from || cursor > node.to) {
+              if (!view.hasFocus || view.state.readOnly || cursor < node.from || cursor > node.to) {
                 builder.add(mark.from, mark.to + 1, Decoration.replace({}));
               }
             }

package/src/extensions/markdown/index.ts

@@ -4,6 +4,7 @@
 
 export * from './bundle';
 export * from './code';
+export * from './formatting';
 export * from './heading';
 export * from './highlight';
 export * from './hr';