vuepress-jsdoc 4.3.1 → 5.0.0

package/dist/lib/comment-parser.js

@@ -10,17 +10,17 @@ exports.parseVuepressFileHeader = exports.parseComment = void 0;
  * headline: lib/comment-parser.ts
  * ---
  */
-var front_matter_1 = __importDefault(require("front-matter"));
+const front_matter_1 = __importDefault(require("front-matter"));
 /**
  * Search in file for @vuepress comment
  * @param {string} fileContent content of given file
  * @returns {object} object of found frontmatter data
  */
-var parseComment = function (fileContent) {
+const parseComment = (fileContent) => {
     try {
-        var allCommentBlocks = fileContent.match(/\/\*[\s\S]*?\*\/|([^:]|^)\/\/.*$/g);
-        var vuepressBlock = allCommentBlocks === null || allCommentBlocks === void 0 ? void 0 : allCommentBlocks.filter(function (block) {
-            return block.split('\n').filter(function (line) { return line.indexOf('@vuepress') >= 0; }).length;
+        const allCommentBlocks = fileContent.match(/\/\*[\s\S]*?\*\/|([^:]|^)\/\/.*$/g);
+        const vuepressBlock = allCommentBlocks === null || allCommentBlocks === void 0 ? void 0 : allCommentBlocks.filter((block) => {
+            return block.split('\n').filter(line => line.indexOf('@vuepress') >= 0).length;
         })[0];
         if (!vuepressBlock) {
             return {
@@ -50,24 +50,24 @@ exports.parseComment = parseComment;
  * @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: ".concat(file.name) : '';
+const parseVuepressFileHeader = (content, file) => {
+    const { frontmatter, attributes } = (0, exports.parseComment)(content);
+    let fileContent = '---\n';
+    fileContent += !(attributes === null || attributes === void 0 ? void 0 : attributes.title) ? `title: ${file.name}` : '';
     if (frontmatter) {
         fileContent += !(attributes === null || attributes === void 0 ? void 0 : attributes.title) ? '\n' : '';
-        fileContent += "".concat(frontmatter);
+        fileContent += `${frontmatter}`;
     }
     fileContent += '\n---\n';
     if ((attributes === null || attributes === void 0 ? void 0 : attributes.title) || file.ext !== '.vue') {
-        var headline = file.name;
+        let headline = file.name;
         if (attributes === null || attributes === void 0 ? void 0 : attributes.headline) {
             headline = attributes.headline;
         }
         else if (attributes === null || attributes === void 0 ? void 0 : attributes.title) {
             headline = attributes.title;
         }
-        fileContent += "\n# ".concat(headline, "\n\n");
+        fileContent += `\n# ${headline}\n\n`;
     }
     return fileContent;
 };

package/dist/lib/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get extension of file
+ * @param {string} path
+ * @returns {string} extension of file
+ */
+export declare const getExtension: (path: string) => string;

package/dist/lib/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExtension = void 0;
+/*
+ * @vuepress
+ * ---
+ * headline: lib/utils.ts
+ * ---
+ */
+/**
+ * Get extension of file
+ * @param {string} path
+ * @returns {string} extension of file
+ */
+const getExtension = (path) => path && typeof path === 'string' ? path.substring(path.length, path.lastIndexOf('.')) : '';
+exports.getExtension = getExtension;

package/dist/lib/list-folder.js

@@ -1,15 +1,4 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -19,69 +8,6 @@ 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 __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 __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 __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -93,9 +19,9 @@ exports.listFolder = void 0;
  * headline: lib/list-folder.ts
  * ---
  */
-var promises_1 = __importDefault(require("fs/promises"));
-var micromatch_1 = __importDefault(require("micromatch"));
-var path_1 = __importDefault(require("path"));
+const micromatch_1 = __importDefault(require("micromatch"));
+const promises_1 = __importDefault(require("node:fs/promises"));
+const node_path_1 = __importDefault(require("node:path"));
 /**
  * Recursively traverse folders and return exluded files, a file list and a file tree.
  * @param {string} srcPath path to source dir
@@ -105,98 +31,56 @@ var path_1 = __importDefault(require("path"));
  * @param {object} tree tree array
  * @returns {object} paths array, tree, excluded array
  */
-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, _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:
-                    _a = _g.sent();
-                    return [3 /*break*/, 3];
-                case 2:
-                    _a = [];
-                    _g.label = 3;
-                case 3:
-                    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();
-                    ext = path_1.default.extname(filePath);
-                    name_1 = path_1.default.basename(filePath).replace(ext, '');
-                    folder = filePath.replace(name_1, '').replace(ext, '');
-                    if (name_1 === 'index') {
-                        name_1 = '__index__';
-                    }
-                    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*/, 10];
-                    baseSrc = mainPath || srcPath;
-                    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*/, 7];
-                    treeEntry.children = [];
-                    _c = (_b = paths.push).apply;
-                    _d = [paths];
-                    _e = [[]];
-                    return [4 /*yield*/, (0, exports.listFolder)(filePath, exclude, include, baseSrc, treeEntry.children)];
-                case 6:
-                    _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:
-                    treeEntry = __assign(__assign({}, treeEntry), { path: "/".concat(name_1), fullPath: path_1.default.join(srcPath, name_1), ext: ext });
-                    _g.label = 8;
-                case 8:
-                    tree.push(treeEntry);
-                    paths.push(file);
-                    return [3 /*break*/, 10];
-                case 9:
-                    excluded.push(file);
-                    _g.label = 10;
-                case 10:
-                    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*/, 14];
-                case 13:
-                    try {
-                        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 14: return [2 /*return*/, { paths: paths, tree: tree, excluded: excluded }];
+const listFolder = (srcPath, exclude, include, mainPath, tree = []) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!Boolean(exclude) || !Array.isArray(exclude)) {
+        exclude = [];
+    }
+    if (!Boolean(include) || !Array.isArray(include)) {
+        include = [];
+    }
+    exclude = exclude.filter(Boolean);
+    include = include.filter(Boolean);
+    const paths = [];
+    const excluded = [];
+    const dirs = srcPath
+        ? yield promises_1.default.readdir(srcPath, {
+            withFileTypes: true
+        })
+        : [];
+    for (const dirent of dirs) {
+        const filePath = node_path_1.default.join(srcPath, dirent.name);
+        const isDir = dirent.isDirectory();
+        const ext = node_path_1.default.extname(filePath);
+        let name = node_path_1.default.basename(filePath).replace(ext, '');
+        const folder = filePath.replace(name, '').replace(ext, '');
+        if (name.endsWith('index')) {
+            name = srcPath.replace(/\//g, '-') + '-' + name;
+        }
+        const file = Object.assign({ isDir,
+            name, path: filePath }, (!isDir ? { ext, folder } : {}));
+        // skip readmes as they are automatically resolved
+        if (name.toLowerCase() === 'readme')
+            continue;
+        const baseSrc = mainPath || srcPath;
+        if (micromatch_1.default.every(node_path_1.default.join(srcPath.replace(baseSrc, ''), dirent.name), [...include, ...exclude.map((e) => '!' + e)]) ||
+            isDir) {
+            let treeEntry = {
+                name
+            };
+            if (isDir) {
+                treeEntry.children = [];
+                paths.push(...(yield (0, exports.listFolder)(filePath, exclude, include, baseSrc, treeEntry.children)).paths);
             }
-        });
-    });
-};
+            else {
+                treeEntry = Object.assign(Object.assign({}, treeEntry), { path: `/${name}`, fullPath: node_path_1.default.join(srcPath, name), ext });
+            }
+            tree.push(treeEntry);
+            paths.push(file);
+        }
+        else {
+            excluded.push(file);
+        }
+    }
+    return { paths, tree, excluded };
+});
 exports.listFolder = listFolder;