@dxos/react-ui-editor 0.6.12 → 0.6.13-main.548ca8d

package/src/extensions/comments.ts

@@ -5,7 +5,6 @@
 import { invertedEffects } from '@codemirror/commands';
 import {
   type Extension,
-  Facet,
   StateEffect,
   StateField,
   type Text,
@@ -29,18 +28,15 @@ import { debounce, type UnsubscribeCallback } from '@dxos/async';
 import { log } from '@dxos/log';
 import { nonNullable } from '@dxos/util';
 
-import { Cursor } from './cursor';
-import { type Comment, type Range } from './types';
 import { overlap } from './util';
+import { Cursor, documentId, singleValueFacet } from '../state';
+import { type Comment, type Range } from '../state';
 import { callbackWrapper } from '../util';
 
 //
 // State management.
 //
 
-// TODO(wittjosiah): Factor out, not comments-specific.
-const documentId = Facet.define<string | undefined, string | undefined>({ combine: (values) => values[0] });
-
 type CommentState = {
   comment: Comment;
   range: Range;
@@ -369,7 +365,7 @@ export type CommentsOptions = {
   onHover?: (el: Element, shortcut: string) => void;
 };
 
-const optionsFacet = Facet.define<CommentsOptions, CommentsOptions>({ combine: (providers) => providers[0] });
+const optionsFacet = singleValueFacet<CommentsOptions>();
 
 /**
  * Comment threads.
@@ -389,7 +385,7 @@ export const comments = (options: CommentsOptions = {}): Extension => {
 
   return [
     optionsFacet.of(options),
-    documentId.of(options.id),
+    options.id ? documentId.of(options.id) : undefined,
     commentsState,
     commentsDecorations,
     handleCommentClick,
@@ -398,45 +394,43 @@ export const comments = (options: CommentsOptions = {}): Extension => {
     //
     // Keymap.
     //
-    options.onCreate
-      ? keymap.of([
-          {
-            key: shortcut,
-            run: callbackWrapper(createComment),
-          },
-        ])
-      : [],
+    options.onCreate &&
+      keymap.of([
+        {
+          key: shortcut,
+          run: callbackWrapper(createComment),
+        },
+      ]),
 
     //
     // Hover tooltip (for key shortcut hints, etc.)
     // TODO(burdon): Factor out to generic hints extension for current selection/line.
     //
-    options.onHover
-      ? hoverTooltip(
-          (view, pos) => {
-            const selection = view.state.selection.main;
-            if (selection && pos >= selection.from && pos <= selection.to) {
-              return {
-                pos: selection.from,
-                end: selection.to,
-                above: true,
-                create: () => {
-                  const el = document.createElement('div');
-                  options.onHover!(el, shortcut);
-                  return { dom: el, offset: { x: 0, y: 8 } };
-                },
-              };
-            }
+    options.onHover &&
+      hoverTooltip(
+        (view, pos) => {
+          const selection = view.state.selection.main;
+          if (selection && pos >= selection.from && pos <= selection.to) {
+            return {
+              pos: selection.from,
+              end: selection.to,
+              above: true,
+              create: () => {
+                const el = document.createElement('div');
+                options.onHover!(el, shortcut);
+                return { dom: el, offset: { x: 0, y: 8 } };
+              },
+            };
+          }
 
-            return null;
-          },
-          {
-            // TODO(burdon): Hide on change triggered immediately?
-            // hideOnChange: true,
-            hoverTime: 1_000,
-          },
-        )
-      : [],
+          return null;
+        },
+        {
+          // TODO(burdon): Hide on change triggered immediately?
+          // hideOnChange: true,
+          hoverTime: 1_000,
+        },
+      ),
 
     //
     // Track deleted ranges and update ranges for decorations.
@@ -511,8 +505,8 @@ export const comments = (options: CommentsOptions = {}): Extension => {
       }
     }),
 
-    options.onUpdate ? trackPastedComments(options.onUpdate) : [],
-  ];
+    options.onUpdate && trackPastedComments(options.onUpdate),
+  ].filter(nonNullable);
 };
 
 //
@@ -553,9 +547,13 @@ export const scrollThreadIntoView = (view: EditorView, id: string, center = true
  * Query the editor state for the active formatting at the selection.
  */
 export const selectionOverlapsComment = (state: EditorState): boolean => {
-  const { selection } = state;
-  const commentState = state.field(commentsState);
+  // May not be defined if thread plugin not installed.
+  const commentState = state.field(commentsState, false);
+  if (commentState === undefined) {
+    return false;
+  }
 
+  const { selection } = state;
   for (const range of selection.ranges) {
     if (commentState.comments.some(({ range: commentRange }) => overlap(commentRange, range))) {
       return true;
@@ -597,6 +595,7 @@ class ExternalCommentSync implements PluginValue {
   };
 }
 
+// TODO(burdon): Needs comment.
 export const createExternalCommentSync = (
   id: string,
   subscribe: (sink: () => void) => UnsubscribeCallback,

package/src/extensions/debug.ts

@@ -3,10 +3,10 @@
 //
 
 import { syntaxTree } from '@codemirror/language';
-import { type EditorState, type RangeSet, StateField, type Transaction } from '@codemirror/state';
+import { type EditorState, type Extension, type RangeSet, StateField, type Transaction } from '@codemirror/state';
 
 // eslint-disable-next-line no-console
-export const debugNodeLogger = (log: (...args: any[]) => void = console.log) => {
+export const debugNodeLogger = (log: (...args: any[]) => void = console.log): Extension => {
   const logTokens = (state: EditorState) => syntaxTree(state).iterate({ enter: (node) => log(node.type) });
   return StateField.define<any>({
     create: (state) => logTokens(state),

package/src/extensions/folding.tsx

@@ -17,7 +17,7 @@ export type FoldingOptions = {};
 /**
  * https://codemirror.net/examples/gutter
  */
-// TODO(burdon): Remember folding state.
+// TODO(burdon): Remember folding state (to state).
 export const folding = (_props: FoldingOptions = {}): Extension => [
   codeFolding({
     placeholderDOM: () => {
@@ -26,8 +26,10 @@ export const folding = (_props: FoldingOptions = {}): Extension => [
   }),
   foldGutter({
     markerDOM: (open) => {
+      // TODO(burdon): Use sprite directly.
+      const el = createElement('div', { className: 'flex h-full items-center' });
       return renderRoot(
-        createElement('div', { className: 'flex h-full items-center' }),
+        el,
         <Icon icon='ph--caret-right--regular' classNames={[getSize(3), 'mx-3 cursor-pointer', open && 'rotate-90']} />,
       );
     },

package/src/extensions/index.ts

@@ -9,9 +9,7 @@ export * from './awareness';
 export * from './blast';
 export * from './command';
 export * from './comments';
-export * from './cursor';
 export * from './debug';
-export * from './doc';
 export * from './dnd';
 export * from './factories';
 export * from './folding';
@@ -19,6 +17,4 @@ export * from './listener';
 export * from './markdown';
 export * from './mention';
 export * from './modes';
-export * from './state';
-export * from './types';
 export * from './typewriter';

package/src/extensions/listener.ts

@@ -12,6 +12,7 @@ export type ListenerOptions = {
 
 /**
  * Event listener.
+ * @deprecated Use EditorView.updateListener and listen for specific update events.
  */
 export const listener = ({ onFocus, onChange }: ListenerOptions): Extension => {
   const extensions: Extension[] = [];

package/src/extensions/markdown/changes.test.ts

@@ -2,9 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { expect } from 'chai';
-
-import { describe, test } from '@dxos/test';
+import { describe, expect, test } from 'vitest';
 
 import { createLinkLabel } from './changes';
 

package/src/extensions/markdown/decorate.ts

@@ -45,7 +45,7 @@ class HorizontalRuleWidget extends WidgetType {
 class LinkButton extends WidgetType {
   constructor(
     private readonly url: string,
-    private readonly render: (el: Element, url: string) => void,
+    private readonly render: (el: HTMLElement, url: string) => void,
   ) {
     super();
   }
@@ -54,6 +54,7 @@ class LinkButton extends WidgetType {
     return this.url === other.url;
   }
 
+  // TODO(burdon): Create icon and link directly without react?
   override toDOM(view: EditorView) {
     const el = document.createElement('span');
     this.render(el, this.url);
@@ -127,6 +128,7 @@ class TextWidget extends WidgetType {
 }
 
 const hide = Decoration.replace({});
+const blockQuote = Decoration.line({ class: mx('cm-blockquote') });
 const fencedCodeLine = Decoration.line({ class: mx('cm-code cm-codeblock-line') });
 const fencedCodeLineFirst = Decoration.line({ class: mx('cm-code cm-codeblock-line', 'cm-codeblock-first') });
 const fencedCodeLineLast = Decoration.line({ class: mx('cm-code cm-codeblock-line', 'cm-codeblock-last') });
@@ -199,7 +201,7 @@ const buildDecorations = (view: EditorView, options: DecorateOptions, focus: boo
     return listLevels[listLevels.length - 1];
   };
 
-  // const count = 0;
+  // let count = 0;
   const enterNode = (node: SyntaxNodeRef) => {
     // console.log(`[${count++}]`, { node: node.name, from: node.from, to: node.to });
     switch (node.name) {
@@ -329,7 +331,36 @@ const buildDecorations = (view: EditorView, options: DecorateOptions, focus: boo
         break;
       }
 
+      //
+      // Blockquote > QuoteMark > Paragraph
+      //
+
+      case 'Blockquote': {
+        const editing = editingRange(state, node, focus);
+        const quoteMark = node.node.getChild('QuoteMark');
+        const paragraph = node.node.getChild('Paragraph');
+        if (!editing && quoteMark && paragraph) {
+          atomicDeco.add(quoteMark.from, paragraph.from, hide);
+        }
+
+        for (const block of view.viewportLineBlocks) {
+          if (block.to < node.from) {
+            continue;
+          }
+          if (block.from > node.to) {
+            break;
+          }
+
+          deco.add(block.from, block.from, blockQuote);
+        }
+
+        break;
+      }
+
+      //
       // CommentBlock
+      //
+
       case 'CommentBlock': {
         const editing = editingRange(state, node, focus);
         for (const block of view.viewportLineBlocks) {
@@ -339,21 +370,27 @@ const buildDecorations = (view: EditorView, options: DecorateOptions, focus: boo
           if (block.from > node.to) {
             break;
           }
-          const first = block.from <= node.from;
-          const last = block.to >= node.to && /^(\s>)*-->$/.test(state.doc.sliceString(block.from, block.to));
+
+          const isFirst = block.from <= node.from;
+          const isLast = block.to >= node.to && /^(\s>)*-->$/.test(state.doc.sliceString(block.from, block.to));
+
           deco.add(
             block.from,
             block.from,
-            first ? commentBlockLineFirst : last ? commentBlockLineLast : commentBlockLine,
+            isFirst ? commentBlockLineFirst : isLast ? commentBlockLineLast : commentBlockLine,
           );
-          if (!editing && (first || last)) {
+
+          if (!editing && (isFirst || isLast)) {
             atomicDeco.add(block.from, block.to, hide);
           }
         }
         break;
       }
 
+      //
       // FencedCode > CodeMark > [CodeInfo] > CodeText > CodeMark
+      //
+
       case 'FencedCode': {
         for (const block of view.viewportLineBlocks) {
           if (block.to < node.from) {
@@ -375,7 +412,10 @@ const buildDecorations = (view: EditorView, options: DecorateOptions, focus: boo
         return false;
       }
 
+      //
       // Link > [LinkMark, URL]
+      //
+
       case 'Link': {
         const marks = node.node.getChildren('LinkMark');
         const urlNode = node.node.getChild('URL');
@@ -412,7 +452,10 @@ const buildDecorations = (view: EditorView, options: DecorateOptions, focus: boo
         break;
       }
 
+      //
       // HR
+      //
+
       case 'HorizontalRule': {
         if (!editingRange(state, node, focus)) {
           deco.add(node.from, node.to, horizontalRule);

package/src/extensions/markdown/formatting.test.ts

@@ -4,9 +4,7 @@
 
 import { markdownLanguage } from '@codemirror/lang-markdown';
 import { EditorState, type StateCommand } from '@codemirror/state';
-import { expect } from 'chai';
-
-import { describe, test } from '@dxos/test';
+import { describe, expect, test } from 'vitest';
 
 import {
   addBlockquote,

package/src/extensions/markdown/highlight.ts

@@ -168,11 +168,6 @@ export const markdownHighlightStyle = (_options: HighlightOptions = {}) => {
         class: theme.code,
       },
 
-      {
-        tag: [markdownTags.QuoteMark],
-        class: theme.blockquote,
-      },
-
       {
         tag: [markdownTags.TableCell],
         class: 'font-mono',

package/src/extensions/markdown/link.ts

@@ -9,8 +9,8 @@ import { type SyntaxNode } from '@lezer/common';
 
 import { tooltipContent } from '@dxos/react-ui-theme';
 
-export const linkTooltip = (render: (el: Element, url: string) => void) =>
-  hoverTooltip((view, pos, side) => {
+export const linkTooltip = (render: (el: HTMLElement, url: string) => void) => {
+  return hoverTooltip((view, pos, side) => {
     const syntax = syntaxTree(view.state).resolveInner(pos, side);
     let link = null;
     for (let i = 0, node: SyntaxNode | null = syntax; !link && node && i < 5; node = node.parent, i++) {
@@ -35,3 +35,4 @@ export const linkTooltip = (render: (el: Element, url: string) => void) =>
       },
     };
   });
+};

package/src/extensions/markdown/parser.test.ts

@@ -5,8 +5,7 @@
 // @ts-ignore
 import { testTree } from '@lezer/generator/test';
 import { parser } from '@lezer/markdown';
-
-import { describe, test } from '@dxos/test';
+import { describe, test } from 'vitest';
 
 describe('parser', () => {
   // test.only('list-mark', () => {

package/src/extensions/markdown/styles.ts

@@ -39,6 +39,16 @@ export const formattingStyles = EditorView.theme({
     width: `${orderedListIndentationWidth}px`,
   },
 
+  /**
+   * Blockquote.
+   */
+  '& .cm-blockquote': {
+    background: 'var(--dx-cmCodeblock)',
+    borderLeft: '2px solid var(--dx-cmSeparator)',
+    paddingLeft: '1rem',
+    margin: '0',
+  },
+
   /**
    * Code and codeblocks.
    */

package/src/extensions/markdown/table.ts

@@ -25,9 +25,9 @@ export type TableOptions = {};
  * https://github.github.com/gfm/#tables-extension
  */
 export const table = (options: TableOptions = {}): Extension => {
-  return StateField.define<RangeSet<any>>({
+  return StateField.define<RangeSet<Decoration>>({
     create: (state) => update(state, options),
-    update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, options),
+    update: (_: RangeSet<Decoration>, tr: Transaction) => update(tr.state, options),
     provide: (field) => EditorView.decorations.from(field),
   });
 };
@@ -40,7 +40,7 @@ type Table = {
 };
 
 const update = (state: EditorState, _options: TableOptions) => {
-  const builder = new RangeSetBuilder();
+  const builder = new RangeSetBuilder<Decoration>();
   const cursor = state.selection.main.head;
 
   const tables: Table[] = [];

package/src/extensions/modes.ts

@@ -2,26 +2,27 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type Extension, Facet } from '@codemirror/state';
+import { type Extension } from '@codemirror/state';
 import { keymap } from '@codemirror/view';
 import { vim } from '@replit/codemirror-vim';
 import { vscodeKeymap } from '@replit/codemirror-vscode-keymap';
 
+import { singleValueFacet } from '../state';
+
 export const focusEvent = 'focus.container';
 
 export const EditorViewModes = ['preview', 'readonly', 'source'] as const;
 export type EditorViewMode = (typeof EditorViewModes)[number];
+
 export const EditorInputModes = ['default', 'vim', 'vscode'] as const;
 export type EditorInputMode = (typeof EditorInputModes)[number];
 
 export type EditorInputConfig = {
-  type: string;
+  type?: string;
   noTabster?: boolean;
 };
 
-export const editorInputMode = Facet.define<EditorInputConfig, EditorInputConfig>({
-  combine: (modes) => modes[0] ?? {},
-});
+export const editorInputMode = singleValueFacet<EditorInputConfig>({});
 
 export const InputModeExtensions: { [mode: string]: Extension } = {
   default: [],

package/src/extensions/util/overlap.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type Range } from '../types';
+import { type Range } from '../../state';
 
 /**
  * Determines if two ranges overlap.

package/src/extensions/util/react.tsx

@@ -8,6 +8,8 @@ import { createRoot } from 'react-dom/client';
 import { ThemeProvider } from '@dxos/react-ui';
 import { defaultTx } from '@dxos/react-ui-theme';
 
+// TODO(burdon): Factor out.
+
 export type ElementOptions = {
   className?: string;
 };
@@ -23,7 +25,9 @@ export const createElement = (tag: string, options?: ElementOptions, children?:
   return el;
 };
 
-export const renderRoot = (root: HTMLElement, node: ReactNode): HTMLElement => {
+// TODO(burdon): Remove react rendering; use DOM directly.
+// NOTE: CM seems to remove/detach/overwrite portals that are attached to the DOM it control.s
+export const renderRoot = <T extends Element>(root: T, node: ReactNode): T => {
   createRoot(root).render(<ThemeProvider tx={defaultTx}>{node}</ThemeProvider>);
   return root;
 };

package/src/hooks/useTextEditor.ts

@@ -19,10 +19,12 @@ import {
 import { log } from '@dxos/log';
 import { getProviderValue, isNotFalsy, type MaybeProvider } from '@dxos/util';
 
-import { createEditorStateTransaction, documentId, editorInputMode, type EditorSelection } from '../extensions';
-import { logChanges } from '../util';
+import { editorInputMode } from '../extensions';
+import { type EditorSelection, documentId, createEditorStateTransaction } from '../state';
+import { debugDispatcher } from '../util';
 
 export type UseTextEditor = {
+  // TODO(burdon): Rename.
   parentRef: RefObject<HTMLDivElement>;
   view?: EditorView;
   focusAttributes: ReturnType<typeof useFocusableGroup> & {
@@ -65,8 +67,6 @@ export const useTextEditor = (
 
   // NOTE: Increments by 2 in strict mode.
   const [instanceId] = useState(() => `text-editor-${++instanceCount}`);
-  // Callback once view is created.
-  const onUpdate = useRef<() => void>();
   const [view, setView] = useState<EditorView>();
   const parentRef = useRef<HTMLDivElement>(null);
 
@@ -87,44 +87,45 @@ export const useTextEditor = (
       }
 
       // https://codemirror.net/docs/ref/#state.EditorStateConfig
-      // NOTE: Don't set selection here in case it is invalid (and crashes the state); dispatch below.
       const state = EditorState.create({
         doc: initialValue,
         selection: initialSelection,
         extensions: [
           id && documentId.of(id),
-          // NOTE: Doesn't catch errors in keymap functions.
+          extensions,
+          // NOTE: This doesn't catch errors in keymap functions.
           EditorView.exceptionSink.of((err) => {
             log.catch(err);
           }),
-          extensions,
-          EditorView.updateListener.of(() => {
-            setTimeout(() => {
-              onUpdate.current?.();
-            });
-          }),
+          // TODO(burdon): Factor out debug inspector.
+          // ViewPlugin.fromClass(
+          //   class {
+          //     constructor(_view: EditorView) {
+          //       log('construct', { id });
+          //     }
+          //
+          //     destroy() {
+          //       log('destroy', { id });
+          //     }
+          //   },
+          // ),
         ].filter(isNotFalsy),
       });
 
       // https://codemirror.net/docs/ref/#view.EditorViewConfig
       view = new EditorView({
         parent: parentRef.current,
-        selection: initialSelection,
         state,
-        // NOTE: Uncomment to debug/monitor all transactions.
-        // https://codemirror.net/docs/ref/#view.EditorView.dispatch
-        dispatchTransactions: (trs, view) => {
-          if (debug) {
-            logChanges(trs);
-          }
-          view.update(trs);
-        },
+        scrollTo: scrollTo ? EditorView.scrollIntoView(scrollTo, { yMargin: 96 }) : undefined,
+        dispatchTransactions: debug ? debugDispatcher : undefined,
       });
 
-      // Move to end of line after document loaded.
-      if (!initialValue && moveToEndOfLine) {
+      // Move to end of line after document loaded (unless selection is specified).
+      if (moveToEndOfLine && !initialSelection) {
         const { to } = view.state.doc.lineAt(0);
-        view.dispatch({ selection: { anchor: to } });
+        if (to) {
+          view.dispatch({ selection: { anchor: to } });
+        }
       }
 
       setView(view);
@@ -138,18 +139,16 @@ export const useTextEditor = (
 
   useEffect(() => {
     if (view) {
-      // NOTE: Set selection after first update (since content may rerender on focus).
-      onUpdate.current = () => {
-        onUpdate.current = undefined;
-        view.dispatch(createEditorStateTransaction({ scrollTo, selection }));
-      };
-
       // Remove tabster attribute (rely on custom keymap).
       if (view.state.facet(editorInputMode).noTabster) {
         parentRef.current?.removeAttribute('data-tabster');
       }
+
+      if (scrollTo || selection) {
+        view.dispatch(createEditorStateTransaction(view.state, { scrollTo, selection }));
+      }
     }
-  }, [view, selection, scrollTo]);
+  }, [view, scrollTo, selection]);
 
   useEffect(() => {
     if (view && autoFocus) {

package/src/index.ts

@@ -14,6 +14,7 @@ export * from './components';
 export * from './defaults';
 export * from './extensions';
 export * from './hooks';
+export * from './state';
 export * from './util';
 
 export { translations };

package/src/{extensions → state}/cursor.ts

@@ -2,9 +2,10 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type EditorState, Facet } from '@codemirror/state';
+import { type EditorState } from '@codemirror/state';
 
 import { type Range } from './types';
+import { singleValueFacet } from './util';
 
 /**
  * Converts indexes into the text document into stable peer-independent cursors.
@@ -27,11 +28,7 @@ const defaultCursorConverter: CursorConverter = {
 };
 
 export class Cursor {
-  static readonly converter = Facet.define<CursorConverter, CursorConverter>({
-    combine: (providers) => {
-      return providers[0] ?? defaultCursorConverter;
-    },
-  });
+  static readonly converter = singleValueFacet(defaultCursorConverter);
 
   static readonly getCursorFromRange = (state: EditorState, range: Range) => {
     const cursorConverter = state.facet(Cursor.converter);

package/src/state/doc.ts

@@ -0,0 +1,10 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { singleValueFacet } from './util';
+
+/**
+ * Currently edited document id as FQ string.
+ */
+export const documentId = singleValueFacet<string>();