refactor: add named exports

ph1p · Sep 1, 2021 · f3297ac · f3297ac
1 parent 4200177
commit f3297ac
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 12 deletions.
diff --git a/src/__tests__/comment-parser.test.ts b/src/__tests__/comment-parser.test.ts
@@ -1,4 +1,4 @@
-import commentParser from '../utils/comment-parser';
+import { parseComment } from '../utils/comment-parser';
 
 const template = `/*
 * @vuepress
@@ -9,8 +9,8 @@ const template = `/*
 * ---
 */`;
 
-describe('commentParser', () => {
-  const { attributes } = commentParser(template);
+describe('parseComment()', () => {
+  const { attributes } = parseComment(template);
 
   test('Title to be "Your custom title"', () => {
     expect(attributes?.title).toBe('Your custom title');
@@ -23,9 +23,9 @@ describe('commentParser', () => {
   });
 });
 
-describe('commentParser fail', () => {
+describe('parseComment() fail', () => {
   // @ts-expect-error check empty method
-  const { frontmatter } = commentParser();
+  const { frontmatter } = parseComment();
 
   test('fontmatter should be null', () => {
     expect(frontmatter).toBe(null);

diff --git a/src/__tests__/sidebar.test.ts b/src/__tests__/sidebar.test.ts
@@ -1,7 +1,7 @@
-import vueSidebar from '../utils/vue-sidebar';
+import { generateVueSidebar } from '../utils/vue-sidebar';
 
 describe('test sidebar', () => {
-  test('vueSidebar should return valid vue config', () => {
+  test('generateVueSidebar should return valid vue config', () => {
     const codeFolder = 'test_folder';
     const title = 'test_folder';
     const fileTree = [
@@ -25,7 +25,7 @@ describe('test sidebar', () => {
       { name: 'tests', children: [] }
     ];
 
-    const sidebar = vueSidebar({ fileTree, codeFolder, title });
+    const sidebar = generateVueSidebar({ fileTree, codeFolder, title });
 
     const result = {
       [`/${codeFolder}/`]: [

diff --git a/src/utils/comment-parser.ts b/src/utils/comment-parser.ts
@@ -2,7 +2,7 @@ import fm from 'front-matter';
 
 import { DirectoryFile } from '../interfaces';
 
-const parseComment = (fileContent: string) => {
+export const parseComment = (fileContent: string) => {
   try {
     const allCommentBlocks = fileContent.match(/\/*[\s\S]*\/.*/g);
     const vuepressBlock = allCommentBlocks?.filter((block: string) => {
@@ -60,5 +60,3 @@ export const parseVuepressFileHeader = (content: string, file: DirectoryFile) =>
 
   return fileContent;
 };
-
-export default parseComment;
diff --git a/src/utils/vue-sidebar.ts b/src/utils/vue-sidebar.ts
@@ -4,7 +4,15 @@ interface Node {
   children: any[];
 }
 
-export default ({ fileTree, codeFolder, title }: { fileTree: any; codeFolder: string; title: string }) => {
+export const generateVueSidebar = ({
+  fileTree,
+  codeFolder,
+  title
+}: {
+  fileTree: any;
+  codeFolder: string;
+  title: string;
+}) => {
   let rootFiles = [['', '::vuepress-jsdoc-title::']];
   rootFiles = rootFiles.concat(fileTree.filter((file: Node) => !file.children).map((file: Node) => file.name));