⚡ support monorepo edit url (#187)

close #186
antvis · Jun 16, 2020 · 14ffd7b · 14ffd7b
1 parent 9cfa016
commit 14ffd7b
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 32 deletions.
diff --git a/@antv/gatsby-theme-antv/site/templates/document.tsx b/@antv/gatsby-theme-antv/site/templates/document.tsx
@@ -33,7 +33,7 @@ const getMenuItemLocaleKey = (slug = '') => {
   const slugPieces = slug.split('/');
   const menuItemLocaleKey = slugPieces
     .slice(slugPieces.indexOf('docs') + 1)
-    .filter(key => key)
+    .filter((key) => key)
     .join('/');
   return menuItemLocaleKey;
 };
@@ -42,7 +42,7 @@ const getDocument = (docs: any[], slug = '', level: number) => {
   if (slug.split('/').length !== level + 2) {
     return;
   }
-  return docs.find(doc => doc.slug === slug);
+  return docs.find((doc) => doc.slug === slug);
 };
 
 // https://github.com/antvis/gatsby-theme-antv/issues/114
@@ -131,6 +131,25 @@ const renderMenu = (menuData: MenuData[]) =>
     return null;
   });
 
+export const getGithubSourceUrl = ({
+  githubUrl,
+  relativePath,
+  prefix,
+}: {
+  githubUrl: string;
+  relativePath: string;
+  prefix: string;
+}) => {
+  // https://github.com/antvis/x6/tree/master/packages/x6-sites
+  if (githubUrl.includes('/tree/master/')) {
+    return `${githubUrl.replace(
+      '/tree/master/',
+      '/edit/master/',
+    )}/${prefix}/${relativePath}`;
+  }
+  return `${githubUrl}/edit/master/${prefix}/${relativePath}`;
+};
+
 export default function Template({
   data, // this prop will be injected by the GraphQL query below.
   location,
@@ -169,22 +188,18 @@ export default function Template({
       node: {
         fields: { slug: slugString },
       },
-    }: any) =>
-      slugString
-        .split('/')
-        .slice(0, -1)
-        .join('/'),
+    }: any) => slugString.split('/').slice(0, -1).join('/'),
   );
 
   const filterGroupedEdges = {} as any;
   Object.keys(groupedEdges)
