@imolko/create-ultra-reporter 2.1.23-beta

package/bin/reporters/generate-domain-documentation.js

@@ -0,0 +1,161 @@
+"use strict";
+// ---------------------------------------------------------------------------
+// Domain Reporter Orchestrator
+//
+// Composed pipeline: load → transform → render → write.
+// Replaces the monolithic ReporterDomainGenerator class with independently
+// testable functions from data-loading, data-transformation, rendering,
+// and file-writing layers.
+// ---------------------------------------------------------------------------
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateDomainDocumentation = generateDomainDocumentation;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const get_file_1 = require("../scripts/get-file");
+const markdown_1 = require("../scripts/markdown");
+const data_loading_1 = require("./data-loading");
+const data_transformation_1 = require("./data-transformation");
+const rendering_1 = require("./rendering");
+const file_writing_1 = require("./file-writing");
+const data_transformation_2 = require("./data-transformation");
+/**
+ * Generates domain documentation by composing the full pipeline:
+ * load artifacts/JSDoc/tests → match & enrich → render → write.
+ *
+ * @param args - Paths and naming configuration
+ */
+async function generateDomainDocumentation(args) {
+    const cwd = process.cwd();
+    const packageRootName = args.packageRootName || 'domainX';
+    const contextName = args.contextName || 'default';
+    const documentationPath = args.documentationPath || './documentation';
+    const domainPath = args.domainPath || './domain/src';
+    const domainTabName = args.domainTabName || 'domain';
+    const aggregateTabName = args.aggregateTabName || 'aggregate';
+    console.log('[reporter-domain] Generating Domain Report...');
+    // Resolve data paths
+    const dataDir = `${documentationPath}/.data-generated/${packageRootName}`;
+    const artifactsDataPath = path.resolve(cwd, `${dataDir}/artifacts.json`);
+    const jsdocReportDataPath = path.resolve(cwd, `${dataDir}/jsdoc-report.txt`);
+    const testResultsDataPath = path.resolve(cwd, `${dataDir}/test-results.json`);
+    // ---- 1. Load raw data ----
+    const artifacts = await (0, data_loading_1.loadArtifacts)(artifactsDataPath);
+    const jsdocData = await (0, data_loading_1.loadJsdocReport)(jsdocReportDataPath);
+    const allTestResults = await (0, data_loading_1.loadTestResults)(testResultsDataPath);
+    // ---- 2. Match JSDoc to artifacts ----
+    const jsdocByPath = (0, data_transformation_1.matchJsdocToArtifacts)(jsdocData, artifacts);
+    // ---- 3. Enrich each artifact ----
+    const enrichedArtifacts = [];
+    for (const artifact of artifacts) {
+        const jsdocElems = jsdocByPath.get(artifact.jsondocMustMatchPath) || [];
+        const enriched = await (0, data_transformation_1.enrichArtifact)(artifact, jsdocElems, allTestResults, cwd, domainPath, contextName);
+        enrichedArtifacts.push(enriched);
+    }
+    // ---- 4. Render and write artifact pages ----
+    const targetDomainPath = `${documentationPath}/docs/${domainTabName}`;
+    const targetAggregatePath = `${documentationPath}/docs/${aggregateTabName}`;
+    const pages = [];
+    for (const enriched of enrichedArtifacts) {
+        // Render with skipAttachments=true so we can defer attachments
+        // replacement until after minification (preserving natural markdown formatting)
+        let markdown = (0, rendering_1.renderArtifactPage)(enriched, { skipAttachments: true, repoSourceUrl: args.repoSourceUrl });
+        // Beautify normalizes whitespace (trim spaces inside tags, normalize
+        // attribute spacing), then minify removes whitespace between tags
+        markdown = (0, markdown_1.beautifyMarkdown)(markdown);
+        markdown = (0, markdown_1.minifyMarkdown)(markdown);
+        // Replace attachments marker BEFORE stripJsxComments so the marker
+        // is still present for replacement. This is done after minification
+        // so attachment markdown keeps its natural formatting.
+        if (enriched.hasAttachments && enriched.attachmentsMd) {
+            const attachmentsHtml = `\n\n<div style={{ backgroundColor: '#EEE', margin: '32px 0', padding: '16px' }}>\n\n` +
+                `${enriched.attachmentsMd}\n\n </div>\n\n`;
+            markdown = markdown.replace('{/* attachments-md */}', attachmentsHtml);
+        }
+        else {
+            markdown = markdown.replace('{/* attachments-md */}', '');
+        }
+        // Strip remaining JSX comment markers (e.g., leftover { /* method-definition */ },
+        // { /* test-panel */ } placeholders from recursive template composition)
+        markdown = (0, markdown_1.stripJsxComments)(markdown);
+        // Build dest paths — aggregates also go to the aggregates tab
+        const destPaths = [
+            path.resolve(cwd, targetDomainPath, `${enriched.idMarkdown}.md`),
+        ];
+        if (enriched.type === 'aggregate') {
+            destPaths.push(path.resolve(cwd, targetAggregatePath, `${enriched.idMarkdown}.md`));
+        }
+        pages.push({ markdown, destPaths });
+    }
+    (0, file_writing_1.writeArtifactPages)(pages);
+    // ---- 5. Generate artifact manifest for searchable table ----
+    const manifestEntries = (0, data_transformation_2.buildManifestEntries)(enrichedArtifacts, contextName);
+    (0, file_writing_1.appendManifestToStatic)(manifestEntries, documentationPath);
+    // ---- 6. Write category index.mdx pages ----
+    const domainIndexMdx = `---
+title: Domain Artifacts
+---
+import ArtifactTable from '@site/src/components/ArtifactTable';
+
+<ArtifactTable category="domain-artifacts" />
+`;
+    const aggregateIndexMdx = `---
+title: Aggregates
+---
+import ArtifactTable from '@site/src/components/ArtifactTable';
+
+<ArtifactTable category="aggregates" />
+`;
+    fs.mkdirSync(path.resolve(cwd, targetDomainPath), { recursive: true });
+    fs.writeFileSync(path.resolve(cwd, targetDomainPath, 'index.mdx'), domainIndexMdx);
+    fs.mkdirSync(path.resolve(cwd, targetAggregatePath), { recursive: true });
+    fs.writeFileSync(path.resolve(cwd, targetAggregatePath, 'index.mdx'), aggregateIndexMdx);
+    // ---- 7. Generate intro page ----
+    await generateIntro(cwd, domainPath, documentationPath);
+    console.log('[reporter-domain] Domain Report Generated!');
+}
+// ---------------------------------------------------------------------------
+// generateIntro — writes the context-intro page directly (no aggregate cards)
+// ---------------------------------------------------------------------------
+async function generateIntro(cwd, domainPath, documentationPath) {
+    // Read context-intro.md
+    const introPath = path.resolve(cwd, domainPath, 'context-intro.md');
+    const contextIntroMd = await (0, get_file_1.getFile)(introPath);
+    const destPath = path.resolve(cwd, documentationPath, 'docs', 'intro.md');
+    const dir = path.dirname(destPath);
+    fs.mkdirSync(dir, { recursive: true });
+    fs.writeFileSync(destPath, contextIntroMd);
+}
+//# sourceMappingURL=generate-domain-documentation.js.map

