add {@link $newName} to deprecation comments

facebook · May 10, 2024 · d5b6ea8 · d5b6ea8
1 parent 1c60e7b
commit d5b6ea8
Show file tree

Hide file tree

Showing 11 changed files with 9 additions and 91 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/lexical-eslint-plugin/README.md b/packages/lexical-eslint-plugin/README.md
@@ -189,7 +189,7 @@ references to that name is limited to the module's scope.
 export function $exportedInvalidFunction() {
   return $getRoot();
 }
-/** @deprecated renamed to $exportedInvalidFunction by @lexical/eslint-plugin rules-of-lexical */
+/** @deprecated renamed to {@link $exportedInvalidFunction} by @lexical/eslint-plugin rules-of-lexical */
 export const exportedInvalidFunction = $exportedInvalidFunction;
 ```
 

diff --git a/packages/lexical-eslint-plugin/src/__tests__/unit/rules-of-lexical.test.ts b/packages/lexical-eslint-plugin/src/__tests__/unit/rules-of-lexical.test.ts
@@ -24,7 +24,7 @@ const NAME_UNDERSCORE = (name: string) =>
   !/^\$/.test(name) || /_$/.test(name) ? name : name + '_';
 const REEXPORT = (name: string) =>
   /^\$/.test(name)
-    ? `\n/** @deprecated renamed to ${name} by @lexical/eslint-plugin rules-of-lexical */\nexport const ${name.replace(
+    ? `\n/** @deprecated renamed to {@link ${name}} by @lexical/eslint-plugin rules-of-lexical */\nexport const ${name.replace(
         /^\$/,
         '',
       )} = ${name};\n`

diff --git a/packages/lexical-eslint-plugin/src/rules/rules-of-lexical.js b/packages/lexical-eslint-plugin/src/rules/rules-of-lexical.js
@@ -222,7 +222,7 @@ function getExportDeclaration(variable) {
  * @param {Record<'caller'|'suggestName', string>} data
  */
 function renameExportText({caller, suggestName}) {
-  return `\n/** @deprecated renamed to ${suggestName} by @lexical/eslint-plugin rules-of-lexical */\nexport const ${caller} = ${suggestName};`;
+  return `\n/** @deprecated renamed to {@link ${suggestName}} by @lexical/eslint-plugin rules-of-lexical */\nexport const ${caller} = ${suggestName};`;
 }
 
 /**

diff --git a/packages/lexical-link/flow/LexicalLink.js.flow b/packages/lexical-link/flow/LexicalLink.js.flow
@@ -84,5 +84,5 @@ declare export function $toggleLink(
   url: null | string,
   attributes: LinkAttributes,
 ): void;
-/** @deprecated renamed to $toggleLink by @lexical/eslint-plugin rules-of-lexical */
+/** @deprecated renamed to {@link $toggleLink} by @lexical/eslint-plugin rules-of-lexical */
 declare const toggleLink: typeof $toggleLink;
diff --git a/packages/lexical-link/src/index.ts b/packages/lexical-link/src/index.ts
@@ -523,7 +523,7 @@ export function $toggleLink(
     });
   }
 }
-/** @deprecated renamed to $toggleLink by @lexical/eslint-plugin rules-of-lexical */
+/** @deprecated renamed to {@link $toggleLink} by @lexical/eslint-plugin rules-of-lexical */
 export const toggleLink = $toggleLink;
 
 function $getAncestor<NodeType extends LexicalNode = LexicalNode>(

diff --git a/packages/lexical-offset/src/index.ts b/packages/lexical-offset/src/index.ts
@@ -554,7 +554,7 @@ export function $createChildrenArray(
   }
   return children;
 }
-/** @deprecated renamed to $createChildrenArray by @lexical/eslint-plugin rules-of-lexical */
+/** @deprecated renamed to {@link $createChildrenArray} by @lexical/eslint-plugin rules-of-lexical */
 export const createChildrenArray = $createChildrenArray;
 
 export function $createOffsetView(

diff --git a/packages/lexical-selection/flow/LexicalSelection.js.flow b/packages/lexical-selection/flow/LexicalSelection.js.flow
@@ -78,5 +78,5 @@ declare export function $trimTextContentFromAnchor(
   delCount: number,
 ): void;
 
-/** @deprecated renamed to $trimTextContentFromAnchor by @lexical/eslint-plugin rules-of-lexical */
+/** @deprecated renamed to {@link $trimTextContentFromAnchor} by @lexical/eslint-plugin rules-of-lexical */
 declare export const trimTextContentFromAnchor: typeof $trimTextContentFromAnchor;
diff --git a/packages/lexical-selection/src/index.ts b/packages/lexical-selection/src/index.ts
@@ -38,7 +38,7 @@ export {
   $sliceSelectedTextNodeContent,
   $trimTextContentFromAnchor,
 };
-/** @deprecated renamed to $trimTextContentFromAnchor by @lexical/eslint-plugin rules-of-lexical */
+/** @deprecated renamed to {@link $trimTextContentFromAnchor} by @lexical/eslint-plugin rules-of-lexical */
 export const trimTextContentFromAnchor = $trimTextContentFromAnchor;
 
 export {

diff --git a/packages/lexical-website/docusaurus.config.js b/packages/lexical-website/docusaurus.config.js
@@ -12,7 +12,6 @@
 
 const {github: lightCodeTheme, dracula: darkCodeTheme} =
   require('prism-react-renderer').themes;
-const importPlugin = require('remark-import-partial');
 const slugifyPlugin = require('./src/plugins/lexical-remark-slugify-anchors');
 const {packagesManager} = require('../../scripts/shared/packagesManager');
 const path = require('node:path');
@@ -245,7 +244,7 @@ const config = {
           showReadingTime: true, // TODO: Update when directory finalized
         },
         docs: {
-          beforeDefaultRemarkPlugins: [importPlugin, slugifyPlugin],
+          beforeDefaultRemarkPlugins: [slugifyPlugin],
           editUrl: `${GITHUB_REPO_URL}/tree/main/packages/lexical-website/`,
           path: 'docs',
           sidebarItemsGenerator,

diff --git a/packages/lexical-website/package.json b/packages/lexical-website/package.json
@@ -25,7 +25,6 @@
     "prism-react-renderer": "^2.3.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "remark-import-partial": "^0.0.2",
     "typedoc-plugin-markdown": "^3.17.1",
     "unist-util-visit": "^5.0.0"
   },