vuepress-jsdoc 4.0.4 → 4.3.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
+## 4.3.0 (2022-02-15)
+
+* feat(include): add include flag, fix some bugs and improve performance ([082a60a](https://github.com/ph1p/vuepress-jsdoc/commit/082a60a))
+
+
+
+## 4.2.0 (2021-11-17)
+
+* 4.2.0 ([3cdbc8a](https://github.com/ph1p/vuepress-jsdoc/commit/3cdbc8a))
+* build(deps): update dependencies ([858dff8](https://github.com/ph1p/vuepress-jsdoc/commit/858dff8))
+
+
+
+## <small>4.1.1 (2021-10-05)</small>
+
+* 4.1.1 ([975b04f](https://github.com/ph1p/vuepress-jsdoc/commit/975b04f))
+* chore(deps): update dependencies ([b3ac12c](https://github.com/ph1p/vuepress-jsdoc/commit/b3ac12c))
+
+
+
+## 4.1.0 (2021-09-20)
+
+* 4.1.0 ([ac88980](https://github.com/ph1p/vuepress-jsdoc/commit/ac88980))
+* chore: update dependencies and documentation ([8e83013](https://github.com/ph1p/vuepress-jsdoc/commit/8e83013))
+
+
+
 ## <small>4.0.4 (2021-09-03)</small>
 
+* 4.0.4 ([1452e46](https://github.com/ph1p/vuepress-jsdoc/commit/1452e46))
 * refactor: fix some code smells ([a910cff](https://github.com/ph1p/vuepress-jsdoc/commit/a910cff))
 * docs: fix watch-mode and add more informations ([c356bcc](https://github.com/ph1p/vuepress-jsdoc/commit/c356bcc))
 * docs: remove old informations ([1e4f344](https://github.com/ph1p/vuepress-jsdoc/commit/1e4f344))

package/README.md

@@ -66,6 +66,7 @@ Use these options after `vuepress-jsdoc`.
 | --version         | -v    |                 | Show current version                                                                                                                            |
 | --readme          | -r    |                 | Path to custom readme file                                                                                                                      |
 | --exclude         | -e    |                 | Pattern to exclude files/folders (Comma seperated) - \*.test.js,exclude.js [more information](https://github.com/micromatch/micromatch#ismatch) |
+| --include         | -e    |                 | Pattern to include files/folders (Comma seperated) - \*.test.js,exclude.js [more information](https://github.com/micromatch/micromatch#ismatch) |
 | --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)                                                         |
@@ -162,7 +163,7 @@ Use `headline` to add a custom `h1` title.
 To use typescript, you have to install these dev-dependencies:
 
 ```bash
-yarn add -D typescript jsdoc-babel @babel/cli @babel/core @babel/preset-env @babel/preset-typescript jsdoc-to-markdown
+npm install -D typescript jsdoc-babel @babel/cli @babel/core @babel/preset-env @babel/preset-typescript jsdoc-to-markdown
 ```
 
 Next, you have to add a `jsdoc.json` to your project with some settings and add it with the `-c` parameter.

package/dist/cmds.d.ts

@@ -1,2 +1,8 @@
 declare const _default: (version: string) => void;
+/**
+ * This method builds the cli interface and is necessary because
+ * we need the version from the package.json here. We do not import
+ * this here, because otherwise the folder structure in the dist folder would get mixed up.
+ * @param {string} version a version string
+ */
 export default _default;

package/dist/cmds.js

@@ -1,7 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * @vuepress
+ * ---
+ * headline: cmds.ts
+ * ---
+ */
 var commander_1 = require("commander");
 var _1 = require(".");
+/**
+ * This method builds the cli interface and is necessary because
+ * we need the version from the package.json here. We do not import
+ * this here, because otherwise the folder structure in the dist folder would get mixed up.
+ * @param {string} version a version string
+ */
 exports.default = (function (version) {
     commander_1.program.version(version).description('a CLI Tool to generate markdown files for vuepress');
     commander_1.program
@@ -11,6 +23,7 @@ exports.default = (function (version) {
         .option('-f, --folder <string>', 'Folder inside destination folder. Gets overwritten everytime', 'code')
         .option('-t, --title <string>', 'Title of your documentation', 'API')
         .option('-r, --readme <string>', 'Path to your custom readme')
+        .option('-i, --include <string>', 'Pattern to include files/folders (Comma seperated) - *.test.js,include.js')
         .option('-e, --exclude <string>', 'Pattern to exclude files/folders (Comma seperated) - *.test.js,exclude.js')
         .option('-w, --watch', 'This flag watches your source files')
         .option('-rm, --rmPattern [files...]', 'Pattern when removing files. You can ex- and include files. (glob pattern)', '')

package/dist/index.d.ts

@@ -6,8 +6,8 @@ import { CLIArguments } from './interfaces';
 export declare const generate: (argv: CLIArguments) => Promise<void>;
 /**
  * The vuepress plugins
- * @param argv {CLIArguments}
- * @param ctx {object}
+ * @param {CLIArguments} argv
+ * @param {object} ctx
  * @returns {object}
  */
 declare const plugin: (argv: CLIArguments, ctx: any) => {

package/dist/index.js

@@ -88,7 +88,6 @@ var chokidar_1 = __importDefault(require("chokidar"));
 var del_1 = __importDefault(require("del"));
 var promises_1 = __importDefault(require("fs/promises"));
 var mkdirp_1 = __importDefault(require("mkdirp"));
-var path_1 = require("path");
 var readline_1 = __importDefault(require("readline"));
 var constants_1 = require("./constants");
 var list_folder_1 = require("./lib/list-folder");
@@ -96,66 +95,58 @@ var parser_1 = require("./lib/parser");
 var vue_sidebar_1 = require("./lib/vue-sidebar");
 /**
  * Create the sidebar
- * @param options {object}
+ * @param {object} options
  * @returns {Promise}
  */
 var createVuepressSidebar = function (options) {
-    return promises_1.default.writeFile(options.docsFolder + "/config.js", "exports.fileTree=" + JSON.stringify(options.fileTree) + ";exports.sidebarTree = (title = 'Mainpage') => (" + JSON.stringify((0, vue_sidebar_1.generateVueSidebar)(options)).replace('::vuepress-jsdoc-title::', '"+title+"') + ");");
+    return promises_1.default.writeFile("".concat(options.docsFolder, "/config.js"), "exports.fileTree=".concat(JSON.stringify(options.fileTree), ";exports.sidebarTree = (title = 'Mainpage') => (").concat(JSON.stringify((0, vue_sidebar_1.generateVueSidebar)(options)).replace('::vuepress-jsdoc-title::', '"+title+"'), ");"));
 };
 /**
  * Parse file
- * @param file {DirectoryFile}
- * @param argv {CLIArguments}
+ * @param {DirectoryFile} file
+ * @param {CLIArguments} argv
  * @returns {Promise}
  */
-var parseDirectoryFile = function (file, argv) { return __awaiter(void 0, void 0, void 0, function () {
-    var _a, srcFolder, docsFolder, partials, dest, content;
-    return __generator(this, function (_b) {
-        switch (_b.label) {
-            case 0:
-                _a = parseArguments(argv), srcFolder = _a.srcFolder, docsFolder = _a.docsFolder, partials = _a.partials;
-                if (!(!file.isDir && file.folder)) return [3 /*break*/, 5];
-                dest = (0, path_1.join)(docsFolder, file.folder.replace(srcFolder, ''));
-                content = void 0;
-                if (!['.jsx', '.tsx', '.ts', '.js'].includes(file.ext || '')) return [3 /*break*/, 2];
-                return [4 /*yield*/, (0, parser_1.parseFile)(file, srcFolder, docsFolder, argv.jsDocConfigPath, partials)];
-            case 1:
-                content = _b.sent();
-                _b.label = 2;
-            case 2:
-                if (!(file.ext === '.vue')) return [3 /*break*/, 4];
-                return [4 /*yield*/, (0, parser_1.parseVueFile)(file, srcFolder, docsFolder)];
-            case 3:
-                content = _b.sent();
-                _b.label = 4;
-            case 4: return [2 /*return*/, { content: content, dest: dest }];
-            case 5: return [2 /*return*/];
+var parseDirectoryFile = function (file, argv) {
+    var _a = parseArguments(argv), srcFolder = _a.srcFolder, docsFolder = _a.docsFolder, partials = _a.partials;
+    if (!file.isDir && file.folder) {
+        if (['.jsx', '.tsx', '.ts', '.js'].includes(file.ext || '')) {
+            return (0, parser_1.parseFile)(file, srcFolder, docsFolder, argv.jsDocConfigPath, partials);
         }
-    });
-}); };
+        if (file.ext === '.vue') {
+            return (0, parser_1.parseVueFile)(file, srcFolder, docsFolder);
+        }
+    }
+};
+/**
+ * Create the readme file. First page when entering the documentation.
+ * @param {CLIArguments} argv
+ * @param {string} deletedPaths
+ * @returns {void}
+ */
 var createReadmeFile = function (argv, deletedPaths) { return __awaiter(void 0, void 0, void 0, function () {
     var _a, srcFolder, codeFolder, docsFolder, title, readme, readMeContent, readmePath, e_1;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
                 _a = parseArguments(argv), srcFolder = _a.srcFolder, codeFolder = _a.codeFolder, docsFolder = _a.docsFolder, title = _a.title, readme = _a.readme;
-                readMeContent = "### Welcome to " + title;
-                readmePath = readme || srcFolder + "/README.md";
+                readMeContent = "### Welcome to ".concat(title);
+                readmePath = readme || "".concat(srcFolder, "/README.md");
                 _b.label = 1;
             case 1:
                 _b.trys.push([1, 3, , 4]);
                 return [4 /*yield*/, promises_1.default.readFile(readmePath, 'utf-8')];
             case 2:
                 readMeContent = _b.sent();
-                if (deletedPaths === null || deletedPaths === void 0 ? void 0 : deletedPaths.some(function (p) { return p.indexOf(codeFolder + "/README.md") !== -1; })) {
-                    console.log("\n" + chalk_1.default.white.bgBlack(' README ') + " " + chalk_1.default.dim(readmePath.replace('README.md', '')) + chalk_1.default.bold('README.md') + " \u2192  " + chalk_1.default.dim(docsFolder) + chalk_1.default.bold('/README.md'));
+                if (deletedPaths === null || deletedPaths === void 0 ? void 0 : deletedPaths.some(function (p) { return p.indexOf("".concat(codeFolder, "/README.md")) !== -1; })) {
+                    console.log("\n".concat(chalk_1.default.white.bgBlack(' README '), " ").concat(chalk_1.default.dim(readmePath.replace('README.md', ''))).concat(chalk_1.default.bold('README.md'), " \u2192  ").concat(chalk_1.default.dim(docsFolder)).concat(chalk_1.default.bold('/README.md')));
                 }
                 return [3 /*break*/, 4];
             case 3:
                 e_1 = _b.sent();
-                console.log("\n" + chalk_1.default.white.bgBlack(' README ') + " Add default README.md");
+                console.log("\n".concat(chalk_1.default.white.bgBlack(' README '), " Add default README.md"));
                 return [3 /*break*/, 4];
-            case 4: return [4 /*yield*/, promises_1.default.writeFile(docsFolder + "/README.md", readMeContent)];
+            case 4: return [4 /*yield*/, promises_1.default.writeFile("".concat(docsFolder, "/README.md"), readMeContent)];
             case 5:
                 _b.sent();
                 return [2 /*return*/];
@@ -164,15 +155,16 @@ var createReadmeFile = function (argv, deletedPaths) { return __awaiter(void 0,
 }); };
 /**
  * Parse all CLI arguments
- * @param argv {CLIArguments}
+ * @param {CLIArguments} argv
  * @returns {object} all arguments
  */
 var parseArguments = function (argv) {
     return {
+        include: (argv.include || '').split(',').filter(Boolean),
         exclude: (argv.exclude || '').split(',').filter(Boolean),
         srcFolder: argv.source.replace('./', ''),
         codeFolder: argv.folder,
-        docsFolder: argv.dist + "/" + argv.folder,
+        docsFolder: "".concat(argv.dist, "/").concat(argv.folder),
         title: argv.title,
         readme: argv.readme,
         rmPattern: argv.rmPattern || [],
@@ -184,17 +176,17 @@ var parseArguments = function (argv) {
  * @param {object} argv passed arguments
  */
 var generate = function (argv) { return __awaiter(void 0, void 0, void 0, function () {
-    var _a, exclude, srcFolder, codeFolder, docsFolder, title, rmPattern, startTime, deletedPaths, lsFolder, parsePromises, _b, _c, file, e_2_1, _d, _e, file, data, e_3_1, result, _f, _g, file, _h, _j, entry, color, resultTime;
+    var _a, exclude, include, srcFolder, codeFolder, docsFolder, title, rmPattern, startTime, deletedPaths, lsFolder, parsePromises, _b, _c, file, e_2_1, _loop_1, _d, _e, file, result, _f, _g, file, _h, _j, entry, color, resultTime;
     var e_2, _k, e_3, _l, e_4, _m, e_5, _o, _p;
     return __generator(this, function (_q) {
         switch (_q.label) {
             case 0:
-                _a = parseArguments(argv), exclude = _a.exclude, srcFolder = _a.srcFolder, codeFolder = _a.codeFolder, docsFolder = _a.docsFolder, title = _a.title, rmPattern = _a.rmPattern;
+                _a = parseArguments(argv), exclude = _a.exclude, include = _a.include, srcFolder = _a.srcFolder, codeFolder = _a.codeFolder, docsFolder = _a.docsFolder, title = _a.title, rmPattern = _a.rmPattern;
                 startTime = +new Date();
-                return [4 /*yield*/, (0, del_1.default)(__spreadArray([docsFolder + "/**/*"], __read(rmPattern), false))];
+                return [4 /*yield*/, (0, del_1.default)(__spreadArray(["".concat(docsFolder, "/**/*")], __read(rmPattern), false))];
             case 1:
                 deletedPaths = _q.sent();
-                return [4 /*yield*/, (0, list_folder_1.listFolder)(srcFolder, exclude)];
+                return [4 /*yield*/, (0, list_folder_1.listFolder)(srcFolder, exclude, include)];
             case 2:
                 lsFolder = _q.sent();
                 return [4 /*yield*/, (0, mkdirp_1.default)(docsFolder)];
@@ -212,7 +204,7 @@ var generate = function (argv) { return __awaiter(void 0, void 0, void 0, functi
                 if (!!file.isDir) return [3 /*break*/, 7];
                 readline_1.default.clearLine(process.stdout, 0);
                 readline_1.default.cursorTo(process.stdout, 0);
-                process.stdout.write(chalk_1.default.dim(" " + file.path + " "));
+                process.stdout.write(chalk_1.default.dim(" ".concat(file.path, " ")));
                 return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 20); })];
             case 6:
                 _q.sent();
@@ -234,38 +226,40 @@ var generate = function (argv) { return __awaiter(void 0, void 0, void 0, functi
             case 11:
                 readline_1.default.clearLine(process.stdout, 0);
                 readline_1.default.cursorTo(process.stdout, 0);
-                _q.label = 12;
-            case 12:
-                _q.trys.push([12, 17, 18, 19]);
-                _d = __values(lsFolder.paths), _e = _d.next();
-                _q.label = 13;
-            case 13:
-                if (!!_e.done) return [3 /*break*/, 16];
-                file = _e.value;
-                return [4 /*yield*/, parseDirectoryFile(file, argv)];
-            case 14:
-                data = _q.sent();
-                if (data) {
-                    parsePromises.push((0, parser_1.writeContentToFile)(data.content, data.dest));
-                }
-                _q.label = 15;
-            case 15:
-                _e = _d.next();
-                return [3 /*break*/, 13];
-            case 16: return [3 /*break*/, 19];
-            case 17:
-                e_3_1 = _q.sent();
-                e_3 = { error: e_3_1 };
-                return [3 /*break*/, 19];
-            case 18:
+                _loop_1 = function (file) {
+                    parsePromises.push((function () { return __awaiter(void 0, void 0, void 0, function () {
+                        var data;
+                        return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0: return [4 /*yield*/, parseDirectoryFile(file, argv)];
+                                case 1:
+                                    data = _a.sent();
+                                    if (data && (data === null || data === void 0 ? void 0 : data.relativePathDest)) {
+                                        return [2 /*return*/, (0, parser_1.writeContentToFile)(data, data.relativePathDest)];
+                                    }
+                                    return [2 /*return*/];
+                            }
+                        });
+                    }); })());
+                };
                 try {
-                    if (_e && !_e.done && (_l = _d.return)) _l.call(_d);
+                    // iterate through files and parse them
+                    for (_d = __values(lsFolder.paths), _e = _d.next(); !_e.done; _e = _d.next()) {
+                        file = _e.value;
+                        _loop_1(file);
+                    }
                 }
-                finally { if (e_3) throw e_3.error; }
-                return [7 /*endfinally*/];
-            case 19: return [4 /*yield*/, Promise.all(parsePromises)];
-            case 20:
+                catch (e_3_1) { e_3 = { error: e_3_1 }; }
+                finally {
+                    try {
+                        if (_e && !_e.done && (_l = _d.return)) _l.call(_d);
+                    }
+                    finally { if (e_3) throw e_3.error; }
+                }
+                return [4 /*yield*/, Promise.all(parsePromises)];
+            case 12:
                 result = _q.sent();
+                result = result.filter(Boolean);
                 // write vuepress sidebar
                 return [4 /*yield*/, createVuepressSidebar({
                         fileTree: lsFolder.tree,
@@ -274,14 +268,14 @@ var generate = function (argv) { return __awaiter(void 0, void 0, void 0, functi
                         codeFolder: codeFolder,
                         title: title
                     })];
-            case 21:
+            case 13:
                 // write vuepress sidebar
                 _q.sent();
                 try {
                     // print stats
                     for (_f = __values(lsFolder.excluded), _g = _f.next(); !_g.done; _g = _f.next()) {
                         file = _g.value;
-                        console.log(chalk_1.default.reset.inverse.bold.blue(' EXCLUDE '), "" + chalk_1.default.dim(file.folder) + chalk_1.default.bold(file.name + file.ext));
+                        console.log(chalk_1.default.reset.inverse.bold.blue(' EXCLUDE '), "".concat(chalk_1.default.dim(file.folder)).concat(chalk_1.default.bold(file.name + file.ext)));
                     }
                 }
                 catch (e_4_1) { e_4 = { error: e_4_1 }; }
@@ -303,7 +297,7 @@ var generate = function (argv) { return __awaiter(void 0, void 0, void 0, functi
                             _p[constants_1.StatisticType.EMPTY] = 'yellow',
                             _p[constants_1.StatisticType.EXCLUDE] = 'blue',
                             _p)[entry.type];
-                        console.log(chalk_1.default.reset.inverse.bold[color](" " + entry.type + " "), "" + chalk_1.default.dim(entry.relativePathSrc) + chalk_1.default.bold(entry.file.name + entry.file.ext) + " \u2192 " + chalk_1.default.dim(entry.relativePathDest) + chalk_1.default.bold(entry.file.name + '.md'));
+                        console.log(chalk_1.default.reset.inverse.bold[color](" ".concat(entry.type, " ")), "".concat(chalk_1.default.dim(entry.relativePathSrc)).concat(chalk_1.default.bold(entry.file.name + entry.file.ext), " \u2192 ").concat(chalk_1.default.dim(entry.relativePathDest)).concat(chalk_1.default.bold(entry.file.name + '.md')));
                     }
                 }
                 catch (e_5_1) { e_5 = { error: e_5_1 }; }
@@ -315,11 +309,11 @@ var generate = function (argv) { return __awaiter(void 0, void 0, void 0, functi
                 }
                 // create README.md
                 return [4 /*yield*/, createReadmeFile(argv, deletedPaths)];
-            case 22:
+            case 14:
                 // create README.md
                 _q.sent();
                 resultTime = (Math.abs(startTime - +new Date()) / 1000).toFixed(2);
-                console.log("\n\u23F0 Time: " + resultTime + "s");
+                console.log("\n\u23F0 Time: ".concat(resultTime, "s"));
                 watchFiles(argv);
                 return [2 /*return*/];
         }
@@ -328,53 +322,49 @@ var generate = function (argv) { return __awaiter(void 0, void 0, void 0, functi
 exports.generate = generate;
 /**
  * Watch files in source folder
- * @param argv {CLIArguments}
+ * @param {CLIArguments} argv
  */
 var watchFiles = function (argv) {
-    var _a = parseArguments(argv), exclude = _a.exclude, srcFolder = _a.srcFolder, codeFolder = _a.codeFolder, docsFolder = _a.docsFolder, title = _a.title;
+    var _a = parseArguments(argv), exclude = _a.exclude, include = _a.include, srcFolder = _a.srcFolder, codeFolder = _a.codeFolder, docsFolder = _a.docsFolder, title = _a.title;
     if (argv.watch) {
         console.log('\n---\n\n👀 watching files...');
-        var watcher = chokidar_1.default.watch([srcFolder, argv.readme, srcFolder + "/README.md"].filter(Boolean), {
+        var watcher = chokidar_1.default.watch([srcFolder, argv.readme, "".concat(srcFolder, "/README.md")].filter(Boolean), {
             ignored: /(^|[\/\\])\../,
             persistent: true
         });
         watcher.on('change', function (path) { return __awaiter(void 0, void 0, void 0, function () {
-            var lsFolder, file, data;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, list_folder_1.listFolder)(srcFolder, exclude)];
+            var lsFolder, file;
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, (0, list_folder_1.listFolder)(srcFolder, exclude, include)];
                     case 1:
-                        lsFolder = _a.sent();
+                        lsFolder = _b.sent();
                         file = lsFolder.paths.find(function (p) { return p.path === path; });
                         readline_1.default.clearLine(process.stdout, 0);
                         readline_1.default.cursorTo(process.stdout, 0);
-                        if (!(path === 'README.md' || path === srcFolder + "/README.md")) return [3 /*break*/, 3];
+                        if (!(path === 'README.md' || path === "".concat(srcFolder, "/README.md"))) return [3 /*break*/, 3];
                         return [4 /*yield*/, createReadmeFile(argv)];
                     case 2:
-                        _a.sent();
-                        _a.label = 3;
+                        _b.sent();
+                        _b.label = 3;
                     case 3:
-                        if (!file) return [3 /*break*/, 8];
-                        process.stdout.write(chalk_1.default.dim("update " + (file.name + file.ext)));
-                        return [4 /*yield*/, parseDirectoryFile(file, argv)];
-                    case 4:
-                        data = _a.sent();
-                        if (!data) return [3 /*break*/, 6];
-                        return [4 /*yield*/, (0, parser_1.writeContentToFile)(data.content, data.dest)];
-                    case 5:
-                        _a.sent();
-                        _a.label = 6;
-                    case 6: return [4 /*yield*/, createVuepressSidebar({
-                            fileTree: lsFolder.tree,
-                            srcFolder: srcFolder,
-                            docsFolder: docsFolder,
-                            codeFolder: codeFolder,
-                            title: title
-                        })];
-                    case 7:
-                        _a.sent();
-                        _a.label = 8;
-                    case 8: return [2 /*return*/];
+                        if (file) {
+                            process.stdout.write(chalk_1.default.dim("update ".concat(file.name + file.ext)));
+                            (_a = parseDirectoryFile(file, argv)) === null || _a === void 0 ? void 0 : _a.then(function (data) {
+                                if (data) {
+                                    (0, parser_1.writeContentToFile)(data, data.relativePathDest);
+                                }
+                                createVuepressSidebar({
+                                    fileTree: lsFolder.tree,
+                                    srcFolder: srcFolder,
+                                    docsFolder: docsFolder,
+                                    codeFolder: codeFolder,
+                                    title: title
+                                });
+                            });
+                        }
+                        return [2 /*return*/];
                 }
             });
         }); });
@@ -382,8 +372,8 @@ var watchFiles = function (argv) {
 };
 /**
  * The vuepress plugins
- * @param argv {CLIArguments}
- * @param ctx {object}
+ * @param {CLIArguments} argv
+ * @param {object} ctx
  * @returns {object}
  */
 var plugin = function (argv, ctx) { return ({

package/dist/interfaces.d.ts

@@ -6,6 +6,7 @@ export interface DirectoryFile {
     folder?: string;
 }
 export interface CLIArguments {
+    include: string;
     exclude: string;
     partials: string[];
     rmPattern: string[];

package/dist/lib/comment-parser.d.ts

@@ -1,7 +1,7 @@
 import { DirectoryFile } from '../interfaces';
 /**
  * Search in file for @vuepress comment
- * @param fileContent {string} content of given file
+ * @param {string} fileContent content of given file
  * @returns {object} object of found frontmatter data
  */
 export declare const parseComment: (fileContent: string) => import("front-matter").FrontMatterResult<Record<string, string>> | {
@@ -10,8 +10,8 @@ export declare const parseComment: (fileContent: string) => import("front-matter
 };
 /**
  * Helper function to get header as structured markdown
- * @param content {string} file content
- * @param file {object} file object
+ * @param {string} content file content
+ * @param {object} file file object
  * @returns {string} markdown header
  */
 export declare const parseVuepressFileHeader: (content: string, file: DirectoryFile) => string;

package/dist/lib/comment-parser.js

@@ -13,7 +13,7 @@ exports.parseVuepressFileHeader = exports.parseComment = void 0;
 var front_matter_1 = __importDefault(require("front-matter"));
 /**
  * Search in file for @vuepress comment
- * @param fileContent {string} content of given file
+ * @param {string} fileContent content of given file
  * @returns {object} object of found frontmatter data
  */
 var parseComment = function (fileContent) {
@@ -46,17 +46,17 @@ var parseComment = function (fileContent) {
 exports.parseComment = parseComment;
 /**
  * Helper function to get header as structured markdown
- * @param content {string} file content
- * @param file {object} file object
+ * @param {string} content file content
+ * @param {object} file file object
  * @returns {string} markdown header
  */
 var parseVuepressFileHeader = function (content, file) {
     var _a = (0, exports.parseComment)(content), frontmatter = _a.frontmatter, attributes = _a.attributes;
     var fileContent = '---\n';
-    fileContent += !(attributes === null || attributes === void 0 ? void 0 : attributes.title) ? "title: " + file.name : '';
+    fileContent += !(attributes === null || attributes === void 0 ? void 0 : attributes.title) ? "title: ".concat(file.name) : '';
     if (frontmatter) {
         fileContent += !(attributes === null || attributes === void 0 ? void 0 : attributes.title) ? '\n' : '';
-        fileContent += "" + frontmatter;
+        fileContent += "".concat(frontmatter);
     }
     fileContent += '\n---\n';
     if ((attributes === null || attributes === void 0 ? void 0 : attributes.title) || file.ext !== '.vue') {
@@ -67,7 +67,7 @@ var parseVuepressFileHeader = function (content, file) {
         else if (attributes === null || attributes === void 0 ? void 0 : attributes.title) {
             headline = attributes.title;
         }
-        fileContent += "\n# " + headline + "\n\n";
+        fileContent += "\n# ".concat(headline, "\n\n");
     }
     return fileContent;
 };

package/dist/lib/list-folder.d.ts

@@ -1,13 +1,14 @@
 import { DirectoryFile, FileTree } from '../interfaces';
 /**
  * Recursively traverse folders and return exluded files, a file list and a file tree.
- * @param srcPath {string} path to source dir
- * @param exclude {array} exluded file patter list
- * @param mainPath {string} path to hold source dir
- * @param tree {object} tree array
+ * @param {string} srcPath path to source dir
+ * @param {array} exclude exluded file patter list
+ * @param {array} include included file patter list
+ * @param {string} mainPath path to hold source dir
+ * @param {object} tree tree array
  * @returns {object} paths array, tree, excluded array
  */
-export declare const listFolder: (srcPath: string, exclude?: string[], mainPath?: string | undefined, tree?: FileTree[]) => Promise<{
+export declare const listFolder: (srcPath: string, exclude: string[], include: string[], mainPath?: string | undefined, tree?: FileTree[]) => Promise<{
     paths: DirectoryFile[];
     tree: FileTree[];
     excluded: DirectoryFile[];

package/dist/lib/list-folder.js

@@ -98,35 +98,50 @@ var micromatch_1 = __importDefault(require("micromatch"));
 var path_1 = __importDefault(require("path"));
 /**
  * Recursively traverse folders and return exluded files, a file list and a file tree.
- * @param srcPath {string} path to source dir
- * @param exclude {array} exluded file patter list
- * @param mainPath {string} path to hold source dir
- * @param tree {object} tree array
+ * @param {string} srcPath path to source dir
+ * @param {array} exclude exluded file patter list
+ * @param {array} include included file patter list
+ * @param {string} mainPath path to hold source dir
+ * @param {object} tree tree array
  * @returns {object} paths array, tree, excluded array
  */
-var listFolder = function (srcPath, exclude, mainPath, tree) {
-    if (exclude === void 0) { exclude = []; }
+var listFolder = function (srcPath, exclude, include, mainPath, tree) {
     if (tree === void 0) { tree = []; }
     return __awaiter(void 0, void 0, void 0, function () {
-        var paths, excluded, dirs, dirs_1, dirs_1_1, dirent, filePath, isDir, ext, name_1, folder, file, baseSrc, treeEntry, _a, _b, _c, _d, e_1_1;
-        var e_1, _e;
-        return __generator(this, function (_f) {
-            switch (_f.label) {
+        var paths, excluded, dirs, _a, dirs_1, dirs_1_1, dirent, filePath, isDir, ext, name_1, folder, file, baseSrc, treeEntry, _b, _c, _d, _e, e_1_1;
+        var e_1, _f;
+        return __generator(this, function (_g) {
+            switch (_g.label) {
                 case 0:
+                    if (!Boolean(exclude) || !Array.isArray(exclude)) {
+                        exclude = [];
+                    }
+                    if (!Boolean(include) || !Array.isArray(include)) {
+                        include = [];
+                    }
+                    exclude = exclude.filter(Boolean);
+                    include = include.filter(Boolean);
                     paths = [];
                     excluded = [];
+                    if (!srcPath) return [3 /*break*/, 2];
                     return [4 /*yield*/, promises_1.default.readdir(srcPath, {
                             withFileTypes: true
                         })];
                 case 1:
-                    dirs = _f.sent();
-                    _f.label = 2;
+                    _a = _g.sent();
+                    return [3 /*break*/, 3];
                 case 2:
-                    _f.trys.push([2, 10, 11, 12]);
-                    dirs_1 = __values(dirs), dirs_1_1 = dirs_1.next();
-                    _f.label = 3;
+                    _a = [];
+                    _g.label = 3;
                 case 3:
-                    if (!!dirs_1_1.done) return [3 /*break*/, 9];
+                    dirs = _a;
+                    _g.label = 4;
+                case 4:
+                    _g.trys.push([4, 12, 13, 14]);
+                    dirs_1 = __values(dirs), dirs_1_1 = dirs_1.next();
+                    _g.label = 5;
+                case 5:
+                    if (!!dirs_1_1.done) return [3 /*break*/, 11];
                     dirent = dirs_1_1.value;
                     filePath = path_1.default.join(srcPath, dirent.name);
                     isDir = dirent.isDirectory();
@@ -139,46 +154,47 @@ var listFolder = function (srcPath, exclude, mainPath, tree) {
                     file = __assign({ isDir: isDir, name: name_1, path: filePath }, (!isDir ? { ext: ext, folder: folder } : {}));
                     // skip readmes as they are automatically resolved
                     if (name_1.toLowerCase() === 'readme')
-                        return [3 /*break*/, 8];
+                        return [3 /*break*/, 10];
                     baseSrc = mainPath || srcPath;
-                    if (!!micromatch_1.default.isMatch(path_1.default.join(srcPath.replace(baseSrc, ''), dirent.name), exclude)) return [3 /*break*/, 7];
+                    if (!(micromatch_1.default.every(path_1.default.join(srcPath.replace(baseSrc, ''), dirent.name), __spreadArray(__spreadArray([], __read(include), false), __read(exclude.map(function (e) { return '!' + e; })), false)) ||
+                        isDir)) return [3 /*break*/, 9];
                     treeEntry = {
                         name: name_1
                     };
-                    if (!isDir) return [3 /*break*/, 5];
+                    if (!isDir) return [3 /*break*/, 7];
                     treeEntry.children = [];
-                    _b = (_a = paths.push).apply;
-                    _c = [paths];
-                    _d = [[]];
-                    return [4 /*yield*/, (0, exports.listFolder)(filePath, exclude, baseSrc, treeEntry.children)];
-                case 4:
-                    _b.apply(_a, _c.concat([__spreadArray.apply(void 0, _d.concat([__read.apply(void 0, [(_f.sent()).paths]), false]))]));
-                    return [3 /*break*/, 6];
-                case 5:
-                    treeEntry = __assign(__assign({}, treeEntry), { path: "/" + name_1, fullPath: path_1.default.join(srcPath, name_1), ext: ext });
-                    _f.label = 6;
+                    _c = (_b = paths.push).apply;
+                    _d = [paths];
+                    _e = [[]];
+                    return [4 /*yield*/, (0, exports.listFolder)(filePath, exclude, include, baseSrc, treeEntry.children)];
                 case 6:
-                    tree.push(treeEntry);
-                    paths.push(file);
+                    _c.apply(_b, _d.concat([__spreadArray.apply(void 0, _e.concat([__read.apply(void 0, [(_g.sent()).paths]), false]))]));
                     return [3 /*break*/, 8];
                 case 7:
-                    excluded.push(file);
-                    _f.label = 8;
+                    treeEntry = __assign(__assign({}, treeEntry), { path: "/".concat(name_1), fullPath: path_1.default.join(srcPath, name_1), ext: ext });
+                    _g.label = 8;
                 case 8:
-                    dirs_1_1 = dirs_1.next();
-                    return [3 /*break*/, 3];
-                case 9: return [3 /*break*/, 12];
+                    tree.push(treeEntry);
+                    paths.push(file);
+                    return [3 /*break*/, 10];
+                case 9:
+                    excluded.push(file);
+                    _g.label = 10;
                 case 10:
-                    e_1_1 = _f.sent();
+                    dirs_1_1 = dirs_1.next();
+                    return [3 /*break*/, 5];
+                case 11: return [3 /*break*/, 14];
+                case 12:
+                    e_1_1 = _g.sent();
                     e_1 = { error: e_1_1 };
-                    return [3 /*break*/, 12];
-                case 11:
+                    return [3 /*break*/, 14];
+                case 13:
                     try {
-                        if (dirs_1_1 && !dirs_1_1.done && (_e = dirs_1.return)) _e.call(dirs_1);
+                        if (dirs_1_1 && !dirs_1_1.done && (_f = dirs_1.return)) _f.call(dirs_1);
                     }
                     finally { if (e_1) throw e_1.error; }
                     return [7 /*endfinally*/];
-                case 12: return [2 /*return*/, { paths: paths, tree: tree, excluded: excluded }];
+                case 14: return [2 /*return*/, { paths: paths, tree: tree, excluded: excluded }];
             }
         });
     });

package/dist/lib/parser.d.ts

@@ -12,16 +12,16 @@ import { DirectoryFile, ParseReturn } from '../interfaces';
 export declare const parseFile: (file: DirectoryFile, srcFolder: string, destFolder: string, configPath: string, partials: string | string[]) => Promise<ParseReturn | null>;
 /**
  * Parse a vue file
- * @param file {DirectoryFile}
- * @param srcFolder {string}
- * @param destFolder {string}
+ * @param {DirectoryFile} file
+ * @param {string} srcFolder
+ * @param {string} destFolder
  * @returns {object} file data
  */
 export declare const parseVueFile: (file: DirectoryFile, srcFolder: string, destFolder: string) => Promise<ParseReturn | null>;
 /**
  * Write content on disk
- * @param parseData {ParseReturn | null}
- * @param dest {string}
+ * @param {ParseReturn | null} parseData
+ * @param {string} dest
  * @returns {Promise | null} null or type with some data of the saved file
  */
 export declare const writeContentToFile: (parseData: ParseReturn | null, dest: string) => Promise<{

package/dist/lib/parser.js

@@ -123,6 +123,7 @@ var parseFile = function (file, srcFolder, destFolder, configPath, partials) { r
                     fileName = 'index';
                 }
                 return [4 /*yield*/, jsdoc_to_markdown_1.default.render({
+                        'no-cache': configPath ? true : false,
                         files: [(0, path_1.join)(process.cwd(), file.folder, fileName + file.ext)],
                         configure: configPath,
                         partial: __spreadArray([
@@ -133,7 +134,7 @@ var parseFile = function (file, srcFolder, destFolder, configPath, partials) { r
             case 2:
                 content = _b.sent();
                 _a = comment_parser_1.parseVuepressFileHeader;
-                return [4 /*yield*/, promises_1.default.readFile("" + (0, path_1.join)(folderInSrc, fileName + file.ext), 'utf-8')];
+                return [4 /*yield*/, promises_1.default.readFile("".concat((0, path_1.join)(folderInSrc, fileName + file.ext)), 'utf-8')];
             case 3:
                 fileContent = _a.apply(void 0, [_b.sent(), file]);
                 if (content) {
@@ -164,9 +165,9 @@ var parseFile = function (file, srcFolder, destFolder, configPath, partials) { r
 exports.parseFile = parseFile;
 /**
  * Parse a vue file
- * @param file {DirectoryFile}
- * @param srcFolder {string}
- * @param destFolder {string}
+ * @param {DirectoryFile} file
+ * @param {string} srcFolder
+ * @param {string} destFolder
  * @returns {object} file data
  */
 var parseVueFile = function (file, srcFolder, destFolder) { return __awaiter(void 0, void 0, void 0, function () {
@@ -195,7 +196,7 @@ var parseVueFile = function (file, srcFolder, destFolder) { return __awaiter(voi
             case 2:
                 data = _b.sent();
                 _a = comment_parser_1.parseVuepressFileHeader;
-                return [4 /*yield*/, promises_1.default.readFile("" + (0, path_1.join)(folderInSrc, fileName + file.ext), 'utf-8')];
+                return [4 /*yield*/, promises_1.default.readFile("".concat((0, path_1.join)(folderInSrc, fileName + file.ext)), 'utf-8')];
             case 3:
                 fileContent = _a.apply(void 0, [_b.sent(), file]);
                 if (data.content) {
@@ -225,8 +226,8 @@ var parseVueFile = function (file, srcFolder, destFolder) { return __awaiter(voi
 exports.parseVueFile = parseVueFile;
 /**
  * Write content on disk
- * @param parseData {ParseReturn | null}
- * @param dest {string}
+ * @param {ParseReturn | null} parseData
+ * @param {string} dest
  * @returns {Promise | null} null or type with some data of the saved file
  */
 var writeContentToFile = function (parseData, dest) { return __awaiter(void 0, void 0, void 0, function () {
@@ -244,7 +245,7 @@ var writeContentToFile = function (parseData, dest) { return __awaiter(void 0, v
             case 1:
                 _b.trys.push([1, 5, , 6]);
                 if (!(parseData === null || parseData === void 0 ? void 0 : parseData.content)) return [3 /*break*/, 4];
-                path = (0, path_1.join)(dest, parseData.file.name) + ".md";
+                path = "".concat((0, path_1.join)(dest, parseData.file.name), ".md");
                 return [4 /*yield*/, (0, mkdirp_1.default)(dest)];
             case 2:
                 _b.sent();

package/dist/lib/utils.d.ts

@@ -1,19 +1,19 @@
 /**
  * Get extension of file
- * @param path {string}
+ * @param {string} path
  * @returns {string} extension of file
  */
 export declare const getExtension: (path: string) => string;
 /**
  * Check if extension ist correct
- * @param path {string}
- * @param extensions {string[]}
+ * @param {string} path
+ * @param {string[]} extensions
  * @returns {boolean}
  */
 export declare const checkExtension: (path: string, extensions: string[]) => boolean;
 /**
  * Get filename without extension
- * @param path {string}
+ * @param {string} path
  * @returns {string} filename
  */
 export declare const getFilename: (path: string) => string;

package/dist/lib/utils.js

@@ -9,26 +9,35 @@ exports.getFilename = exports.checkExtension = exports.getExtension = void 0;
  */
 /**
  * Get extension of file
- * @param path {string}
+ * @param {string} path
  * @returns {string} extension of file
  */
-var getExtension = function (path) { return path.substring(path.length, path.lastIndexOf('.')); };
+var getExtension = function (path) {
+    return path && typeof path === 'string' ? path.substring(path.length, path.lastIndexOf('.')) : '';
+};
 exports.getExtension = getExtension;
 /**
  * Check if extension ist correct
- * @param path {string}
- * @param extensions {string[]}
+ * @param {string} path
+ * @param {string[]} extensions
  * @returns {boolean}
  */
-var checkExtension = function (path, extensions) { return extensions.indexOf((0, exports.getExtension)(path)) >= 0; };
+var checkExtension = function (path, extensions) {
+    if (!extensions || !path || typeof path !== 'string')
+        return false;
+    return extensions.indexOf((0, exports.getExtension)(path)) >= 0;
+};
 exports.checkExtension = checkExtension;
 /**
  * Get filename without extension
- * @param path {string}
+ * @param {string} path
  * @returns {string} filename
  */
 var getFilename = function (path) {
-    var _a, _b;
-    return ((_b = (_a = path === null || path === void 0 ? void 0 : path.split('/')) === null || _a === void 0 ? void 0 : _a.pop()) === null || _b === void 0 ? void 0 : _b.substring(0, path.lastIndexOf('.'))) || '';
+    var _a;
+    if (!path || (path && typeof path !== 'string'))
+        return '';
+    var splitted = (_a = path.split('/').pop()) !== null && _a !== void 0 ? _a : path;
+    return splitted.substring(0, splitted.lastIndexOf('.'));
 };
 exports.getFilename = getFilename;

package/dist/lib/vue-sidebar.d.ts

@@ -1,11 +1,11 @@
 /**
  * Runs through the given tree structure and creates a vuepress config
- * @param data Informations to build config
- * @param data.fileTree {array} tree strcture
- * @param data.codeFolder {string}./code/ folder
- * @param data.srcFolder {string} ./src/ folder
- * @param data.docsFolder {string} ./documentation/ folder
- * @param data.title {string} title string
+ * @param {object} data Informations to build config
+ * @param {array} data.fileTree tree strcture
+ * @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
  */
 export declare const generateVueSidebar: ({ fileTree, codeFolder, srcFolder, docsFolder, title }: {

package/dist/lib/vue-sidebar.js

@@ -25,12 +25,12 @@ var fs_1 = __importDefault(require("fs"));
 var path_1 = require("path");
 /**
  * Runs through the given tree structure and creates a vuepress config
- * @param data Informations to build config
- * @param data.fileTree {array} tree strcture
- * @param data.codeFolder {string}./code/ folder
- * @param data.srcFolder {string} ./src/ folder
- * @param data.docsFolder {string} ./documentation/ folder
- * @param data.title {string} title string
+ * @param {object} data Informations to build config
+ * @param {array} data.fileTree tree strcture
+ * @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
  */
 var generateVueSidebar = function (_a) {
@@ -50,7 +50,7 @@ var generateVueSidebar = function (_a) {
                 }
                 else if (child.fullPath) {
                     if (fs_1.default.existsSync((0, path_1.join)(docsFolder, child.fullPath.replace(srcFolder, '')) + '.md')) {
-                        newChildren.push(child.fullPath.replace(srcFolder + "/", ''));
+                        newChildren.push(child.fullPath.replace("".concat(srcFolder, "/"), ''));
                     }
                 }
             }
@@ -70,7 +70,7 @@ var generateVueSidebar = function (_a) {
         children: buildChildren(folder.children, folder.name, 0)
     }); });
     return _b = {},
-        _b["/" + codeFolder + "/"] = [
+        _b["/".concat(codeFolder, "/")] = [
             {
                 title: title,
                 collapsable: false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vuepress-jsdoc",
-  "version": "4.0.4",
+  "version": "4.3.0",
   "description": "Generate jsdoc markdown files for vuepress",
   "main": "dist/index.js",
   "scripts": {
@@ -13,8 +13,8 @@
     "prepublishOnly": "npm i && npm run build",
     "prepare": "husky install",
     "version": "conventional-changelog -p karma -i CHANGELOG.md -s -r 0 && git add .",
-    "docs": "npx vuepress-jsdoc --source=./dist --partials=./example/partials/*.hbs --readme ./README.md --exclude=\"**/*.d.ts,**/interfaces.*,**/constants.*,**/cmds.*\"",
-    "docs:dev": "npm run docs && npx vuepress dev documentation",
+    "docs": "./bin/vuepress-jsdoc.js --source=./dist --partials=./example/partials/*.hbs --readme ./README.md --include=\"**/*.(ts|js)\" --exclude=\"**/*.d.ts,**/interfaces.*,**/constants.*\"",
+    "docs:dev": "npx concurrently --kill-others \"npm run dev\" \"npm run docs && npx vuepress dev documentation\"",
     "docs:build": "npm run build && npm run docs && npx vuepress build documentation"
   },
   "keywords": [
@@ -80,35 +80,35 @@
   },
   "dependencies": {
     "chalk": "^4.1.2",
-    "chokidar": "^3.5.2",
-    "commander": "^8.1.0",
+    "chokidar": "^3.5.3",
+    "commander": "^9.0.0",
     "del": "^6.0.0",
     "front-matter": "^4.0.2",
-    "jsdoc-to-markdown": "^7.0.1",
+    "jsdoc-to-markdown": "^7.1.1",
     "micromatch": "^4.0.4",
     "mkdirp": "^1.0.4",
-    "vue-docgen-cli": "^4.41.1"
+    "vue-docgen-cli": "^4.44.15"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.1",
-    "@types/jsdoc-to-markdown": "^7.0.1",
+    "@types/jest": "^27.4.0",
+    "@types/jsdoc-to-markdown": "^7.0.3",
     "@types/micromatch": "^4.0.2",
     "@types/mkdirp": "^1.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.30.0",
-    "@typescript-eslint/parser": "^4.30.0",
-    "babel-jest": "^27.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.12.0",
+    "@typescript-eslint/parser": "^5.12.0",
+    "babel-jest": "^27.5.1",
     "cross-env": "^7.0.3",
-    "eslint": "^7.32.0",
+    "eslint": "^8.9.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-jest": "^24.4.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jest": "^26.1.1",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "husky": "^7.0.2",
-    "jest": "^27.1.0",
-    "lint-staged": "^11.1.2",
-    "memfs": "^3.2.3",
-    "ts-jest": "^27.0.5",
-    "typescript": "^4.4.2"
+    "husky": "^7.0.4",
+    "jest": "^27.5.1",
+    "lint-staged": "^12.3.4",
+    "memfs": "^3.4.1",
+    "ts-jest": "^27.1.3",
+    "typescript": "^4.5.5"
   },
   "lint-staged": {
     "src/**/*.{css,scss,json}": [