test: update tests and add file check in vupress config generator

Author: ph1p

example/documentation/code/config.js

@@ -2,7 +2,7 @@ import { fs, vol } from 'memfs';
 
 import { listFolder } from '../lib/list-folder';
 
-jest.mock('fs');
+jest.mock('fs', () => fs);
 jest.mock('fs/promises', () => fs.promises);
 
 describe('test file-structure', () => {
@@ -30,12 +30,12 @@ describe('test file-structure', () => {
     ]);
 
     expect((await listFolder('./src', [])).tree).toEqual([
-      { fullPath: 'src/file1', name: 'file1', path: '/file1' },
-      { fullPath: 'src/file2', name: 'file2', path: '/file2' },
+      { fullPath: 'src/file1', name: 'file1', path: '/file1', ext: '.js' },
+      { fullPath: 'src/file2', name: 'file2', path: '/file2', ext: '.ts' },
       {
         children: [
-          { fullPath: 'src/lib/file3', name: 'file3', path: '/file3' },
-          { fullPath: 'src/lib/_index', name: '_index', path: '/_index' }
+          { fullPath: 'src/lib/file3', name: 'file3', path: '/file3', ext: '.vue' },
+          { fullPath: 'src/lib/_index', name: '_index', path: '/_index', ext: '.js' }
         ],
         name: 'lib'
       }

src/__tests__/list-folder.test.ts

@@ -1,41 +1,37 @@
 import { generateVueSidebar } from '../lib/vue-sidebar';
 
+jest.mock('fs', () => ({
+  existsSync: () => true
+}));
+
 describe('test sidebar', () => {
   test('generateVueSidebar should return valid vue config', () => {
     const codeFolder = 'test_folder';
     const title = 'test_folder';
     const srcFolder = 'test_folder';
+    const docsFolder = 'test_folder';
 
     const fileTree = [
-      { name: 'class', path: '/class', fullPath: './documentation/test_folder/class' },
+      { fullPath: 'src/file1', name: 'file1', path: '/file1', ext: '.js' },
+      { fullPath: 'src/file2', name: 'file2', path: '/file2', ext: '.ts' },
       {
-        name: 'lib',
         children: [
-          { name: 'test1', path: '/test1', fullPath: './documentation/test_folder/test1' },
-          {
-            name: 'test2',
-            path: '/test2',
-            fullPath: './documentation/test_folder/test2',
-            children: [
-              { name: 'test3', path: '/test3', fullPath: './documentation/test_folder/test2/test3' },
-              { name: 'test4', path: '/test4', fullPath: './documentation/test_folder/test2/test4' }
-            ]
-          }
-        ]
-      },
-      { name: 'test', path: '/test', fullPath: './documentation/test_folder/test' },
-      { name: 'tests', children: [] }
+          { fullPath: 'src/lib/file3', name: 'file3', path: '/file3', ext: '.vue' },
+          { fullPath: 'src/lib/_index', name: '_index', path: '/_index', ext: '.js' }
+        ],
+        name: 'lib'
+      }
     ];
 
-    const sidebar = generateVueSidebar({ fileTree, codeFolder, srcFolder, title });
+    const sidebar = generateVueSidebar({ fileTree, codeFolder, docsFolder, srcFolder, title });
 
     const result = {
       [`/${codeFolder}/`]: [
-        { title, collapsable: false, children: [['', '::vuepress-jsdoc-title::'], 'class', 'test'] },
+        { title, collapsable: false, children: [['', '::vuepress-jsdoc-title::'], 'file1', 'file2'] },
         {
           title: 'lib',
           collapsable: false,
-          children: ['./documentation/test1', './documentation/test2/test3', './documentation/test2/test4']
+          children: ['src/lib/file3', 'src/lib/_index']
         }
       ]
     };

src/__tests__/sidebar.test.ts

@@ -36,19 +36,6 @@ export const generate = async (argv: Record<string, string>) => {
 
   const parsePromises: Promise<any>[] = [];
 
-  // write vuepress sidebar
-  await fs.writeFile(
-    `${docsFolder}/config.js`,
-    `exports.fileTree=${JSON.stringify(tree)};exports.sidebarTree = (title = 'Mainpage') => (${JSON.stringify(
-      generateVueSidebar({
-        fileTree: tree,
-        srcFolder,
-        codeFolder,
-        title
-      })
-    ).replace('::vuepress-jsdoc-title::', '"+title+"')});`
-  );
-
   // print out all files
   for (const file of paths) {
     if (!file.isDir) {
@@ -86,6 +73,20 @@ export const generate = async (argv: Record<string, string>) => {
   // wait unitl all files resolved
   const result = await Promise.all(parsePromises);
 
+  // write vuepress sidebar
+  await fs.writeFile(
+    `${docsFolder}/config.js`,
+    `exports.fileTree=${JSON.stringify(tree)};exports.sidebarTree = (title = 'Mainpage') => (${JSON.stringify(
+      generateVueSidebar({
+        fileTree: tree,
+        srcFolder,
+        docsFolder,
+        codeFolder,
+        title
+      })
+    ).replace('::vuepress-jsdoc-title::', '"+title+"')});`
+  );
+
   // print stats
   for (const entry of result.flat()) {
     if (!entry.file) continue;

src/index.ts

@@ -35,7 +35,7 @@ export const listFolder = async (srcPath: string, exclude: string[] = [], mainPa
 
       const treeEntry: FileTree = {
         name,
-        ...(!isDir ? { path: `/${name}`, fullPath: path.join(srcPath, name) } : {})
+        ...(!isDir ? { path: `/${name}`, fullPath: path.join(srcPath, name), ext } : {})
       };
 
       tree.push(treeEntry);

src/lib/list-folder.ts

@@ -1,4 +1,5 @@
 import fs from 'fs';
+import { join } from 'path';
 interface Node {
   name: string;
   children: any[];
@@ -8,11 +9,13 @@ export const generateVueSidebar = ({
   fileTree,
   codeFolder,
   srcFolder,
+  docsFolder,
   title
 }: {
   fileTree: any;
   codeFolder: string;
   srcFolder: string;
+  docsFolder: string;
   title: string;
 }) => {
   let rootFiles = [['', '::vuepress-jsdoc-title::']];
@@ -24,10 +27,10 @@ export const generateVueSidebar = ({
     let newChildren: any[] = [];
 
     for (const child of children) {
-      if (fs.existsSync(child.fullPath)) {
-        if (child.children && child.children.length > 0) {
-          newChildren = newChildren.concat(buildChildren(child.children, child.name, depth + 1));
-        } else if (child.fullPath) {
+      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}/`, ''));
         }
       }