vuepress-jsdoc 4.3.1 → 5.0.0

package/CHANGELOG.md

@@ -1,6 +1,25 @@
+## 5.0.0 (2023-11-23)
+
+* feat(vuepress): switch to vuepress 2 ([351af08](https://github.com/ph1p/vuepress-jsdoc/commit/351af08))
+* build(deps): update dependencies ([2e85188](https://github.com/ph1p/vuepress-jsdoc/commit/2e85188))
+* build(deps): update example ([c9529fe](https://github.com/ph1p/vuepress-jsdoc/commit/c9529fe))
+* build(workflow): set node 16 in github action ([4822a0a](https://github.com/ph1p/vuepress-jsdoc/commit/4822a0a))
+* Make sidebar config compatible with Vuepress 2 ([592a7b5](https://github.com/ph1p/vuepress-jsdoc/commit/592a7b5))
+* Wait for async `extractConfig()` call to complete ([6ddb19f](https://github.com/ph1p/vuepress-jsdoc/commit/6ddb19f))
+
+
+### BREAKING CHANGE
+
+* no vuepress 1 support anymore, drop older node versions
+
+Switch from chalk to kleur
+Fix some bugs
+
+
 ## <small>4.3.1 (2022-10-06)</small>
 
-* build(deps): update dependencies and fix an npm script ([78a6e83](https://github.com/ph1p/vuepress-jsdoc/commit/78a6e83))
+* 4.3.1 ([8b596fb](https://github.com/ph1p/vuepress-jsdoc/commit/8b596fb))
+* build(deps): update dependencies and fix an npm script ([82a5b93](https://github.com/ph1p/vuepress-jsdoc/commit/82a5b93))
 * build(deps): update dependencies and rename success to include ([dd5b6c4](https://github.com/ph1p/vuepress-jsdoc/commit/dd5b6c4))
 * chore: audit example dependencies ([21823a1](https://github.com/ph1p/vuepress-jsdoc/commit/21823a1))
 * chore: drop node 14 ([ae30caf](https://github.com/ph1p/vuepress-jsdoc/commit/ae30caf))

package/README.md

@@ -4,10 +4,14 @@
 [![npm](https://img.shields.io/npm/v/vuepress-jsdoc.svg)](https://www.npmjs.com/package/vuepress-jsdoc)
 [![vercel](https://img.shields.io/badge/vercel-demo-black)](https://vuepress-jsdoc-example.vercel.app)
 
-This npm package is a command line script, which scans your JavaScript, Vue or Typescript source code and generates markdown files for vuepress with the help of [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) and [vue-docgen-cli](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-cli).
+This npm package serves as a command line script designed to analyze your JavaScript, Vue, or TypeScript source code. Leveraging [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) and [vue-docgen-cli](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-cli), it dynamically generates markdown files tailored for VuePress.
 
 ![CLI ./example](https://user-images.githubusercontent.com/15351728/131877824-0124e47f-9080-4976-88d0-84ad04b64f24.gif)
 
+## Vuepress support
+
+This npm package is compatible with VuePress 2; however, it requires a version lower than `5.0.0` for proper functionality with VuePress 1.
+
 ## How to
 
 ```bash
@@ -24,29 +28,6 @@ vuepress-jsdoc --source ./src --dist ./documentation --folder code --title API -
 
 You can also use `npx vuepress-jsdoc`, if you want.
 
-#### Plugin (Dev-Mode) `alpha`
-
-You can use `vuepress-jsdoc` also as plugin.
-This plugin watches you generated files.
-
-```javascript
-// ./documentation/.vuepress/config.js
-plugins: [
-  [
-    require('vuepress-jsdoc').default,
-    {
-      folder: 'code',
-      source: './dist',
-      dist: './documentation',
-      title: 'API',
-      partials: ['./example/partials/*.hbs'],
-      readme: './README.md',
-      exclude: '**/*.d.ts,**/interfaces.*,**/constants.*,**/cmds.*'
-    }
-  ]
-];
-```
-
 #### Watch-Mode `alpha`
 
 If you do not want to run`vuepress-jsdoc` again and again and again.
@@ -137,12 +118,13 @@ module.exports = {
 
 ## Custom readme
 
-You can easily add a custom path to your readme by using the `--readme ./path/to/file.md` parameter. If you move a `README.md` inside your source folder, it should resolve it automatically.
-You can set the title by passing it to the `sidebarTree('Mainpage title')` function inside your `./.vuepress/config.js`.
+To include a custom path for your readme, simply utilize the `--readme ./path/to/file.md` parameter. If you relocate a `README.md` file into your source folder, the system will automatically resolve it.
+
+For setting the title, provide it as an argument to the `sidebarTree('Mainpage title')` function within your `./.vuepress/config.js` file.
 
 ## @vuepress comment block
 
-You can add custom meta data to your pages by using the `@vuepress` block:
+Enhance your page customization by incorporating custom metadata through the `@vuepress` block:
 
 ```javascript
 /*
@@ -160,15 +142,13 @@ Use `headline` to add a custom `h1` title.
 
 ## Typescript
 
-To use typescript, you have to install these dev-dependencies:
+To integrate TypeScript support, install the following dev-dependencies with the following command:
 
 ```bash
 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.
-You can find a full working example with all settings inside the `./example` folder.
-The example shows also how to use babel-`plugins`.
+After installation, include a `jsdoc.json` file in your project with specific settings, and reference it using the `-c` parameter. For a comprehensive example with all the necessary configurations, refer to the `./example` folder. The example also demonstrates the usage of Babel plugins.
 
 ## Example
 

package/dist/cmds.js

@@ -6,15 +6,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * headline: cmds.ts
  * ---
  */
-var commander_1 = require("commander");
-var _1 = require(".");
+const commander_1 = require("commander");
+const _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) {
+exports.default = (version) => {
     commander_1.program.version(version).description('a CLI Tool to generate markdown files for vuepress');
     commander_1.program
         .description('Generate the md files')
@@ -31,4 +31,4 @@ exports.default = (function (version) {
         .option('-c, --jsDocConfigPath <string>', 'Path to jsdoc config')
         .action(_1.generate);
     commander_1.program.parse(process.argv);
-});
+};

package/dist/constants.js

@@ -7,4 +7,4 @@ var StatisticType;
     StatisticType["ERROR"] = "ERROR";
     StatisticType["INCLUDE"] = "INCLUDE";
     StatisticType["EXCLUDE"] = "EXCLUDE";
-})(StatisticType = exports.StatisticType || (exports.StatisticType = {}));
+})(StatisticType || (exports.StatisticType = StatisticType = {}));

package/dist/index.d.ts

@@ -5,13 +5,7 @@ import { CLIArguments } from './interfaces';
  */
 export declare const generate: (argv: CLIArguments) => Promise<void>;
 /**
- * The vuepress plugins
+ * Watch files in source folder
  * @param {CLIArguments} argv
- * @param {object} ctx
- * @returns {object}
  */
-declare const plugin: (argv: CLIArguments, ctx: any) => {
-    name: string;
-    ready: () => Promise<void>;
-};
-export default plugin;
+export declare const watchFiles: (argv: CLIArguments) => void;

package/dist/index.js

@@ -8,74 +8,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __read = (this && this.__read) || function (o, n) {
-    var m = typeof Symbol === "function" && o[Symbol.iterator];
-    if (!m) return o;
-    var i = m.call(o), r, ar = [], e;
-    try {
-        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-    }
-    catch (error) { e = { error: error }; }
-    finally {
-        try {
-            if (r && !r.done && (m = i["return"])) m.call(i);
-        }
-        finally { if (e) throw e.error; }
-    }
-    return ar;
-};
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-var __values = (this && this.__values) || function(o) {
-    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
-    if (m) return m.call(o);
-    if (o && typeof o.length === "number") return {
-        next: function () {
-            if (o && i >= o.length) o = void 0;
-            return { value: o && o[i++], done: !o };
-        }
-    };
-    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = void 0;
+exports.watchFiles = exports.generate = void 0;
 /*
  * @vuepress
  * ---
@@ -83,32 +20,30 @@ exports.generate = void 0;
  * headline: The Main File
  * ---
  */
-var chalk_1 = __importDefault(require("chalk"));
-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 readline_1 = __importDefault(require("readline"));
-var constants_1 = require("./constants");
-var list_folder_1 = require("./lib/list-folder");
-var parser_1 = require("./lib/parser");
-var vue_sidebar_1 = require("./lib/vue-sidebar");
+const chokidar_1 = __importDefault(require("chokidar"));
+const del_1 = __importDefault(require("del"));
+const kleur_1 = __importDefault(require("kleur"));
+const mkdirp_1 = require("mkdirp");
+const promises_1 = __importDefault(require("node:fs/promises"));
+const node_readline_1 = __importDefault(require("node:readline"));
+const constants_1 = require("./constants");
+const list_folder_1 = require("./lib/list-folder");
+const parser_1 = require("./lib/parser");
+const vue_sidebar_1 = require("./lib/vue-sidebar");
 /**
  * Create the sidebar
  * @param {object} options
  * @returns {Promise}
  */
-var createVuepressSidebar = function (options) {
-    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+"'), ");"));
-};
+const createVuepressSidebar = (options) => 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+"')});`);
 /**
  * Parse file
  * @param {DirectoryFile} file
  * @param {CLIArguments} argv
  * @returns {Promise}
  */
-var parseDirectoryFile = function (file, argv) {
-    var _a = parseArguments(argv), srcFolder = _a.srcFolder, docsFolder = _a.docsFolder, partials = _a.partials;
+const parseDirectoryFile = (file, argv) => {
+    const { srcFolder, docsFolder, partials } = parseArguments(argv);
     if (!file.isDir && file.folder) {
         if (['.jsx', '.tsx', '.ts', '.js'].includes(file.ext || '')) {
             return (0, parser_1.parseFile)(file, srcFolder, docsFolder, argv.jsDocConfigPath, partials);
@@ -124,47 +59,33 @@ var parseDirectoryFile = function (file, 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 ".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("".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".concat(chalk_1.default.white.bgBlack(' README '), " Add default README.md"));
-                return [3 /*break*/, 4];
-            case 4: return [4 /*yield*/, promises_1.default.writeFile("".concat(docsFolder, "/README.md"), readMeContent)];
-            case 5:
-                _b.sent();
-                return [2 /*return*/];
+const createReadmeFile = (argv, deletedPaths) => __awaiter(void 0, void 0, void 0, function* () {
+    const { srcFolder, codeFolder, docsFolder, title, readme } = parseArguments(argv);
+    let readMeContent = `### Welcome to ${title}`;
+    const readmePath = readme || `${srcFolder}/README.md`;
+    try {
+        readMeContent = yield promises_1.default.readFile(readmePath, 'utf-8');
+        if (deletedPaths === null || deletedPaths === void 0 ? void 0 : deletedPaths.some((p) => p.indexOf(`${codeFolder}/README.md`) !== -1)) {
+            console.log(`\n${kleur_1.default.white().bgBlack(' README ')} ${kleur_1.default.dim(readmePath.replace('README.md', ''))}${kleur_1.default.bold('README.md')} \u2192  ${kleur_1.default.dim(docsFolder)}${kleur_1.default.bold('/README.md')}`);
         }
-    });
-}); };
+    }
+    catch (e) {
+        console.log(`\n${kleur_1.default.white().bgBlack(' README ')} Add default README.md`);
+    }
+    yield promises_1.default.writeFile(`${docsFolder}/README.md`, readMeContent);
+});
 /**
  * Parse all CLI arguments
  * @param {CLIArguments} argv
  * @returns {object} all arguments
  */
-var parseArguments = function (argv) {
+const parseArguments = (argv) => {
     return {
         include: (argv.include || '').split(',').filter(Boolean),
         exclude: (argv.exclude || '').split(',').filter(Boolean),
         srcFolder: argv.source.replace('./', ''),
         codeFolder: argv.folder,
-        docsFolder: "".concat(argv.dist, "/").concat(argv.folder),
+        docsFolder: `${argv.dist}/${argv.folder}`,
         title: argv.title,
         readme: argv.readme,
         rmPattern: argv.rmPattern || [],
@@ -175,217 +96,105 @@ var parseArguments = function (argv) {
  * Default command that generate md files
  * @param {object} argv passed arguments
  */
-var generate = function (argv) { return __awaiter(void 0, void 0, void 0, function () {
-    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, 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(["".concat(docsFolder, "/**/*")], __read(rmPattern), false))];
-            case 1:
-                deletedPaths = _q.sent();
-                return [4 /*yield*/, (0, list_folder_1.listFolder)(srcFolder, exclude, include)];
-            case 2:
-                lsFolder = _q.sent();
-                return [4 /*yield*/, (0, mkdirp_1.default)(docsFolder)];
-            case 3:
-                _q.sent();
-                parsePromises = [];
-                _q.label = 4;
-            case 4:
-                _q.trys.push([4, 9, 10, 11]);
-                _b = __values(lsFolder.paths), _c = _b.next();
-                _q.label = 5;
-            case 5:
-                if (!!_c.done) return [3 /*break*/, 8];
-                file = _c.value;
-                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(" ".concat(file.path, " ")));
-                return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 20); })];
-            case 6:
-                _q.sent();
-                _q.label = 7;
-            case 7:
-                _c = _b.next();
-                return [3 /*break*/, 5];
-            case 8: return [3 /*break*/, 11];
-            case 9:
-                e_2_1 = _q.sent();
-                e_2 = { error: e_2_1 };
-                return [3 /*break*/, 11];
-            case 10:
-                try {
-                    if (_c && !_c.done && (_k = _b.return)) _k.call(_b);
-                }
-                finally { if (e_2) throw e_2.error; }
-                return [7 /*endfinally*/];
-            case 11:
-                readline_1.default.clearLine(process.stdout, 0);
-                readline_1.default.cursorTo(process.stdout, 0);
-                _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 {
-                    // 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);
-                    }
-                }
-                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,
-                        srcFolder: srcFolder,
-                        docsFolder: docsFolder,
-                        codeFolder: codeFolder,
-                        title: title
-                    })];
-            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 '), "".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 }; }
-                finally {
-                    try {
-                        if (_g && !_g.done && (_m = _f.return)) _m.call(_f);
-                    }
-                    finally { if (e_4) throw e_4.error; }
-                }
-                console.log();
-                try {
-                    for (_h = __values(result.flat()), _j = _h.next(); !_j.done; _j = _h.next()) {
-                        entry = _j.value;
-                        if (!entry.file)
-                            continue;
-                        color = (_p = {},
-                            _p[constants_1.StatisticType.INCLUDE] = 'green',
-                            _p[constants_1.StatisticType.ERROR] = 'red',
-                            _p[constants_1.StatisticType.EMPTY] = 'yellow',
-                            _p[constants_1.StatisticType.EXCLUDE] = 'blue',
-                            _p)[entry.type];
-                        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 }; }
-                finally {
-                    try {
-                        if (_j && !_j.done && (_o = _h.return)) _o.call(_h);
-                    }
-                    finally { if (e_5) throw e_5.error; }
-                }
-                // create README.md
-                return [4 /*yield*/, createReadmeFile(argv, deletedPaths)];
-            case 14:
-                // create README.md
-                _q.sent();
-                resultTime = (Math.abs(startTime - +new Date()) / 1000).toFixed(2);
-                console.log("\n\u23F0 Time: ".concat(resultTime, "s"));
-                watchFiles(argv);
-                return [2 /*return*/];
+const generate = (argv) => __awaiter(void 0, void 0, void 0, function* () {
+    const { exclude, include, srcFolder, codeFolder, docsFolder, title, rmPattern } = parseArguments(argv);
+    const startTime = +new Date();
+    // remove docs folder, except README.md
+    const deletedPaths = yield (0, del_1.default)([`${docsFolder}/**/*`, ...rmPattern]);
+    const lsFolder = yield (0, list_folder_1.listFolder)(srcFolder, exclude, include);
+    yield (0, mkdirp_1.mkdirp)(docsFolder);
+    const parsePromises = [];
+    // print out all files
+    for (const file of lsFolder.paths) {
+        if (!file.isDir) {
+            node_readline_1.default.clearLine(process.stdout, 0);
+            node_readline_1.default.cursorTo(process.stdout, 0);
+            process.stdout.write(kleur_1.default.dim(` ${file.path} `));
+            yield new Promise((resolve) => setTimeout(resolve, 20));
         }
+    }
+    node_readline_1.default.clearLine(process.stdout, 0);
+    node_readline_1.default.cursorTo(process.stdout, 0);
+    // iterate through files and parse them
+    for (const file of lsFolder.paths) {
+        parsePromises.push((() => __awaiter(void 0, void 0, void 0, function* () {
+            const data = yield parseDirectoryFile(file, argv);
+            if (data && (data === null || data === void 0 ? void 0 : data.relativePathDest)) {
+                return (0, parser_1.writeContentToFile)(data, data.relativePathDest);
+            }
+        }))());
+    }
+    // wait unitl all files resolved
+    let result = yield Promise.all(parsePromises);
+    result = result.filter(Boolean);
+    // write vuepress sidebar
+    yield createVuepressSidebar({
+        fileTree: lsFolder.tree,
+        srcFolder,
+        docsFolder,
+        codeFolder,
+        title
     });
-}); };
+    // print stats
+    for (const file of lsFolder.excluded) {
+        console.log(kleur_1.default.reset().inverse().bold().blue(' EXCLUDE '), `${kleur_1.default.dim(file.folder)}${kleur_1.default.bold(file.name + file.ext)}`);
+    }
+    console.log();
+    for (const entry of result.flat()) {
+        if (!entry.file)
+            continue;
+        const color = {
+            [constants_1.StatisticType.INCLUDE]: kleur_1.default.reset().inverse().bold().green,
+            [constants_1.StatisticType.ERROR]: kleur_1.default.reset().inverse().bold().red,
+            [constants_1.StatisticType.EMPTY]: kleur_1.default.reset().inverse().bold().yellow,
+            [constants_1.StatisticType.EXCLUDE]: kleur_1.default.reset().inverse().bold().blue
+        }[entry.type];
+        console.log(color(` ${entry.type} `), `${kleur_1.default.dim(entry.relativePathSrc)}${kleur_1.default.bold(entry.file.name + entry.file.ext)} \u2192 ${kleur_1.default.dim(entry.relativePathDest)}${kleur_1.default.bold(entry.file.name + '.md')}`);
+    }
+    // create README.md
+    yield createReadmeFile(argv, deletedPaths);
+    const resultTime = (Math.abs(startTime - +new Date()) / 1000).toFixed(2);
+    console.log(`\n⏰ Time: ${resultTime}s`);
+    (0, exports.watchFiles)(argv);
+});
 exports.generate = generate;
 /**
  * Watch files in source folder
  * @param {CLIArguments} argv
  */
-var watchFiles = function (argv) {
-    var _a = parseArguments(argv), exclude = _a.exclude, include = _a.include, srcFolder = _a.srcFolder, codeFolder = _a.codeFolder, docsFolder = _a.docsFolder, title = _a.title;
+const watchFiles = (argv) => {
+    const { exclude, include, srcFolder, codeFolder, docsFolder, title } = parseArguments(argv);
     if (argv.watch) {
         console.log('\n---\n\n👀 watching files...');
-        var watcher = chokidar_1.default.watch([srcFolder, argv.readme, "".concat(srcFolder, "/README.md")].filter(Boolean), {
+        const watcher = chokidar_1.default.watch([srcFolder, argv.readme, `${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;
+        watcher.on('change', (path) => __awaiter(void 0, void 0, void 0, function* () {
             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 = _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 === "".concat(srcFolder, "/README.md"))) return [3 /*break*/, 3];
-                        return [4 /*yield*/, createReadmeFile(argv)];
-                    case 2:
-                        _b.sent();
-                        _b.label = 3;
-                    case 3:
-                        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*/];
-                }
-            });
-        }); });
+            const lsFolder = yield (0, list_folder_1.listFolder)(srcFolder, exclude, include);
+            const file = lsFolder.paths.find((p) => p.path === path);
+            node_readline_1.default.clearLine(process.stdout, 0);
+            node_readline_1.default.cursorTo(process.stdout, 0);
+            if (path === 'README.md' || path === `${srcFolder}/README.md`) {
+                yield createReadmeFile(argv);
+            }
+            if (file) {
+                process.stdout.write(kleur_1.default.dim(`update ${file.name + file.ext}`));
+                (_a = parseDirectoryFile(file, argv)) === null || _a === void 0 ? void 0 : _a.then((data) => {
+                    if (data) {
+                        (0, parser_1.writeContentToFile)(data, data.relativePathDest);
+                    }
+                    createVuepressSidebar({
+                        fileTree: lsFolder.tree,
+                        srcFolder,
+                        docsFolder,
+                        codeFolder,
+                        title
+                    });
+                });
+            }
+        }));
     }
 };
-/**
- * The vuepress plugins
- * @param {CLIArguments} argv
- * @param {object} ctx
- * @returns {object}
- */
-var plugin = function (argv, ctx) { return ({
-    name: 'vuepress-plugin-jsdoc',
-    ready: function () { return __awaiter(void 0, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            if (!ctx.isProd) {
-                argv.watch = true;
-                watchFiles(argv);
-            }
-            return [2 /*return*/];
-        });
-    }); }
-}); };
-exports.default = plugin;
+exports.watchFiles = watchFiles;