vuepress-jsdoc 4.3.0 → 5.0.0

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

@@ -1,12 +1,12 @@
 /**
  * Runs through the given tree structure and creates a vuepress config
- * @param {object} data Informations to build config
- * @param {array} data.fileTree tree strcture
+ * @param {object} data Information to build config
+ * @param {array} data.fileTree tree structure
  * @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
+ * @returns {object} returns the vuepress menu structure
  */
 export declare const generateVueSidebar: ({ fileTree, codeFolder, srcFolder, docsFolder, title }: {
     fileTree: any;
@@ -16,8 +16,11 @@ export declare const generateVueSidebar: ({ fileTree, codeFolder, srcFolder, doc
     title: string;
 }) => {
     [x: string]: {
-        title: string;
+        text: string;
         collapsable: boolean;
-        children: string[][];
+        children: {
+            link: string;
+            text: string;
+        }[];
     }[];
 };

package/dist/lib/vue-sidebar.js

@@ -1,15 +1,4 @@
 "use strict";
-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 };
 };
@@ -21,62 +10,50 @@ exports.generateVueSidebar = void 0;
  * headline: lib/vue-sidebar.ts
  * ---
  */
-var fs_1 = __importDefault(require("fs"));
-var path_1 = require("path");
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = require("node:path");
 /**
  * Runs through the given tree structure and creates a vuepress config
- * @param {object} data Informations to build config
- * @param {array} data.fileTree tree strcture
+ * @param {object} data Information to build config
+ * @param {array} data.fileTree tree structure
  * @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
+ * @returns {object} returns the vuepress menu structure
  */
-var generateVueSidebar = function (_a) {
-    var _b;
-    var fileTree = _a.fileTree, codeFolder = _a.codeFolder, srcFolder = _a.srcFolder, docsFolder = _a.docsFolder, title = _a.title;
-    var rootFiles = [['', '::vuepress-jsdoc-title::']];
-    rootFiles = rootFiles.concat(fileTree.filter(function (file) { return !file.children; }).map(function (file) { return file.name; }));
-    var rootFolder = fileTree.filter(function (file) { return file.children && file.children.length > 0; });
-    var buildChildren = function (children, name, depth) {
-        var e_1, _a;
-        var newChildren = [];
-        try {
-            for (var children_1 = __values(children), children_1_1 = children_1.next(); !children_1_1.done; children_1_1 = children_1.next()) {
-                var child = children_1_1.value;
-                if (child.children && child.children.length > 0) {
-                    newChildren = newChildren.concat(buildChildren(child.children, child.name, depth + 1));
-                }
-                else if (child.fullPath) {
-                    if (fs_1.default.existsSync((0, path_1.join)(docsFolder, child.fullPath.replace(srcFolder, '')) + '.md')) {
-                        newChildren.push(child.fullPath.replace("".concat(srcFolder, "/"), ''));
-                    }
-                }
+const generateVueSidebar = ({ fileTree, codeFolder, srcFolder, docsFolder, title }) => {
+    let rootFiles = [{ link: `/${codeFolder}/`, text: '::vuepress-jsdoc-title::' }];
+    rootFiles = rootFiles.concat(fileTree.filter((file) => !file.children).map((file) => `/${(0, node_path_1.join)(codeFolder, file.name)}`));
+    const rootFolder = fileTree.filter((file) => file.children && file.children.length > 0);
+    const buildChildren = (children, name, depth) => {
+        let newChildren = [];
+        for (const child of children) {
+            if (child.children && child.children.length > 0) {
+                newChildren = newChildren.concat(buildChildren(child.children, child.name, depth + 1));
             }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (children_1_1 && !children_1_1.done && (_a = children_1.return)) _a.call(children_1);
+            else if (child.fullPath) {
+                const path = child.fullPath.replace(srcFolder, '');
+                if (node_fs_1.default.existsSync(`${(0, node_path_1.join)(docsFolder, path)}.md`)) {
+                    newChildren.push(`/${(0, node_path_1.join)(codeFolder, path)}`);
+                }
             }
-            finally { if (e_1) throw e_1.error; }
         }
         return newChildren;
     };
-    var tree = rootFolder.map(function (folder) { return ({
-        title: folder.name,
+    const tree = rootFolder.map((folder) => ({
+        text: folder.name,
         collapsable: false,
         children: buildChildren(folder.children, folder.name, 0)
-    }); });
-    return _b = {},
-        _b["/".concat(codeFolder, "/")] = [
+    }));
+    return {
+        [`/${codeFolder}/`]: [
             {
-                title: title,
+                text: title,
                 collapsable: false,
                 children: rootFiles
             }
-        ].concat(tree),
-        _b;
+        ].concat(tree)
+    };
 };
 exports.generateVueSidebar = generateVueSidebar;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vuepress-jsdoc",
-  "version": "4.3.0",
+  "version": "5.0.0",
   "description": "Generate jsdoc markdown files for vuepress",
   "main": "dist/index.js",
   "scripts": {
@@ -14,8 +14,8 @@
     "prepare": "husky install",
     "version": "conventional-changelog -p karma -i CHANGELOG.md -s -r 0 && git add .",
     "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"
+    "docs:dev": "npx concurrently --kill-others \"npm run dev\" \"npm run docs -- -w\" \"vuepress dev documentation\"",
+    "docs:build": "npm run build && npm run docs && vuepress build documentation"
   },
   "keywords": [
     "jsdoc",
@@ -79,36 +79,39 @@
     "vuepress-jsdoc": "bin/vuepress-jsdoc.js"
   },
   "dependencies": {
-    "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
-    "commander": "^9.0.0",
+    "commander": "^11.1.0",
     "del": "^6.0.0",
     "front-matter": "^4.0.2",
-    "jsdoc-to-markdown": "^7.1.1",
-    "micromatch": "^4.0.4",
-    "mkdirp": "^1.0.4",
-    "vue-docgen-cli": "^4.44.15"
+    "jsdoc-to-markdown": "^8.0.0",
+    "kleur": "^4.1.5",
+    "micromatch": "^4.0.5",
+    "mkdirp": "^3.0.1",
+    "vue-docgen-cli": "^4.67.0"
   },
   "devDependencies": {
-    "@types/jest": "^27.4.0",
-    "@types/jsdoc-to-markdown": "^7.0.3",
-    "@types/micromatch": "^4.0.2",
+    "@types/jest": "^29.5.10",
+    "@types/jsdoc-to-markdown": "^7.0.6",
+    "@types/micromatch": "^4.0.6",
     "@types/mkdirp": "^1.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.12.0",
-    "@typescript-eslint/parser": "^5.12.0",
-    "babel-jest": "^27.5.1",
+    "@typescript-eslint/eslint-plugin": "^6.12.0",
+    "@typescript-eslint/parser": "^6.12.0",
+    "@vuepress/client": "^2.0.0-rc.0",
+    "babel-jest": "^29.7.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.9.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jest": "^26.1.1",
+    "eslint": "^8.54.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-jest": "^27.6.0",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "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"
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.1.0",
+    "memfs": "^4.6.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.2",
+    "vue": "^3.3.8",
+    "vuepress": "^2.0.0-rc.0"
   },
   "lint-staged": {
     "src/**/*.{css,scss,json}": [