npm run lint -- --fix

etrepum · Apr 27, 2024 · 095502e · 095502e
1 parent f309cc3
commit 095502e
Show file tree

Hide file tree

Showing 79 changed files with 438 additions and 382 deletions.
diff --git a/examples/vanilla-js-plugin/src/emoji-plugin/EmojiPlugin.ts b/examples/vanilla-js-plugin/src/emoji-plugin/EmojiPlugin.ts
@@ -11,7 +11,7 @@ import {LexicalEditor, TextNode} from 'lexical';
 import {$createEmojiNode} from './EmojiNode';
 import findEmoji from './findEmoji';
 
-function textNodeTransform(node: TextNode): void {
+function $textNodeTransform(node: TextNode): void {
   if (!node.isSimpleText() || node.hasFormat('code')) {
     return;
   }
@@ -46,5 +46,5 @@ function textNodeTransform(node: TextNode): void {
 export function registerEmoji(editor: LexicalEditor): () => void {
   // We don't use editor.registerUpdateListener here as alternative approach where we rely
   // on update listener is highly discouraged as it triggers an additional render (the most expensive lifecycle operation).
-  return editor.registerNodeTransform(TextNode, textNodeTransform);
+  return editor.registerNodeTransform(TextNode, $textNodeTransform);
 }
diff --git a/examples/vanilla-js-plugin/src/prepopulatedRichText.ts b/examples/vanilla-js-plugin/src/prepopulatedRichText.ts
@@ -7,7 +7,7 @@
  */
 import {$createParagraphNode, $createTextNode, $getRoot} from 'lexical';
 
-export default function prepopulatedRichText() {
+export default function $prepopulatedRichText() {
   const root = $getRoot();
   if (root.getFirstChild() !== null) {
     return;

diff --git a/examples/vanilla-js/src/prepopulatedRichText.ts b/examples/vanilla-js/src/prepopulatedRichText.ts
@@ -8,7 +8,7 @@
 import {$createHeadingNode, $createQuoteNode} from '@lexical/rich-text';
 import {$createParagraphNode, $createTextNode, $getRoot} from 'lexical';
 
-export default function prepopulatedRichText() {
+export default function $prepopulatedRichText() {
   const root = $getRoot();
   if (root.getFirstChild() !== null) {
     return;

diff --git a/packages/lexical-code/src/CodeHighlighter.ts b/packages/lexical-code/src/CodeHighlighter.ts
@@ -201,7 +201,7 @@ export function getEndOfCodeInLine(
   return lastNode;
 }
 
-function textNodeTransform(
+function $textNodeTransform(
   node: TextNode,
   editor: LexicalEditor,
   tokenizer: Tokenizer,
@@ -275,7 +275,7 @@ function codeNodeTransform(
   // in its final state
   editor.update(
     () => {
-      updateAndRetainSelection(nodeKey, () => {
+      $updateAndRetainSelection(nodeKey, () => {
         const currentNode = $getNodeByKey(nodeKey);
 
         if (!$isCodeNode(currentNode) || !currentNode.isAttached()) {
@@ -287,7 +287,7 @@ function codeNodeTransform(
           code,
           currentNode.getLanguage() || tokenizer.defaultLanguage,
         );
-        const highlightNodes = getHighlightNodes(tokens);
+        const highlightNodes = $getHighlightNodes(tokens);
         const diffRange = getDiffRange(
           currentNode.getChildren(),
           highlightNodes,
@@ -311,7 +311,7 @@ function codeNodeTransform(
   );
 }
 
-function getHighlightNodes(
+function $getHighlightNodes(
   tokens: Array<string | Token>,
   type?: string,
 ): LexicalNode[] {
@@ -334,9 +334,9 @@ function getHighlightNodes(
     } else {
       const {content} = token;
       if (typeof content === 'string') {
-        nodes.push(...getHighlightNodes([content], token.type));
+        nodes.push(...$getHighlightNodes([content], token.type));
       } else if (Array.isArray(content)) {
-        nodes.push(...getHighlightNodes(content, token.type));
+        nodes.push(...$getHighlightNodes(content, token.type));
       }
     }
   }
@@ -346,7 +346,7 @@ function getHighlightNodes(
 
 // Wrapping update function into selection retainer, that tries to keep cursor at the same
 // position as before.
-function updateAndRetainSelection(
+function $updateAndRetainSelection(
   nodeKey: NodeKey,
   updateFn: () => boolean,
 ): void {
@@ -510,7 +510,7 @@ function $getCodeLines(
   return lines;
 }
 
-function handleTab(shiftKey: boolean): null | LexicalCommand<void> {
+function $handleTab(shiftKey: boolean): null | LexicalCommand<void> {
   const selection = $getSelection();
   if (!$isRangeSelection(selection) || !$isSelectionInCode(selection)) {
     return null;
@@ -564,7 +564,7 @@ function handleTab(shiftKey: boolean): null | LexicalCommand<void> {
   return tabOrOutdent;
 }
 
-function handleMultilineIndent(type: LexicalCommand<void>): boolean {
+function $handleMultilineIndent(type: LexicalCommand<void>): boolean {
   const selection = $getSelection();
   if (!$isRangeSelection(selection) || !$isSelectionInCode(selection)) {
     return false;
@@ -627,7 +627,7 @@ function handleMultilineIndent(type: LexicalCommand<void>): boolean {
   return true;
 }
 
-function handleShiftLines(
+function $handleShiftLines(
   type: LexicalCommand<KeyboardEvent>,
   event: KeyboardEvent,
 ): boolean {
@@ -759,7 +759,7 @@ function handleShiftLines(
   return true;
 }
 
-function handleMoveTo(
+function $handleMoveTo(
   type: LexicalCommand<KeyboardEvent>,
   event: KeyboardEvent,
 ): boolean {
@@ -834,15 +834,15 @@ export function registerCodeHighlighting(
       codeNodeTransform(node, editor, tokenizer as Tokenizer),
     ),
     editor.registerNodeTransform(TextNode, (node) =>
-      textNodeTransform(node, editor, tokenizer as Tokenizer),
+      $textNodeTransform(node, editor, tokenizer as Tokenizer),
     ),
     editor.registerNodeTransform(CodeHighlightNode, (node) =>
-      textNodeTransform(node, editor, tokenizer as Tokenizer),
+      $textNodeTransform(node, editor, tokenizer as Tokenizer),
     ),
     editor.registerCommand(
       KEY_TAB_COMMAND,
       (event) => {
-        const command = handleTab(event.shiftKey);
+        const command = $handleTab(event.shiftKey);
         if (command === null) {
           return false;
         }
@@ -866,32 +866,32 @@ export function registerCodeHighlighting(
     ),
     editor.registerCommand(
       INDENT_CONTENT_COMMAND,
-      (payload): boolean => handleMultilineIndent(INDENT_CONTENT_COMMAND),
+      (payload): boolean => $handleMultilineIndent(INDENT_CONTENT_COMMAND),
       COMMAND_PRIORITY_LOW,
     ),
     editor.registerCommand(
       OUTDENT_CONTENT_COMMAND,
-      (payload): boolean => handleMultilineIndent(OUTDENT_CONTENT_COMMAND),
+      (payload): boolean => $handleMultilineIndent(OUTDENT_CONTENT_COMMAND),
       COMMAND_PRIORITY_LOW,
     ),
     editor.registerCommand(
       KEY_ARROW_UP_COMMAND,
-      (payload): boolean => handleShiftLines(KEY_ARROW_UP_COMMAND, payload),
+      (payload): boolean => $handleShiftLines(KEY_ARROW_UP_COMMAND, payload),
       COMMAND_PRIORITY_LOW,
     ),
     editor.registerCommand(
       KEY_ARROW_DOWN_COMMAND,
-      (payload): boolean => handleShiftLines(KEY_ARROW_DOWN_COMMAND, payload),
+      (payload): boolean => $handleShiftLines(KEY_ARROW_DOWN_COMMAND, payload),
       COMMAND_PRIORITY_LOW,
     ),
     editor.registerCommand(
       MOVE_TO_END,
-      (payload): boolean => handleMoveTo(MOVE_TO_END, payload),
+      (payload): boolean => $handleMoveTo(MOVE_TO_END, payload),
       COMMAND_PRIORITY_LOW,
     ),
     editor.registerCommand(
       MOVE_TO_START,
-      (payload): boolean => handleMoveTo(MOVE_TO_START, payload),
+      (payload): boolean => $handleMoveTo(MOVE_TO_START, payload),
       COMMAND_PRIORITY_LOW,
     ),
   );

diff --git a/packages/lexical-code/src/CodeNode.ts b/packages/lexical-code/src/CodeNode.ts
@@ -139,25 +139,25 @@ export class CodeNode extends ElementNode {
 
         return isMultiLine
           ? {
-              conversion: convertPreElement,
+              conversion: $convertPreElement,
               priority: 1,
             }
           : null;
       },
       div: (node: Node) => ({
-        conversion: convertDivElement,
+        conversion: $convertDivElement,
         priority: 1,
       }),
       pre: (node: Node) => ({
-        conversion: convertPreElement,
+        conversion: $convertPreElement,
         priority: 0,
       }),
       table: (node: Node) => {
         const table = node;
         // domNode is a <table> since we matched it by nodeName
         if (isGitHubCodeTable(table as HTMLTableElement)) {
           return {
-            conversion: convertTableElement,
+            conversion: $convertTableElement,
             priority: 3,
           };
         }
@@ -330,15 +330,15 @@ export function $isCodeNode(
   return node instanceof CodeNode;
 }
 
-function convertPreElement(domNode: Node): DOMConversionOutput {
+function $convertPreElement(domNode: Node): DOMConversionOutput {
   let language;
   if (isHTMLElement(domNode)) {
     language = domNode.getAttribute(LANGUAGE_DATA_ATTRIBUTE);
   }
   return {node: $createCodeNode(language)};
 }
 
-function convertDivElement(domNode: Node): DOMConversionOutput {
+function $convertDivElement(domNode: Node): DOMConversionOutput {
   // domNode is a <div> since we matched it by nodeName
   const div = domNode as HTMLDivElement;
   const isCode = isCodeElement(div);
@@ -359,7 +359,7 @@ function convertDivElement(domNode: Node): DOMConversionOutput {
   };
 }
 
-function convertTableElement(): DOMConversionOutput {
+function $convertTableElement(): DOMConversionOutput {
   return {node: $createCodeNode()};
 }
 

diff --git a/packages/lexical-devtools-core/src/generateContent.ts b/packages/lexical-devtools-core/src/generateContent.ts
@@ -120,7 +120,7 @@ export function generateContent(
         ' ',
       )} ${nodeKeyDisplay} ${typeDisplay} ${idsDisplay} ${printNode(node)}\n`;
 
-      res += printSelectedCharsLine({
+      res += $printSelectedCharsLine({
         indent,
         isSelected,
         node,
@@ -364,7 +364,7 @@ function printTitleProperties(node: LinkNode) {
   return str;
 }
 
-function printSelectedCharsLine({
+function $printSelectedCharsLine({
   indent,
   isSelected,
   node,

diff --git a/packages/lexical-history/src/__tests__/unit/LexicalHistory.test.tsx b/packages/lexical-history/src/__tests__/unit/LexicalHistory.test.tsx
@@ -128,8 +128,8 @@ describe('LexicalHistory tests', () => {
     await ReactTestUtils.act(async () => {
       await editor.update(() => {
         const root = $getRoot();
-        const paragraph1 = createParagraphNode('AAA');
-        const paragraph2 = createParagraphNode('BBB');
+        const paragraph1 = $createParagraphNode_('AAA');
+        const paragraph2 = $createParagraphNode_('BBB');
 
         // The editor has one child that is an empty
         // paragraph Node.
@@ -223,7 +223,7 @@ describe('LexicalHistory tests', () => {
     await ReactTestUtils.act(async () => {
       await editor.update(() => {
         const root = $getRoot();
-        const paragraph = createParagraphNode('foo');
+        const paragraph = $createParagraphNode_('foo');
         root.append(paragraph);
       });
     });
@@ -261,7 +261,7 @@ describe('LexicalHistory tests', () => {
     await ReactTestUtils.act(async () => {
       await editor.update(() => {
         const root = $getRoot();
-        const paragraph = createParagraphNode('foo');
+        const paragraph = $createParagraphNode_('foo');
         root.append(paragraph);
       });
     });
@@ -315,7 +315,7 @@ describe('LexicalHistory tests', () => {
   });
 });
 
-const createParagraphNode = (text: string) => {
+const $createParagraphNode_ = (text: string) => {
   const paragraph = $createParagraphNode();
   const textNode = $createTextNode(text);
 

diff --git a/packages/lexical-link/src/index.ts b/packages/lexical-link/src/index.ts
@@ -140,7 +140,7 @@ export class LinkNode extends ElementNode {
   static importDOM(): DOMConversionMap | null {
     return {
       a: (node: Node) => ({
-        conversion: convertAnchorElement,
+        conversion: $convertAnchorElement,
         priority: 1,
       }),
     };
@@ -270,7 +270,7 @@ export class LinkNode extends ElementNode {
   }
 }
 
-function convertAnchorElement(domNode: Node): DOMConversionOutput {
+function $convertAnchorElement(domNode: Node): DOMConversionOutput {
   let node = null;
   if (isHTMLAnchorElement(domNode)) {
     const content = domNode.textContent;
@@ -407,7 +407,7 @@ export const TOGGLE_LINK_COMMAND: LexicalCommand<
  * @param url - The URL the link directs to.
  * @param attributes - Optional HTML a tag attributes. { target, rel, title }
  */
-export function toggleLink(
+export function $toggleLink(
   url: null | string,
   attributes: LinkAttributes = {},
 ): void {
@@ -523,6 +523,8 @@ export function toggleLink(
     });
   }
 }
+/** @deprecated renamed to $toggleLink by @lexical/eslint-plugin rules-of-lexical */
+export const toggleLink = $toggleLink;
 
 function $getAncestor<NodeType extends LexicalNode = LexicalNode>(
   node: LexicalNode,

diff --git a/packages/lexical-list/src/LexicalListItemNode.ts b/packages/lexical-list/src/LexicalListItemNode.ts
@@ -117,7 +117,7 @@ export class ListItemNode extends ElementNode {
   static importDOM(): DOMConversionMap | null {
     return {
       li: (node: Node) => ({
-        conversion: convertListItemElement,
+        conversion: $convertListItemElement,
         priority: 0,
       }),
     };
@@ -491,7 +491,7 @@ function updateListItemChecked(
   }
 }
 
-function convertListItemElement(domNode: Node): DOMConversionOutput {
+function $convertListItemElement(domNode: Node): DOMConversionOutput {
   const checked =
     isHTMLElement(domNode) && domNode.getAttribute('aria-checked') === 'true';
   return {node: $createListItemNode(checked)};