fix(config): exclude files by jsdoc config

ph1p · Sep 2, 2021 · af706c5 · af706c5
1 parent 0e2fc24
commit af706c5
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 17 deletions.
diff --git a/example/documentation/code/config.js b/example/documentation/code/config.js
diff --git a/example/jsdoc.json b/example/jsdoc.json
@@ -22,6 +22,6 @@
   "recurseDepth": 10,
   "source": {
     "includePattern": ".+\\.(js|ts)(doc|x)?$",
-    "excludePattern": ".+\\.(test|spec).ts"
+    "excludePattern": ".+\\.(test|spec).js"
   }
 }
diff --git a/example/package.json b/example/package.json
@@ -4,7 +4,7 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "docs": "../bin/vuepress-jsdoc.js -c ./jsdoc.json --source=./src --dist=./documentation --title=API --exclude=**/*/*.test.js,class.js --partials=./partials/*.hbs --readme=./README.md",
+    "docs": "../bin/vuepress-jsdoc.js --jsDocConfigPath ./jsdoc.json --source=./src --dist=./documentation --title=API --exclude=class.js --partials=./partials/*.hbs --readme=./README.md",
     "dev": "vuepress dev documentation",
     "build": "vuepress build documentation"
   },

diff --git a/src/index.ts b/src/index.ts
@@ -92,7 +92,8 @@ export const generate = async (argv: Record<string, string>) => {
     const color = {
       [StatisticType.SUCCESS]: 'green',
       [StatisticType.ERROR]: 'red',
-      [StatisticType.EMPTY]: 'yellow'
+      [StatisticType.EMPTY]: 'yellow',
+      [StatisticType.EXCLUDE]: 'blue'
     }[entry.type];
 
     console.log(

diff --git a/src/lib/list-folder.ts b/src/lib/list-folder.ts
@@ -53,7 +53,7 @@ export const listFolder = async (srcPath: string, exclude: string[] = [], mainPa
       });
     } else {
       // excluded
-      console.log(chalk.reset.inverse.bold.blue('EXCLUDE '), `${chalk.dim('src')}/${chalk.bold(name + ext)}`);
+      console.log(chalk.reset.inverse.bold.blue(' EXCLUDE '), `${chalk.dim('src')}/${chalk.bold(name + ext)}`);
     }
   }
 

diff --git a/src/lib/parser.ts b/src/lib/parser.ts
@@ -1,3 +1,4 @@
+import chalk from 'chalk';
 import fs from 'fs/promises';
 import jsdoc2md from 'jsdoc-to-markdown';
 import mkdirp from 'mkdirp';
@@ -15,7 +16,8 @@ interface ParseReturn {
   dest: string;
   file: DirectoryFile;
   content: string;
-  isEmpty: boolean;
+  empty: boolean;
+  excluded?: boolean;
   relativePathSrc: string;
   relativePathDest: string;
 }
@@ -35,14 +37,17 @@ export const parseFile = async (
   const folderInSrc = join(root, file.folder);
 
   let success = true;
-  let isEmpty = false;
+  let empty = false;
+  let excluded = false;
   let fileContent = '';
 
   // parse file
   try {
-    const content = await jsdoc2md.render({
-      files: [`${join(folderInSrc, file.name + file.ext)}`],
-      configure: join(root, configPath),
+    let content = '';
+
+    content = await jsdoc2md.render({
+      files: [join(file.folder, file.name + file.ext)],
+      configure: configPath,
       partial: [
         resolve(__filename, '../../../template/header.hbs'),
         resolve(__filename, '../../../template/main.hbs'),
@@ -58,17 +63,18 @@ export const parseFile = async (
     if (content) {
       fileContent += content;
     } else {
-      isEmpty = true;
+      empty = true;
     }
   } catch (e) {
-    console.log(e);
     success = false;
+    excluded = true;
   }
 
   return {
     success,
     file,
-    isEmpty,
+    empty,
+    excluded,
     relativePathDest,
     relativePathSrc: file.folder,
     dest: folderInDest,
@@ -94,7 +100,7 @@ export const parseVueFile = async (
   };
 
   let success = true;
-  let isEmpty = false;
+  let empty = false;
   let fileContent = '';
 
   try {
@@ -113,7 +119,7 @@ export const parseVueFile = async (
     if (data.content) {
       fileContent += data.content;
     } else {
-      isEmpty = true;
+      empty = true;
     }
   } catch (e) {
     console.log(e);
@@ -123,7 +129,7 @@ export const parseVueFile = async (
   return {
     success,
     file,
-    isEmpty,
+    empty,
     relativePathDest,
     relativePathSrc: file.folder,
     dest: folderInDest,
@@ -137,14 +143,18 @@ export const writeContentToFile = async (parseData: ParseReturn | null, dest: st
 
   let type = StatisticType.ERROR;
 
+  if (parseData?.excluded) {
+    type = StatisticType.EXCLUDE;
+  }
+
   try {
     if (parseData?.content) {
       const path = `${join(dest, parseData.file.name)}.md`;
 
       await mkdirp(dest);
       await fs.writeFile(path, parseData.content, 'utf-8');
 
-      type = parseData?.isEmpty ? StatisticType.EMPTY : StatisticType.SUCCESS;
+      type = parseData?.empty ? StatisticType.EMPTY : StatisticType.SUCCESS;
     }
 
     return {