package/bin/reporters/generate-domain-documentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-domain-documentation.js","sourceRoot":"","sources":["../../src/reporters/generate-domain-documentation.ts"],"names":[],"mappings":";AAAA,8EAA8E;AAC9E,+BAA+B;AAC/B,EAAE;AACF,wDAAwD;AACxD,2EAA2E;AAC3E,wEAAwE;AACxE,2BAA2B;AAC3B,8EAA8E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8B9E,kEA6HC;AAzJD,uCAAyB;AACzB,2CAA6B;AAC7B,kDAA8C;AAC9C,kDAAyF;AACzF,iDAAiF;AACjF,+DAA8E;AAC9E,2CAAiD;AACjD,iDAA0F;AAE1F,+DAA6D;AAa7D;;;;;GAKG;AACI,KAAK,UAAU,2BAA2B,CAC/C,IAAwB;IAExB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC1B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,SAAS,CAAC;IAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,SAAS,CAAC;IAClD,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,IAAI,iBAAiB,CAAC;IACtE,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,cAAc,CAAC;IACrD,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,IAAI,QAAQ,CAAC;IACrD,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,IAAI,WAAW,CAAC;IAE9D,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;IAE7D,qBAAqB;IACrB,MAAM,OAAO,GAAG,GAAG,iBAAiB,oBAAoB,eAAe,EAAE,CAAC;IAC1E,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,iBAAiB,CAAC,CAAC;IACzE,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,mBAAmB,CAAC,CAAC;IAC7E,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,oBAAoB,CAAC,CAAC;IAE9E,6BAA6B;IAC7B,MAAM,SAAS,GAAG,MAAM,IAAA,4BAAa,EAAC,iBAAiB,CAAC,CAAC;IACzD,MAAM,SAAS,GAAG,MAAM,IAAA,8BAAe,EAAC,mBAAmB,CAAC,CAAC;IAC7D,MAAM,cAAc,GAAG,MAAM,IAAA,8BAAe,EAAC,mBAAmB,CAAC,CAAC;IAElE,wCAAwC;IACxC,MAAM,WAAW,GAAG,IAAA,2CAAqB,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAEhE,oCAAoC;IACpC,MAAM,iBAAiB,GAAuB,EAAE,CAAC;IACjD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,IAAA,oCAAc,EACnC,QAAQ,EACR,UAAU,EACV,cAAc,EACd,GAAG,EACH,UAAU,EACV,WAAW,CACZ,CAAC;QACF,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,+CAA+C;IAC/C,MAAM,gBAAgB,GAAG,GAAG,iBAAiB,SAAS,aAAa,EAAE,CAAC;IACtE,MAAM,mBAAmB,GAAG,GAAG,iBAAiB,SAAS,gBAAgB,EAAE,CAAC;IAE5E,MAAM,KAAK,GAAmB,EAAE,CAAC;IAEjC,KAAK,MAAM,QAAQ,IAAI,iBAAiB,EAAE,CAAC;QACzC,+DAA+D;QAC/D,gFAAgF;QAChF,IAAI,QAAQ,GAAG,IAAA,8BAAkB,EAAC,QAAQ,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAE1G,qEAAqE;QACrE,kEAAkE;QAClE,QAAQ,GAAG,IAAA,2BAAgB,EAAC,QAAQ,CAAC,CAAC;QACtC,QAAQ,GAAG,IAAA,yBAAc,EAAC,QAAQ,CAAC,CAAC;QAEpC,mEAAmE;QACnE,oEAAoE;QACpE,uDAAuD;QACvD,IAAI,QAAQ,CAAC,cAAc,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;YACtD,MAAM,eAAe,GACnB,sFAAsF;gBACtF,GAAG,QAAQ,CAAC,aAAa,iBAAiB,CAAC;YAC7C,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,eAAe,CAAC,CAAC;QACzE,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,CAAC,CAAC;QAC5D,CAAC;QAED,mFAAmF;QACnF,yEAAyE;QACzE,QAAQ,GAAG,IAAA,2BAAgB,EAAC,QAAQ,CAAC,CAAC;QAEtC,8DAA8D;QAC9D,MAAM,SAAS,GAAa;YAC1B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,gBAAgB,EAAE,GAAG,QAAQ,CAAC,UAAU,KAAK,CAAC;SACjE,CAAC;QAEF,IAAI,QAAQ,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAClC,SAAS,CAAC,IAAI,CACZ,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,mBAAmB,EAAE,GAAG,QAAQ,CAAC,UAAU,KAAK,CAAC,CACpE,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,IAAA,iCAAkB,EAAC,KAAK,CAAC,CAAC;IAE1B,+DAA+D;IAC/D,MAAM,eAAe,GAAG,IAAA,0CAAoB,EAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;IAC7E,IAAA,qCAAsB,EAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;IAE3D,8CAA8C;IAC9C,MAAM,cAAc,GAAG;;;;;;CAMxB,CAAC;IAEA,MAAM,iBAAiB,GAAG;;;;;;CAM3B,CAAC;IAEA,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,gBAAgB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACvE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,gBAAgB,EAAE,WAAW,CAAC,EAAE,cAAc,CAAC,CAAC;IACnF,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,mBAAmB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1E,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,mBAAmB,EAAE,WAAW,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAEzF,mCAAmC;IACnC,MAAM,aAAa,CACjB,GAAG,EACH,UAAU,EACV,iBAAiB,CAClB,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;AAC5D,CAAC;AAED,8EAA8E;AAC9E,8EAA8E;AAC9E,8EAA8E;AAE9E,KAAK,UAAU,aAAa,CAC1B,GAAW,EACX,UAAkB,EAClB,iBAAyB;IAEzB,wBAAwB;IACxB,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC;IACpE,MAAM,cAAc,GAAG,MAAM,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;IAEhD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAC3B,GAAG,EACH,iBAAiB,EACjB,MAAM,EACN,UAAU,CACX,CAAC;IACF,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACvC,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;AAC7C,CAAC"}

