Make sidebar config compatible with Vuepress 2

ph1p · Jul 6, 2023 · 592a7b5 · 592a7b5
1 parent 6ddb19f
commit 592a7b5
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 13 deletions.
diff --git a/src/__tests__/sidebar.test.ts b/src/__tests__/sidebar.test.ts
@@ -27,11 +27,19 @@ describe('test sidebar', () => {
 
     const result = {
       [`/${codeFolder}/`]: [
-        { title, collapsable: false, children: [['', '::vuepress-jsdoc-title::'], 'file1', 'file2'] },
         {
-          title: 'lib',
+          text: title,
           collapsable: false,
-          children: ['src/lib/file3', 'src/lib/_index']
+          children: [
+            { link: `/${codeFolder}/`, text: '::vuepress-jsdoc-title::' },
+            `/${codeFolder}/file1`,
+            `/${codeFolder}/file2`
+          ]
+        },
+        {
+          text: 'lib',
+          collapsable: false,
+          children: [`/${codeFolder}/src/lib/file3`, `/${codeFolder}/src/lib/_index`]
         }
       ]
     };

diff --git a/src/lib/vue-sidebar.ts b/src/lib/vue-sidebar.ts
@@ -11,13 +11,13 @@ import { FileTree } from '../interfaces';
 
 /**
  * Runs through the given tree structure and creates a vuepress config
- * @param {object} data Informations to build config
- * @param {array} data.fileTree tree strcture
+ * @param {object} data Information to build config
+ * @param {array} data.fileTree tree structure
  * @param {string} data.codeFolder ./code/ folder
  * @param {string} data.srcFolder ./src/ folder
  * @param {string} data.docsFolder ./documentation/ folder
  * @param {string} data.title title string
- * @returns {object} returns the vuepress menu strcture
+ * @returns {object} returns the vuepress menu structure
  */
 export const generateVueSidebar = ({
   fileTree,
@@ -32,20 +32,24 @@ export const generateVueSidebar = ({
   docsFolder: string;
   title: string;
 }) => {
-  let rootFiles = [['', '::vuepress-jsdoc-title::']];
-  rootFiles = rootFiles.concat(fileTree.filter((file: FileTree) => !file.children).map((file: FileTree) => file.name));
+  let rootFiles = [{ link: `/${codeFolder}/`, text: '::vuepress-jsdoc-title::' }];
+  rootFiles = rootFiles.concat(
+    fileTree.filter((file: FileTree) => !file.children).map((file: FileTree) => `/${join(codeFolder, file.name)}`)
+  );
 
   const rootFolder = fileTree.filter((file: FileTree) => file.children && file.children.length > 0);
 
-  const buildChildren = (children: any[], name: string, depth: number) => {
+  const buildChildren = (children: FileTree[], name: string, depth: number) => {
     let newChildren: any[] = [];
 
     for (const child of children) {
       if (child.children && child.children.length > 0) {
         newChildren = newChildren.concat(buildChildren(child.children, child.name, depth + 1));
       } else if (child.fullPath) {
-        if (fs.existsSync(join(docsFolder, child.fullPath.replace(srcFolder, '')) + '.md')) {
-          newChildren.push(child.fullPath.replace(`${srcFolder}/`, ''));
+        const path = child.fullPath.replace(srcFolder, '');
+
+        if (fs.existsSync(`${join(docsFolder, path)}.md`)) {
+          newChildren.push(`/${join(codeFolder, path)}`);
         }
       }
     }
@@ -54,15 +58,15 @@ export const generateVueSidebar = ({
   };
 
   const tree = rootFolder.map((folder: FileTree) => ({
-    title: folder.name,
+    text: folder.name,
     collapsable: false,
     children: buildChildren(folder.children!, folder.name, 0)
   }));
 
   return {
     [`/${codeFolder}/`]: [
       {
-        title,
+        text: title,
         collapsable: false,
         children: rootFiles
       }