Command priorities as constants (facebook#1775)

yuanyan · Apr 16, 2022 · 682fbfb · 682fbfb
1 parent 5ab8cd3
commit 682fbfb
Show file tree

Hide file tree

Showing 31 changed files with 231 additions and 274 deletions.
diff --git a/packages/lexical-code/src/index.js b/packages/lexical-code/src/index.js
@@ -54,6 +54,7 @@ import {
   KEY_ARROW_DOWN_COMMAND,
   KEY_ARROW_UP_COMMAND,
   OUTDENT_CONTENT_COMMAND,
+  COMMAND_PRIORITY_LOW,
 } from 'lexical';
 
 const DEFAULT_CODE_LANGUAGE = 'javascript';
@@ -871,22 +872,22 @@ export function registerCodeHighlighting(editor: LexicalEditor): () => void {
     editor.registerCommand(
       INDENT_CONTENT_COMMAND,
       (payload): boolean => handleMultilineIndent(INDENT_CONTENT_COMMAND),
-      1,
+      COMMAND_PRIORITY_LOW,
     ),
     editor.registerCommand(
       OUTDENT_CONTENT_COMMAND,
       (payload): boolean => handleMultilineIndent(OUTDENT_CONTENT_COMMAND),
-      1,
+      COMMAND_PRIORITY_LOW,
     ),
     editor.registerCommand(
       KEY_ARROW_UP_COMMAND,
       (payload): boolean => handleShiftLines(KEY_ARROW_UP_COMMAND, payload),
-      1,
+      COMMAND_PRIORITY_LOW,
     ),
     editor.registerCommand(
       KEY_ARROW_DOWN_COMMAND,
       (payload): boolean => handleShiftLines(KEY_ARROW_DOWN_COMMAND, payload),
-      1,
+      COMMAND_PRIORITY_LOW,
     ),
   );
 }