-    .filter(key => shouldBeShown(key, pathWithoutPrefix, i18n.language))
+    .filter((key) => shouldBeShown(key, pathWithoutPrefix, i18n.language))
     .forEach((key: string) => {
       filterGroupedEdges[key] = groupedEdges[key];
     });
 
   const [openKeys, setOpenKeys] = useState<string[]>(
-    Object.keys(filterGroupedEdges).filter(key => slug.startsWith(key)),
+    Object.keys(filterGroupedEdges).filter((key) => slug.startsWith(key)),
   );
 
   const menuData = getMenuData({
@@ -199,7 +214,7 @@ export default function Template({
       selectedKeys={[slug]}
       style={{ height: '100%' }}
       openKeys={openKeys}
-      onOpenChange={currentOpenKeys => setOpenKeys(currentOpenKeys)}
+      onOpenChange={(currentOpenKeys) => setOpenKeys(currentOpenKeys)}
       inlineIndent={16}
       forceSubMenuRender
     >
@@ -223,7 +238,7 @@ export default function Template({
         )
       }
       wrapperClassName={styles.menuDrawer}
-      onChange={open => setDrawOpen(!!open)}
+      onChange={(open) => setDrawOpen(!!open)}
       width={280}
     >
       {menu}
@@ -261,7 +276,11 @@ export default function Template({
               {frontmatter.title}
               <Tooltip title={t('在 GitHub 上编辑')}>
                 <a
-                  href={`${githubUrl}/edit/master/docs/${relativePath}`}
+                  href={getGithubSourceUrl({
+                    githubUrl,
+                    relativePath,
+                    prefix: 'docs',
+                  })}
                   target="_blank"
                   rel="noopener noreferrer"
                   className={styles.editOnGtiHubButton}

diff --git a/@antv/gatsby-theme-antv/site/templates/example.tsx b/@antv/gatsby-theme-antv/site/templates/example.tsx
@@ -19,6 +19,7 @@ import PlayGrounds from '../components/PlayGrounds';
 import NavigatorBanner from '../components/NavigatorBanner';
 import { capitalize } from '../utils';
 import { usePrevAndNext } from '../hooks';
+import { getGithubSourceUrl } from './document';
 import styles from './markdown.module.less';
 
 const MenuIcon = createFromIconfontCN({
@@ -74,7 +75,7 @@ const getMenuItemLocaleKey = (slug = '') => {
   const slugPieces = slug.split('/');
   const menuItemLocaleKey = slugPieces
     .slice(slugPieces.indexOf('examples') + 1)
-    .filter(key => key)
+    .filter((key) => key)
     .join('/');
   return menuItemLocaleKey;
 };
@@ -91,8 +92,8 @@ const getExampleOrder = ({
   };
 }): number => {
   const key = getMenuItemLocaleKey(groupedEdgeKey);
-  if (examples.find(item => item.slug === key)) {
-    return (examples.findIndex(item => item.slug === key) || 0) + 100;
+  if (examples.find((item) => item.slug === key)) {
+    return (examples.findIndex((item) => item.slug === key) || 0) + 100;
   }
   if (!groupedEdges[groupedEdgeKey] && !groupedEdges[groupedEdgeKey].length) {
     return 0;
@@ -157,19 +158,13 @@ export default function Template({
     }: any) => {
       // API.md and deisgn.md
       if (slugString.endsWith('/API') || slugString.endsWith('/design')) {
-        return slugString
-          .split('/')
-          .slice(0, -2)
-          .join('/');
+        return slugString.split('/').slice(0, -2).join('/');
       }
       // index.md
-      return slugString
-        .split('/')
-        .slice(0, -1)
-        .join('/');
+      return slugString.split('/').slice(0, -1).join('/');
     },
   );
-  const defaultOpenKeys = Object.keys(groupedEdges).filter(key =>
+  const defaultOpenKeys = Object.keys(groupedEdges).filter((key) =>
     slug.startsWith(key),
   );
   const [openKeys, setOpenKeys] = useState<string[]>(defaultOpenKeys);
@@ -191,11 +186,11 @@ export default function Template({
       selectedKeys={[slug]}
       style={{ height: '100%' }}
       openKeys={openKeys}
-      onOpenChange={currentOpenKeys => setOpenKeys(currentOpenKeys)}
+      onOpenChange={(currentOpenKeys) => setOpenKeys(currentOpenKeys)}
       forceSubMenuRender
     >
       {Object.keys(groupedEdges)
-        .filter(key => key.startsWith(`/${i18n.language}/`))
+        .filter((key) => key.startsWith(`/${i18n.language}/`))
         .sort((a: string, b: string) => {
           const aOrder = getExampleOrder({
             groupedEdgeKey: a,
@@ -209,7 +204,7 @@ export default function Template({
           });
           return aOrder - bOrder;
         })
-        .map(slugString => {
+        .map((slugString) => {
           const slugPieces = slugString.split('/');
           if (slugPieces.length <= 3) {
             return renderMenuItems(groupedEdges[slugString]);
@@ -259,14 +254,14 @@ export default function Template({
         )
       }
       wrapperClassName={styles.menuDrawer}
-      onChange={open => setDrawOpen(!!open)}
+      onChange={(open) => setDrawOpen(!!open)}
       width={280}
     >
       {menu}
     </Drawer>
   );
 
-  const allDemosInCategory = groupBy(allDemos || [], demo => {
+  const allDemosInCategory = groupBy(allDemos || [], (demo) => {
     if (!demo.postFrontmatter || !demo.postFrontmatter[i18n.language]) {
       return 'OTHER';
     }
@@ -314,7 +309,7 @@ export default function Template({
                 .sort((a, b) => {
                   return (a.order || -1) - (b.order || -1);
                 })
-                .map(demo => {
+                .map((demo) => {
                   let cardTitle;
                   if (typeof demo.title === 'string') {
                     cardTitle = demo.title;
@@ -364,7 +359,11 @@ export default function Template({
         {frontmatter.title}
         <Tooltip title={t('在 GitHub 上编辑')}>
           <a
-            href={`${githubUrl}/edit/master/examples/${relativePath}`}
+            href={getGithubSourceUrl({
+              githubUrl,
+              relativePath,
+              prefix: 'examples',
+            })}
             target="_blank"
             rel="noopener noreferrer"
             className={styles.editOnGtiHubButton}

diff --git a/example/package.json b/example/package.json
@@ -6,7 +6,7 @@
   "homepage": "https://test.antv.vision",
   "repository": {
     "type": "git",
-    "url": "https://github.com/antvis/antvis.github.io"
+    "url": "https://github.com/antvis/gatsby-theme-antv/tree/master/example"
   },
   "bugs": {
     "url": "https://github.com/antvis/antvis.github.io/issues"