refactor: update watch mode and fix some bugs

ph1p · Sep 2, 2021 · 7b5debd · 7b5debd
1 parent 6097456
commit 7b5debd
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,32 @@ npm i vuepress-jsdoc -g
 vuepress-jsdoc --source ./src --dist ./documentation --folder code --title API --exclude=**/*/*.test.js
 ```
 
+#### Plugin (Dev-Mode) `alpha`
+
+You can use `vuepress-jsdoc` also as plugin.
+This plugin watches you generated files.
+
+```javascript
+// .vuepress/config.js
+plugins: [
+  [
+    require('vuepress-jsdoc').default,
+    {
+      folder: 'code',
+      jsDocConfigPath: './jsdoc.json',
+      source: './src',
+      dist: './documentation',
+      title: 'API'
+    }
+  ]
+];
+```
+
+#### Watch-Mode `alpha`
+
+If you do not want to run`vuepress-jsdoc` again and again and again.
+You can simply pass `--watch` or `-w`.
+
 ### Commands
 
 If no command passed it will run `generate` as default
@@ -45,6 +71,7 @@ If no command passed it will run `generate` as default
 | --rmPattern       | -rm   |                 | Pattern when removing files. You can ex- and include files. (glob pattern)                                                                      |
 | --partials        | -p    |                 | jsdoc2markdown partial templates (overwrites default ones)                                                                                      |
 | --jsDocConfigPath | -c    |                 | Path to [JsDoc Config](http://usejsdoc.org/about-configuring-jsdoc.html) (experimental)                                                         |
+| --watch           | -w    |                 | Watch changes and update markdown files                                                                                                         |
 
 ### config.js
 

diff --git a/example/documentation/.vuepress/config.js b/example/documentation/.vuepress/config.js
@@ -14,11 +14,7 @@ module.exports = {
         jsDocConfigPath: './jsdoc.json',
         source: './src',
         dist: './documentation',
-        title: 'API',
-        exclude: 'class.js',
-        partials: './partials/*.hbs',
-        readme: './README.md',
-        watch: true
+        title: 'API'
       }
     ]
   ],*/

diff --git a/package.json b/package.json
@@ -2,14 +2,15 @@
   "name": "vuepress-jsdoc",
   "version": "3.7.1",
   "description": "Generate jsdoc markdown files for vuepress",
+  "main": "dist/index.js",
   "scripts": {
     "test": "jest",
     "test-coverage": "cross-env NODE_ENV=test jest --coverage",
     "test-watch": "cross-env NODE_ENV=test jest --watchAll",
     "lint": "eslint --ext .tsx,.ts,.json,.js src/ --fix",
     "dev": "npm run build -- -w",
     "build": "tsc",
-    "prepublishOnly": "npm ci && npm run build",
+    "prepublishOnly": "npm i && npm run build",
     "prepare": "husky install",
     "version": "conventional-changelog -p karma -i CHANGELOG.md -s -r 0 && git add ."
   },

diff --git a/src/index.ts b/src/index.ts
@@ -41,6 +41,28 @@ const parseDirectoryFile = async (file: DirectoryFile, argv: CLIArguments) => {
   }
 };
 