package/bin/reporters/generate-use-cases-documentation.d.ts

@@ -0,0 +1,18 @@
+export interface UseCasesReporterArgs {
+    packageRootName: string;
+    title: string;
+    documentationPath: string;
+    useCasesPath: string;
+    useCasesTabName: string;
+    templateDir: string;
+    cwd: string;
+    repoSourceUrl?: string;
+}
+/**
+ * Generates use-cases documentation by composing the full pipeline:
+ * load test results → discover folders → load definitions & attachments
+ * → enrich → render → write.
+ *
+ * @param args - Paths and naming configuration
+ */
+export declare function generateUseCasesDocumentation(args: UseCasesReporterArgs): Promise<void>;

package/bin/reporters/generate-use-cases-documentation.js

@@ -0,0 +1,123 @@
+"use strict";
+// ---------------------------------------------------------------------------
+// Use-Cases Reporter Orchestrator
+//
+// Composed pipeline: load → transform → render → write.
+// Replaces the monolithic ReporterUseCasesGenerator class with independently
+// testable functions from data-loading, data-transformation, rendering,
+// and file-writing layers.
+// ---------------------------------------------------------------------------
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateUseCasesDocumentation = generateUseCasesDocumentation;
+const path = __importStar(require("path"));
+const markdown_1 = require("../scripts/markdown");
+const data_loading_1 = require("./data-loading");
+const data_transformation_1 = require("./data-transformation");
+const rendering_1 = require("./rendering");
+const file_writing_1 = require("./file-writing");
+/**
+ * Generates use-cases documentation by composing the full pipeline:
+ * load test results → discover folders → load definitions & attachments
+ * → enrich → render → write.
+ *
+ * @param args - Paths and naming configuration
+ */
+async function generateUseCasesDocumentation(args) {
+    const cwd = args.cwd || process.cwd();
+    const packageRootName = args.packageRootName || 'featuresX';
+    const title = args.title || 'Default Use Cases';
+    const documentationPath = args.documentationPath || './documentation';
+    const useCasesPath = args.useCasesPath || './use-cases';
+    const useCasesTabName = args.useCasesTabName || 'domain';
+    console.log('[reporter-use-case] Generating Use Case Report...');
+    // Resolve data paths
+    const testResultsDataPath = path.resolve(cwd, `${documentationPath}/.data-generated/${packageRootName}/test-results.json`);
+    const targetDocusaurusPath = path.resolve(cwd, `${documentationPath}/docs/${useCasesTabName}`);
+    // ---- 1. Load test results ----
+    const allTestResults = await (0, data_loading_1.loadTestResults)(testResultsDataPath);
+    // ---- 2. Discover use-case folders ----
+    const resolvedUseCasesPath = path.resolve(cwd, useCasesPath);
+    const folders = await (0, data_loading_1.loadUseCaseFolders)(resolvedUseCasesPath);
+    // ---- 3. Process each folder: load → enrich → render ----
+    const pages = [];
+    for (let index = 0; index < folders.length; index++) {
+        const folderName = folders[index];
+        const useCaseDirPath = path.resolve(resolvedUseCasesPath, folderName);
+        const useCaseRelativePath = path.relative(cwd, path.resolve(resolvedUseCasesPath, folderName));
+        // Load definition and attachments (legacy yaml + .md frontmatter merged)
+        const { definition: definitionData, attachmentsMd } = await (0, data_loading_1.loadUseCaseMetadataAndContent)(useCaseDirPath);
+        // Build raw use-case
+        const raw = {
+            title: definitionData.title || 'Error: Definition has not title',
+            description: definitionData.description ||
+                'Error: Definition has not description',
+            type: definitionData.type || 'Error: Definition has not type',
+            modelStatus: definitionData.modelStatus || 'UNDEFINED',
+            tags: definitionData.tags || [],
+            attachmentsMd: attachmentsMd || '',
+            path: useCaseRelativePath,
+        };
+        // Enrich with test results and IDs
+        const enriched = (0, data_transformation_1.enrichUseCase)(raw, allTestResults, index, title);
+        // Render with deferred attachments (skipAttachments=true so attachments
+        // replacement happens after minification, preserving natural markdown formatting)
+        let markdown = (0, rendering_1.renderUseCasePage)(enriched, { skipAttachments: true, repoSourceUrl: args.repoSourceUrl });
+        // Beautify normalizes whitespace, then minify removes whitespace between tags
+        markdown = (0, markdown_1.beautifyMarkdown)(markdown);
+        markdown = (0, markdown_1.minifyMarkdown)(markdown);
+        // Replace attachments marker BEFORE stripJsxComments so the marker
+        // is still present for replacement. Done after minification so
+        // attachment markdown keeps its natural formatting.
+        if (enriched.attachmentsMd) {
+            const attachmentsHtml = `\n\n<div style={{ backgroundColor: '#EEE', margin: '32px 0', padding: '16px' }}>\n\n` +
+                `${enriched.attachmentsMd}\n\n </div>\n\n`;
+            markdown = markdown.replace('{/* attachments-md */}', attachmentsHtml);
+        }
+        else {
+            markdown = markdown.replace('{/* attachments-md */}', '');
+        }
+        // Strip remaining JSX comment markers (e.g., leftover { /* method-definition */ },
+        // { /* test-panel */ } placeholders from recursive template composition)
+        markdown = (0, markdown_1.stripJsxComments)(markdown);
+        // Build destination path
+        const destPath = path.resolve(targetDocusaurusPath, `${enriched.idMarkdown}.md`);
+        pages.push({ markdown, destPath });
+    }
+    // ---- 4. Write output ----
+    (0, file_writing_1.writeUseCasePages)(pages);
+    console.log('[reporter-use-case] Use Cases Report Generated!');
+}
+//# sourceMappingURL=generate-use-cases-documentation.js.map