diff --git a/packages/lexical-history/src/index.js b/packages/lexical-history/src/index.js
@@ -8,7 +8,6 @@
  */
 
 import type {
-  CommandListenerEditorPriority,
   EditorState,
   GridSelection,
   IntentionallyMarkedAsDirtyElement,
@@ -29,6 +28,7 @@ import {
   CAN_UNDO_COMMAND,
   CLEAR_EDITOR_COMMAND,
   CLEAR_HISTORY_COMMAND,
+  COMMAND_PRIORITY_EDITOR,
   REDO_COMMAND,
   UNDO_COMMAND,
 } from 'lexical';
@@ -45,8 +45,6 @@ const INSERT_CHARACTER_AFTER_SELECTION = 2;
 const DELETE_CHARACTER_BEFORE_SELECTION = 3;
 const DELETE_CHARACTER_AFTER_SELECTION = 4;
 
-const EditorPriority: CommandListenerEditorPriority = 0;
-
 export type HistoryStateEntry = {
   editor: LexicalEditor,
   editorState: EditorState,
@@ -376,31 +374,31 @@ export function registerHistory(
         undo(editor, historyState);
         return true;
       },
-      EditorPriority,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       REDO_COMMAND,
       () => {
         redo(editor, historyState);
         return true;
       },
-      EditorPriority,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       CLEAR_EDITOR_COMMAND,
       () => {
         clearHistory(historyState);
         return false;
       },
-      EditorPriority,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       CLEAR_HISTORY_COMMAND,
       () => {
         clearHistory(historyState);
         return true;
       },
-      EditorPriority,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerUpdateListener(applyChange),
   );

diff --git a/packages/lexical-plain-text/src/index.js b/packages/lexical-plain-text/src/index.js
@@ -23,6 +23,7 @@ import {
   $getRoot,
   $getSelection,
   $isRangeSelection,
+  COMMAND_PRIORITY_EDITOR,
   COPY_COMMAND,
   CUT_COMMAND,
   DELETE_CHARACTER_COMMAND,
@@ -155,7 +156,7 @@ export function registerPlainText(
         selection.deleteCharacter(isBackward);
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       DELETE_WORD_COMMAND,
@@ -167,7 +168,7 @@ export function registerPlainText(
         selection.deleteWord(isBackward);
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       DELETE_LINE_COMMAND,
@@ -179,7 +180,7 @@ export function registerPlainText(
         selection.deleteLine(isBackward);
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       INSERT_TEXT_COMMAND,
@@ -203,7 +204,7 @@ export function registerPlainText(
         }
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       REMOVE_TEXT_COMMAND,
@@ -215,7 +216,7 @@ export function registerPlainText(
         selection.removeText();
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       INSERT_LINE_BREAK_COMMAND,
@@ -227,7 +228,7 @@ export function registerPlainText(
         selection.insertLineBreak(selectStart);
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       INSERT_PARAGRAPH_COMMAND,
@@ -239,7 +240,7 @@ export function registerPlainText(
         selection.insertLineBreak();
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       KEY_ARROW_LEFT_COMMAND,
@@ -257,7 +258,7 @@ export function registerPlainText(
         }
         return false;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       KEY_ARROW_RIGHT_COMMAND,
@@ -275,7 +276,7 @@ export function registerPlainText(
         }
         return false;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       KEY_BACKSPACE_COMMAND,
@@ -287,7 +288,7 @@ export function registerPlainText(
         event.preventDefault();
         return editor.dispatchCommand(DELETE_CHARACTER_COMMAND, true);
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       KEY_DELETE_COMMAND,
@@ -299,7 +300,7 @@ export function registerPlainText(
         event.preventDefault();
         return editor.dispatchCommand(DELETE_CHARACTER_COMMAND, false);
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       KEY_ENTER_COMMAND,
@@ -313,7 +314,7 @@ export function registerPlainText(
         }
         return editor.dispatchCommand(INSERT_LINE_BREAK_COMMAND);
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       COPY_COMMAND,
@@ -325,7 +326,7 @@ export function registerPlainText(
         onCopyForPlainText(event, editor);
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       CUT_COMMAND,
@@ -337,7 +338,7 @@ export function registerPlainText(
         onCutForPlainText(event, editor);
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       PASTE_COMMAND,
@@ -349,7 +350,7 @@ export function registerPlainText(
         onPasteForPlainText(event, editor);
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       DROP_COMMAND,
@@ -362,7 +363,7 @@ export function registerPlainText(
         event.preventDefault();
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
     editor.registerCommand(
       DRAGSTART_COMMAND,
@@ -375,7 +376,7 @@ export function registerPlainText(
         event.preventDefault();
         return true;
       },
-      0,
+      COMMAND_PRIORITY_EDITOR,
     ),
   );
   initializeEditor(editor, initialEditorState);

diff --git a/packages/lexical-playground/src/nodes/EquationNode.jsx b/packages/lexical-playground/src/nodes/EquationNode.jsx
@@ -7,17 +7,13 @@
  * @flow strict
  */
 
-import type {
-  CommandListenerHighPriority,
-  EditorConfig,
-  LexicalNode,
-  NodeKey,
-} from 'lexical';
+import type {EditorConfig, LexicalNode, NodeKey} from 'lexical';
 
 import {useLexicalComposerContext} from '@lexical/react/LexicalComposerContext';
 import {mergeRegister} from '@lexical/utils';
 import {
   $getNodeByKey,
+  COMMAND_PRIORITY_HIGH,
   DecoratorNode,
   KEY_ESCAPE_COMMAND,
   SELECTION_CHANGE_COMMAND,
@@ -28,8 +24,6 @@ import {useCallback, useEffect, useRef, useState} from 'react';
 import EquationEditor from '../ui/EquationEditor';
 import KatexRenderer from '../ui/KatexRenderer';
 
-const HighPriority: CommandListenerHighPriority = 3;
-
 type EquationComponentProps = {
   equation: string,
   inline: boolean,
@@ -75,7 +69,7 @@ function EquationComponent({
             }
             return false;
           },
-          HighPriority,
+          COMMAND_PRIORITY_HIGH,
         ),
         editor.registerCommand(
           KEY_ESCAPE_COMMAND,
@@ -88,7 +82,7 @@ function EquationComponent({
             }
             return false;
           },
-          HighPriority,
+          COMMAND_PRIORITY_HIGH,
         ),
       );
     }

diff --git a/packages/lexical-playground/src/nodes/ExcalidrawNode/index.jsx b/packages/lexical-playground/src/nodes/ExcalidrawNode/index.jsx
@@ -7,13 +7,7 @@
  * @flow strict
  */
 
-import type {
-  CommandListenerLowPriority,
-  EditorConfig,
-  LexicalEditor,
-  LexicalNode,
-  NodeKey,
-} from 'lexical';
+import type {EditorConfig, LexicalEditor, LexicalNode, NodeKey} from 'lexical';
 
 import {useLexicalComposerContext} from '@lexical/react/LexicalComposerContext';
 import useLexicalNodeSelection from '@lexical/react/useLexicalNodeSelection';
@@ -23,6 +17,7 @@ import {
   $getSelection,
   $isNodeSelection,
   CLICK_COMMAND,
+  COMMAND_PRIORITY_LOW,
   DecoratorNode,
   KEY_BACKSPACE_COMMAND,
   KEY_DELETE_COMMAND,
@@ -33,8 +28,6 @@ import {useCallback, useEffect, useMemo, useRef, useState} from 'react';
 import ExcalidrawImage from './ExcalidrawImage';
 import ExcalidrawModal from './ExcalidrawModal';
 
-const LowPriority: CommandListenerLowPriority = 1;
-
 function ExcalidrawComponent({
   nodeKey,
   data,
@@ -87,10 +80,18 @@ function ExcalidrawComponent({
 
           return false;
         },
-        LowPriority,
+        COMMAND_PRIORITY_LOW,
+      ),
+      editor.registerCommand(
+        KEY_DELETE_COMMAND,
+        onDelete,
+        COMMAND_PRIORITY_LOW,
+      ),
+      editor.registerCommand(
+        KEY_BACKSPACE_COMMAND,
+        onDelete,
+        COMMAND_PRIORITY_LOW,
       ),
-      editor.registerCommand(KEY_DELETE_COMMAND, onDelete, LowPriority),
-      editor.registerCommand(KEY_BACKSPACE_COMMAND, onDelete, LowPriority),
     );
   }, [clearSelection, editor, isSelected, onDelete, setSelected]);
 
@@ -131,8 +132,7 @@ function ExcalidrawComponent({
       />
       <button
         ref={buttonRef}
-        className={`excalidraw-button ${isSelected ? 'selected' : ''}`}
-      >
+        className={`excalidraw-button ${isSelected ? 'selected' : ''}`}>
         <ExcalidrawImage className="image" elements={elements} />
       </button>
     </>