+const createReadmeFile = async (argv: CLIArguments, deletedPaths?: string[]) => {
+  const { srcFolder, codeFolder, docsFolder, title, readme } = parseArguments(argv);
+
+  let readMeContent = `### Welcome to ${title}`;
+  const readmePath = readme || `${srcFolder}/README.md`;
+
+  try {
+    readMeContent = await fs.readFile(readmePath, 'utf-8');
+    if (deletedPaths?.some(p => p.indexOf(`${codeFolder}/README.md`) !== -1)) {
+      console.log(
+        `\n${chalk.white.bgBlack(' README ')} ${chalk.dim(readmePath.replace('README.md', ''))}${chalk.bold(
+          'README.md'
+        )} \u2192  ${chalk.dim(docsFolder)}${chalk.bold('/README.md')}`
+      );
+    }
+  } catch (e) {
+    console.log(`\n${chalk.white.bgBlack(' README ')} Add default README.md`);
+  }
+
+  await fs.writeFile(`${docsFolder}/README.md`, readMeContent);
+};
+
 const parseArguments = (argv: CLIArguments) => {
   return {
     exclude: (argv.exclude || '').split(',').filter(Boolean),
@@ -59,7 +81,7 @@ const parseArguments = (argv: CLIArguments) => {
  * @param {object} argv passed arguments
  */
 export const generate = async (argv: CLIArguments) => {
-  const { exclude, srcFolder, codeFolder, docsFolder, title, readme, rmPattern } = parseArguments(argv);
+  const { exclude, srcFolder, codeFolder, docsFolder, title, rmPattern } = parseArguments(argv);
 
   const startTime = +new Date();
 
@@ -133,27 +155,7 @@ export const generate = async (argv: CLIArguments) => {
   }
 
   // create README.md
-  let readMeContent = `### Welcome to ${title}`;
-  const readmePath = readme || `${srcFolder}/README.md`;
-
-  try {
-    readMeContent = await fs.readFile(readmePath, 'utf-8');
-    if (deletedPaths.some(p => p.indexOf(`${codeFolder}/README.md`) !== -1)) {
-      console.log(
-        `\n${chalk.white.bgBlack(' README ')} ${chalk.dim(readmePath.replace('README.md', ''))}${chalk.bold(
-          'README.md'
-        )} \u2192  ${chalk.dim(docsFolder)}${chalk.bold('/README.md')}`
-      );
-    }
-  } catch (e) {
-    console.log(`\n${chalk.white.bgBlack(' README ')} Add default README.md`);
-  }
-
-  try {
-    await fs.access(`${docsFolder}/README.md`);
-  } catch (e) {
-    await fs.writeFile(`${docsFolder}/README.md`, readMeContent);
-  }
+  await createReadmeFile(argv, deletedPaths);
 
   const resultTime = (Math.abs(startTime - +new Date()) / 1000).toFixed(2);
 
@@ -167,7 +169,7 @@ const watchFiles = (argv: CLIArguments) => {
 
   if (argv.watch) {
     console.log('\n---\n\n👀 watching files...');
-    const watcher = chokidar.watch(srcFolder, {
+    const watcher = chokidar.watch([srcFolder, argv.readme, `${srcFolder}/README.md`].filter(Boolean), {
       ignored: /(^|[\/\\])\../,
       persistent: true
     });
@@ -176,10 +178,16 @@ const watchFiles = (argv: CLIArguments) => {
       const lsFolder = await listFolder(srcFolder, exclude);
       const file = lsFolder.paths.find(p => p.path === path);
 
+      readline.clearLine(process.stdout, 0);
+      readline.cursorTo(process.stdout, 0);
+
+      if (path === 'README.md' || path === `${srcFolder}/README.md`) {
+        await createReadmeFile(argv);
+      }
+
       if (file) {
-        readline.clearLine(process.stdout, 0);
-        readline.cursorTo(process.stdout, 0);
         process.stdout.write(chalk.dim(`update ${file.name + file.ext}`));
+
         const data = await parseDirectoryFile(file, argv);
         if (data) {
           await writeContentToFile(data.content, data.dest);
@@ -201,6 +209,7 @@ export default (argv: CLIArguments, ctx) => ({
   name: 'vuepress-plugin-jsdoc',
   ready: async () => {
     if (!ctx.isProd) {
+      argv.watch = true;
       watchFiles(argv);
     }
   }

diff --git a/src/interfaces.ts b/src/interfaces.ts
@@ -29,3 +29,10 @@ export interface ParseReturn {
   relativePathSrc: string;
   relativePathDest: string;
 }
+
+export interface FileTree {
+  name: string;
+  path?: string;
+  fullPath?: string;
+  children?: FileTree[];
+}
diff --git a/src/lib/list-folder.ts b/src/lib/list-folder.ts
@@ -2,14 +2,7 @@ import fs from 'fs/promises';
 import mm from 'micromatch';
 import path from 'path';
 
-import { DirectoryFile } from '../interfaces';
-
-interface FileTree {
-  name: string;
-  path?: string;
-  fullPath?: string;
-  children?: FileTree[];
-}
+import { DirectoryFile, FileTree } from '../interfaces';
 
 export const listFolder = async (srcPath: string, exclude: string[] = [], mainPath?: string, tree: FileTree[] = []) => {
   const paths: DirectoryFile[] = [];