package/bin/reporters/generate-use-cases-documentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-use-cases-documentation.js","sourceRoot":"","sources":["../../src/reporters/generate-use-cases-documentation.ts"],"names":[],"mappings":";AAAA,8EAA8E;AAC9E,kCAAkC;AAClC,EAAE;AACF,wDAAwD;AACxD,6EAA6E;AAC7E,wEAAwE;AACxE,2BAA2B;AAC3B,8EAA8E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4B9E,sEA6FC;AAvHD,2CAA6B;AAC7B,kDAAyF;AACzF,iDAAoG;AACpG,+DAAsD;AACtD,2CAAgD;AAChD,iDAAmD;AAcnD;;;;;;GAMG;AACI,KAAK,UAAU,6BAA6B,CACjD,IAA0B;IAE1B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACtC,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,WAAW,CAAC;IAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,mBAAmB,CAAC;IAChD,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,IAAI,iBAAiB,CAAC;IACtE,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,IAAI,aAAa,CAAC;IACxD,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,QAAQ,CAAC;IAEzD,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;IAEjE,qBAAqB;IACrB,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,GAAG,EACH,GAAG,iBAAiB,oBAAoB,eAAe,oBAAoB,CAC5E,CAAC;IACF,MAAM,oBAAoB,GAAG,IAAI,CAAC,OAAO,CACvC,GAAG,EACH,GAAG,iBAAiB,SAAS,eAAe,EAAE,CAC/C,CAAC;IAEF,iCAAiC;IACjC,MAAM,cAAc,GAAG,MAAM,IAAA,8BAAe,EAAC,mBAAmB,CAAC,CAAC;IAElE,yCAAyC;IACzC,MAAM,oBAAoB,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IAC7D,MAAM,OAAO,GAAG,MAAM,IAAA,iCAAkB,EAAC,oBAAoB,CAAC,CAAC;IAE/D,2DAA2D;IAC3D,MAAM,KAAK,GAAkB,EAAE,CAAC;IAEhC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QACpD,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAClC,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC;QACtE,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC,CAAC;QAE/F,yEAAyE;QACzE,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,MAAM,IAAA,4CAA6B,EAAC,cAAc,CAAC,CAAC;QAE1G,qBAAqB;QACrB,MAAM,GAAG,GAAe;YACtB,KAAK,EACF,cAAc,CAAC,KAAgB,IAAI,iCAAiC;YACvE,WAAW,EACR,cAAc,CAAC,WAAsB;gBACtC,uCAAuC;YACzC,IAAI,EAAG,cAAc,CAAC,IAAe,IAAI,gCAAgC;YACzE,WAAW,EAAG,cAAc,CAAC,WAAsB,IAAI,WAAW;YAClE,IAAI,EAAG,cAAc,CAAC,IAAiB,IAAI,EAAE;YAC7C,aAAa,EAAE,aAAa,IAAI,EAAE;YAClC,IAAI,EAAE,mBAAmB;SAC1B,CAAC;QAEF,mCAAmC;QACnC,MAAM,QAAQ,GAAG,IAAA,mCAAa,EAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAElE,wEAAwE;QACxE,kFAAkF;QAClF,IAAI,QAAQ,GAAG,IAAA,6BAAiB,EAAC,QAAQ,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAEzG,8EAA8E;QAC9E,QAAQ,GAAG,IAAA,2BAAgB,EAAC,QAAQ,CAAC,CAAC;QACtC,QAAQ,GAAG,IAAA,yBAAc,EAAC,QAAQ,CAAC,CAAC;QAEpC,mEAAmE;QACnE,+DAA+D;QAC/D,oDAAoD;QACpD,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,eAAe,GACnB,sFAAsF;gBACtF,GAAG,QAAQ,CAAC,aAAa,iBAAiB,CAAC;YAC7C,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,eAAe,CAAC,CAAC;QACzE,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,CAAC,CAAC;QAC5D,CAAC;QAED,mFAAmF;QACnF,yEAAyE;QACzE,QAAQ,GAAG,IAAA,2BAAgB,EAAC,QAAQ,CAAC,CAAC;QAEtC,yBAAyB;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAC3B,oBAAoB,EACpB,GAAG,QAAQ,CAAC,UAAU,KAAK,CAC5B,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;IACrC,CAAC;IAED,4BAA4B;IAC5B,IAAA,gCAAiB,EAAC,KAAK,CAAC,CAAC;IAEzB,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;AACjE,CAAC"}

