@xpack/doxygen2docusaurus 1.0.2

package/dist/docusaurus/utils.js

@@ -0,0 +1,169 @@
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT.
+ */
+// ----------------------------------------------------------------------------
+import * as fs from 'node:fs/promises';
+// ----------------------------------------------------------------------------
+export function formatDate(date) {
+    // Custom format: YYYY-MM-DD HH:mm:ss
+    const year = date.getUTCFullYear();
+    // The +1 is needed because months are zero-based.
+    const month = String(date.getUTCMonth() + 1).padStart(2, '0');
+    const day = String(date.getUTCDate()).padStart(2, '0');
+    const hours = String(date.getUTCHours()).padStart(2, '0');
+    const minutes = String(date.getUTCMinutes()).padStart(2, '0');
+    const seconds = String(date.getUTCSeconds()).padStart(2, '0');
+    return (`${year.toString()}-${month}-${day} ${hours}:${minutes}:${seconds} ` +
+        '+0000');
+}
+export function formatDuration(n) {
+    if (n < 1000) {
+        return `${n.toString()} ms`;
+    }
+    else if (n < 100000) {
+        return `${(n / 1000).toFixed(1)} sec`;
+    }
+    else {
+        return `${(n / 60000).toFixed(1)} min`;
+    }
+}
+// ----------------------------------------------------------------------------
+// /**
+//  * Escape characters that are problematic in MDX/JSX context.
+//  * This includes HTML special chars and MDX/JSX delimiters.
+//  */
+// export function escapeMdx (text: string): string {
+//   return text
+//     .replaceAll(/[&]/g, '&amp;')
+//     .replaceAll(/[<]/g, '&lt;')
+//     .replaceAll(/[>]/g, '&gt;')
+//     .replaceAll(/["]/g, '&quot;')
+//     .replaceAll(/[']/g, '&#39;')
+//     .replaceAll(/[`]/g, '&#96;')
+//     .replaceAll(/{/g, '&#123;')
+//     .replaceAll(/}/g, '&#125;')
+//     .replaceAll(/\[/g, '&#91;')
+//     .replaceAll(/\]/g, '&#93;')
+//     .replaceAll(/~/g, '&#126;')
+//     .replaceAll(/[\\]/g, '\\\\')
+//     .replaceAll(/\*/g, '&#42;') // Markdown for bold
+//     .replaceAll(/_/g, '&#95;') // Markdown for italics
+// }
+// export function encodeUrl (text: string): string {
+//   return text
+//     .replaceAll(/[<]/g, '%3C')
+//     .replaceAll(/[>]/g, '%3E')
+//     .replaceAll(/[(]/g, '%28')
+//     .replaceAll(/[)]/g, '%29')
+//     .replaceAll(/[&]/g, '%26')
+//     .replaceAll(/[*]/g, '%2A')
+// }
+// /**
+//  * Escape characters that are problematic in a markdown context.
+//  * This includes HTML special chars and markdown delimiters.
+//  */
+// export function escapeMarkdown (text: string): string {
+//   return text
+//     .replaceAll(/&/g, '&amp;')
+//     .replaceAll(/</g, '&lt;')
+//     .replaceAll(/>/g, '&gt;')
+//     .replaceAll(/\\/g, '\\\\') // Must be placed before \[ \]
+//     .replaceAll(/\[/g, '\\[')
+//     .replaceAll(/\]/g, '\\]')
+//     .replaceAll(/\*/g, '\\*') // Markdown for bold
+//     .replaceAll(/_/g, '\\_') // Markdown for italics
+//     .replaceAll(/~/g, '\\~') // Markdown for strikethrough in GFM
+// }
+// /**
+//  * In <code></code> only a few characters need to be escaped.
+//  */
+// export function escapeHtml (text: string): string {
+//   return text
+//     .replaceAll(/&/g, '&amp;')
+//     .replaceAll(/</g, '&lt;')
+//     .replaceAll(/>/g, '&gt;')
+// }
+// export function escapeQuotes (text: string): string {
+//   return text
+//     .replaceAll(/"/g, '&quot;')
+// }
+// // type='plain-html'
+// export function escapeBraces (text: string): string {
+//   return text
+//     .replaceAll(/{/g, '&#123;') // MD
+//     .replaceAll(/}/g, '&#125;') // MD
+// }
+export function removeEmptyLines(text) {
+    return text.replace(/^\s*$(?:\r\n?|\n)/gm, '');
+}
+// Preserve '/' too.
+export function sanitizeHierarchicalPath(text) {
+    return text
+        .toLowerCase()
+        .replaceAll(/[ ]*/g, '')
+        .replaceAll(/\*/g, '2a')
+        .replaceAll(/&/g, '26')
+        .replaceAll(/</g, '3c')
+        .replaceAll(/>/g, '3e')
+        .replaceAll(/\(/g, '28')
+        .replaceAll(/\)/g, '29')
+        .replaceAll(/[^a-zA-Z0-9/-]/g, '-');
+}
+export function sanitizeAnonymousNamespace(text) {
+    return text.replaceAll(/anonymous_namespace\{/g, 'anonymous{');
+}
+export function flattenPath(text) {
+    return text.replaceAll('/', '-');
+}
+export function stripPermalinkHexAnchor(refid) {
+    return refid.replace(/_1[0-9a-fg]*$/, '');
+}
+export function stripPermalinkTextAnchor(refid) {
+    return refid.replace(/_1_[0-9a-z]*$/, '');
+}
+export function stripLeadingNewLines(text) {
+    return text.replace(/^[\r\n]+/, '');
+}
+export function stripTrailingNewLines(text) {
+    return text.replace(/[ \r\n]+$/, '');
+}
+export function stripLeadingAndTrailingNewLines(text) {
+    return text.replace(/^[\r\n]+/, '').replace(/[ \r\n]+$/, '');
+}
+export function getPermalinkAnchor(refid) {
+    return refid.replace(/^.*_1/, '');
+}
+export async function folderExists(folderPath) {
+    try {
+        const stat = await fs.stat(folderPath);
+        return stat.isDirectory();
+    }
+    catch {
+        return false;
+    }
+}
+export function joinWithLast(arr, delimiter, lastDelimiter) {
+    if (arr.length === 0)
+        return '';
+    if (arr.length === 1)
+        return arr[0];
+    return arr.slice(0, -1).join(delimiter) + lastDelimiter + arr[arr.length - 1];
+}
+export function isUrl(str) {
+    try {
+        new URL(str);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+// ----------------------------------------------------------------------------
+//# sourceMappingURL=utils.js.map

package/dist/docusaurus/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/docusaurus/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAEtC,+EAA+E;AAE/E,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,qCAAqC;IACrC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;IAClC,kDAAkD;IAClD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAC7D,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IACtD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IACzD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAC7D,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAE7D,OAAO,CACL,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,KAAK,IAAI,GAAG,IAAI,KAAK,IAAI,OAAO,IAAI,OAAO,GAAG;QACpE,OAAO,CACR,CAAA;AACH,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,CAAS;IACtC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;QACb,OAAO,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAA;IAC7B,CAAC;SAAM,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC;QACtB,OAAO,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAA;IACvC,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAA;IACxC,CAAC;AACH,CAAC;AAED,+EAA+E;AAE/E,MAAM;AACN,gEAAgE;AAChE,8DAA8D;AAC9D,MAAM;AACN,qDAAqD;AACrD,gBAAgB;AAChB,mCAAmC;AACnC,kCAAkC;AAClC,kCAAkC;AAClC,oCAAoC;AACpC,mCAAmC;AACnC,mCAAmC;AACnC,kCAAkC;AAClC,kCAAkC;AAClC,kCAAkC;AAClC,kCAAkC;AAClC,kCAAkC;AAClC,mCAAmC;AACnC,uDAAuD;AACvD,yDAAyD;AACzD,IAAI;AAEJ,qDAAqD;AACrD,gBAAgB;AAChB,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,IAAI;AAEJ,MAAM;AACN,mEAAmE;AACnE,+DAA+D;AAC/D,MAAM;AACN,0DAA0D;AAC1D,gBAAgB;AAChB,iCAAiC;AACjC,gCAAgC;AAChC,gCAAgC;AAChC,gEAAgE;AAChE,gCAAgC;AAChC,gCAAgC;AAChC,qDAAqD;AACrD,uDAAuD;AACvD,oEAAoE;AACpE,IAAI;AAEJ,MAAM;AACN,gEAAgE;AAChE,MAAM;AACN,sDAAsD;AACtD,gBAAgB;AAChB,iCAAiC;AACjC,gCAAgC;AAChC,gCAAgC;AAChC,IAAI;AAEJ,wDAAwD;AACxD,gBAAgB;AAChB,kCAAkC;AAClC,IAAI;AAEJ,uBAAuB;AACvB,wDAAwD;AACxD,gBAAgB;AAChB,wCAAwC;AACxC,wCAAwC;AACxC,IAAI;AAEJ,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAA;AAChD,CAAC;AAED,oBAAoB;AACpB,MAAM,UAAU,wBAAwB,CAAC,IAAY;IACnD,OAAO,IAAI;SACR,WAAW,EAAE;SACb,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;SACvB,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;SACvB,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;SACtB,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;SACtB,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;SACtB,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;SACvB,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;SACvB,UAAU,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAA;AACvC,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,IAAY;IACrD,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAA;AAChE,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;AAClC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAa;IACnD,OAAO,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAA;AAC3C,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,KAAa;IACpD,OAAO,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAA;AAC3C,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;AACrC,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,IAAY;IAChD,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;AACtC,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,IAAY;IAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;AAC9D,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAa;IAC9C,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;AACnC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,UAAkB;IACnD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACtC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAA;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,GAAa,EACb,SAAiB,EACjB,aAAqB;IAErB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IAC/B,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;IACnC,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,aAAa,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AAC/E,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,GAAW;IAC/B,IAAI,CAAC;QACH,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;QACZ,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED,+EAA+E"}

package/dist/docusaurus/view-model/classes-vm.d.ts

@@ -0,0 +1,35 @@
+import { CompoundBase } from './compound-base-vm.js';
+import type { CompoundDefDataModel } from '../../doxygen/data-model/compounds/compounddef-dm.js';
+import { CollectionBase } from './collection-base.js';
+import type { MenuItem, SidebarCategory, FrontMatter } from '../types.js';
+import type { BaseCompoundRefDataModel, DerivedCompoundRefDataModel } from '../../doxygen/data-model/compounds/compoundreftype-dm.js';
+import type { TemplateParamListDataModel } from '../../doxygen/data-model/compounds/templateparamlisttype-dm.js';
+export declare class Classes extends CollectionBase {
+    topLevelClasses: Class[];
+    addChild(compoundDef: CompoundDefDataModel): CompoundBase;
+    createCompoundsHierarchies(): void;
+    addSidebarItems(sidebarCategory: SidebarCategory): void;
+    private createSidebarItemRecursively;
+    createMenuItems(): MenuItem[];
+    generateIndexDotMdFile(): Promise<void>;
+    private generateIndexMdFileRecursively;
+    generatePerInitialsIndexMdFiles(): Promise<void>;
+}
+export declare class Class extends CompoundBase {
+    baseClassIds: Set<string>;
+    baseClasses: Class[];
+    fullyQualifiedName: string;
+    unqualifiedName: string;
+    templateParameters: string;
+    classFullName: string;
+    template: string | undefined;
+    baseCompoundRefs: BaseCompoundRefDataModel[] | undefined;
+    derivedCompoundRefs: DerivedCompoundRefDataModel[] | undefined;
+    templateParamList: TemplateParamListDataModel | undefined;
+    constructor(collection: Classes, compoundDef: CompoundDefDataModel);
+    initializeLate(): void;
+    hasAnyContent(): boolean;
+    renderToLines(frontMatter: FrontMatter): string[];
+    renderIndexToLines(): string[];
+}
+//# sourceMappingURL=classes-vm.d.ts.map

package/dist/docusaurus/view-model/classes-vm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"classes-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/classes-vm.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAA;AAChG,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAMrD,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EAIf,WAAW,EACZ,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC5B,MAAM,0DAA0D,CAAA;AACjE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gEAAgE,CAAA;AAahH,qBAAa,OAAQ,SAAQ,cAAc;IAEzC,eAAe,EAAE,KAAK,EAAE,CAAK;IAYpB,QAAQ,CAAC,WAAW,EAAE,oBAAoB,GAAG,YAAY;IASzD,0BAA0B,IAAI,IAAI;IAwClC,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IA8FhE,OAAO,CAAC,4BAA4B;IAyC3B,eAAe,IAAI,QAAQ,EAAE;IAUvB,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IA6CtD,OAAO,CAAC,8BAA8B;IA8DvB,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC;CAiGhE;AAID,qBAAa,KAAM,SAAQ,YAAY;IAErC,YAAY,cAAoB;IAChC,WAAW,EAAE,KAAK,EAAE,CAAK;IAEzB,kBAAkB,SAAQ;IAC1B,eAAe,SAAQ;IACvB,kBAAkB,SAAK;IAEvB,aAAa,SAAQ;IACrB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IAI5B,gBAAgB,EAAE,wBAAwB,EAAE,GAAG,SAAS,CAAA;IACxD,mBAAmB,EAAE,2BAA2B,EAAE,GAAG,SAAS,CAAA;IAE9D,iBAAiB,EAAE,0BAA0B,GAAG,SAAS,CAAA;gBAI7C,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,oBAAoB;IAsFzD,cAAc,IAAI,IAAI;IAuCtB,aAAa,IAAI,OAAO;IAuBxB,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE;IAyP1D,kBAAkB,IAAI,MAAM,EAAE;CAiD/B"}