feat(v2): editUrl functions should receive md doc permalink (#4232)

packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts

@@ -321,6 +321,7 @@ describe('simple site', () => {
       version: 'current',
       versionDocsDirPath: 'docs',
       docPath: path.posix.join('foo', 'baz.md'),
+      permalink: '/docs/foo/bazSlug.html',
       locale: 'en',
     });
   });
@@ -672,6 +673,7 @@ describe('versioned site', () => {
       version: '1.0.0',
       versionDocsDirPath: 'versioned_docs/version-1.0.0',
       docPath: path.join('hello.md'),
+      permalink: '/docs/1.0.0/hello',
       locale: 'en',
     });
   });

packages/docusaurus-plugin-content-docs/src/docs.ts

@@ -119,32 +119,6 @@ export function processDocMetadata({
   // ex: myDoc -> .
   const docsFileDirName = path.dirname(source);
 
-  const relativeFilePath = path.relative(docsDirPath, filePath);
-
-  function getDocEditUrl() {
-    if (typeof options.editUrl === 'function') {
-      return options.editUrl({
-        version: versionMetadata.versionName,
-        versionDocsDirPath: posixPath(
-          path.relative(siteDir, versionMetadata.docsDirPath),
-        ),
-        docPath: posixPath(relativeFilePath),
-        locale: context.i18n.currentLocale,
-      });
-    } else if (typeof options.editUrl === 'string') {
-      const isLocalized = docsDirPath === versionMetadata.docsDirPathLocalized;
-      const baseVersionEditUrl =
-        isLocalized && options.editLocalizedFiles
-          ? versionMetadata.versionEditUrlLocalized
-          : versionMetadata.versionEditUrl;
-      return getEditUrl(relativeFilePath, baseVersionEditUrl);
-    } else {
-      return undefined;
-    }
-  }
-
-  const docsEditUrl = getDocEditUrl();
-
   const {frontMatter = {}, excerpt} = parseMarkdownString(content);
   const {sidebar_label, custom_edit_url} = frontMatter;
 
@@ -194,6 +168,31 @@ export function processDocMetadata({
 
   const permalink = normalizeUrl([versionMetadata.versionPath, docSlug]);
 
+  function getDocEditUrl() {
+    const relativeFilePath = path.relative(docsDirPath, filePath);
+
+    if (typeof options.editUrl === 'function') {
+      return options.editUrl({
+        version: versionMetadata.versionName,
+        versionDocsDirPath: posixPath(
+          path.relative(siteDir, versionMetadata.docsDirPath),
+        ),
+        docPath: posixPath(relativeFilePath),
+        permalink,
+        locale: context.i18n.currentLocale,
+      });
+    } else if (typeof options.editUrl === 'string') {
+      const isLocalized = docsDirPath === versionMetadata.docsDirPathLocalized;
+      const baseVersionEditUrl =
+        isLocalized && options.editLocalizedFiles
+          ? versionMetadata.versionEditUrlLocalized
+          : versionMetadata.versionEditUrl;
+      return getEditUrl(relativeFilePath, baseVersionEditUrl);
+    } else {
+      return undefined;
+    }
+  }
+
   // Assign all of object properties during instantiation (if possible) for
   // NodeJS optimization.
   // Adding properties to object after instantiation will cause hidden
@@ -207,7 +206,7 @@ export function processDocMetadata({
     source: aliasedSitePath(filePath, siteDir),
     slug: docSlug,
     permalink,
-    editUrl: custom_edit_url !== undefined ? custom_edit_url : docsEditUrl,
+    editUrl: custom_edit_url !== undefined ? custom_edit_url : getDocEditUrl(),
     version: versionMetadata.versionName,
     lastUpdatedBy: lastUpdate.lastUpdatedBy,
     lastUpdatedAt: lastUpdate.lastUpdatedAt,

packages/docusaurus-plugin-content-docs/src/types.ts

@@ -35,6 +35,7 @@ export type EditUrlFunction = (editUrlParams: {
   version: string;
   versionDocsDirPath: string;
   docPath: string;
+  permalink: string;
   locale: string;
 }) => string | undefined;