package/bin/reporters/rendering.d.ts

@@ -0,0 +1,116 @@
+import { EnrichedArtifact, EnrichedUseCase, MethodDefinition, Property, TestFile, TestResult } from './types';
+/**
+ * Renders a single code example as a styled HTML div.
+ *
+ * @param example - The example code string
+ * @returns HTML div string with inline styling
+ */
+export declare function renderExample(example: string): string;
+/**
+ * Renders a single test result as a collapsible detail element.
+ *
+ * Each test gets a colored status label (green=passed, red=failed,
+ * yellow=pending, blue=todo) and a messages section inside a styled div.
+ *
+ * @param test - The test result to render (may include annotation from JSDoc)
+ * @param testFilePath - The file path containing the test
+ * @param messages - Optional messages to display (@deprecated, prefer test.annotation)
+ * @returns HTML string for the test panel (includes trailing // test-panel marker)
+ */
+export declare function renderTestPanel(test: TestResult, testFilePath: string, messages?: string[], repoSourceUrl?: string): string;
+/**
+ * Renders all test results across all test files as concatenated test panels.
+ *
+ * @param testFiles - Array of test files with their results
+ * @returns Concatenated HTML string of all test panels
+ */
+export declare function renderTestPanels(testFiles: TestFile[], repoSourceUrl?: string): string;
+/**
+ * Renders the complete methods section with count header and collapsible
+ * method definitions. Returns empty string when there are no methods.
+ *
+ * @param methods - Array of method definitions
+ * @returns HTML string for the entire methods section, or '' if empty
+ */
+export declare function renderMethodsSection(methods: MethodDefinition[]): string;
+/**
+ * Renders the complete tests section with count header and collapsible test panels.
+ * Returns empty string when there are no tests.
+ *
+ * @param testFiles - Array of test files with their results
+ * @returns HTML string for the entire tests section, or '' if no tests
+ */
+export declare function renderTestsSection(testFiles: TestFile[], repoSourceUrl?: string): string;
+/**
+ * Renders the complete properties section with count header and
+ * collapsible table. Returns empty string when there are no properties.
+ *
+ * @param properties - Array of property definitions
+ * @returns HTML string for the entire properties section, or '' if empty
+ */
+export declare function renderPropertiesSection(properties: Property[]): string;
+/**
+ * Renders a markdown table of artifact properties (name, type, description).
+ *
+ * The type column renders as a link using the same logic as the monolith's
+ * linkToType: strips `<...>` suffix that follows a dot (e.g., `java.util.List<String>`
+ * → `java.util.List`), then converts the type name using names().fileName.
+ *
+ * @param properties - Array of property definitions
+ * @returns HTML table string
+ */
+export declare function renderPropertiesTable(properties: Property[]): string;
+/**
+ * Renders a single method definition with name, description,
+ * parameters table, and examples.
+ *
+ * @param method - The method definition to render
+ * @returns HTML string for the method definition (includes trailing
+ *          // method-definition marker for composition)
+ */
+export declare function renderMethodDefinition(method: MethodDefinition): string;
+/**
+ * Renders multiple method definitions by composing renderMethodDefinition
+ * calls. Uses the trailing `{ /* method-definition * / }` marker for
+ * recursive composition (matches the monolith template pattern).
+ *
+ * @param methods - Array of method definitions
+ * @returns Concatenated HTML string of all method definitions
+ */
+export declare function renderMethodDefinitions(methods: MethodDefinition[]): string;
+/** Options for {@link renderArtifactPage}. */
+export interface RenderArtifactPageOptions {
+    /**
+     * When `true`, the `{/* attachments-md * /}` marker is left in place
+     * so the caller can replace it after minification (matching the original
+     * monolith behavior where attachments keep their natural formatting).
+     */
+    skipAttachments?: boolean;
+    /** Base URL for linking test file paths to the source repository. */
+    repoSourceUrl?: string;
+}
+/**
+ * Renders the full artifact documentation page.
+ *
+ * Composes all sections: header (title, type+tags, description), attachments,
+ * properties table, method definitions, and test panels.
+ *
+ * @param artifact - The fully enriched artifact to render
+ * @param options - Optional rendering flags
+ * @returns Complete HTML page string for the artifact
+ */
+export declare function renderArtifactPage(artifact: EnrichedArtifact, options?: RenderArtifactPageOptions): string;
+/**
+ * Renders a full use-case documentation page.
+ *
+ * Composes: header (title, type+modelStatus+tags, description),
+ * attachments section, and test panels.
+ *
+ * @param useCase - The fully enriched use-case to render
+ * @param options - Optional rendering flags
+ * @returns Complete HTML page string for the use-case
+ */
+export declare function renderUseCasePage(useCase: EnrichedUseCase, options?: {
+    skipAttachments?: boolean;
+    repoSourceUrl?: string;
+}): string;