Skip to content

Commit 61e16a7

Browse files
author
Sebastian Schürmann
committed
refactor(banira): cleanup initial doc rendering code
1 parent 7caf8f6 commit 61e16a7

File tree

2 files changed

+4
-47
lines changed

2 files changed

+4
-47
lines changed

packages/banira/src/doc-gen.ts

+4-17
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import { TSDocParser, type ParserContext, type DocComment, TSDocConfiguration, TSDocTagDefinition, TSDocTagSyntaxKind } from '@microsoft/tsdoc';
1+
import { TSDocParser, type ParserContext, TSDocConfiguration, TSDocTagDefinition, TSDocTagSyntaxKind } from '@microsoft/tsdoc';
22
import * as path from 'path';
33
import { readFile } from 'fs/promises';
4-
import { FormatterDefault } from './formatter/default.js';
4+
import { FormatterDocPage } from './formatter/doc-page.js';
55

66
/**
77
* A class for parsing and rendering TSDoc documentation comments.
@@ -61,18 +61,6 @@ export class DocGen {
6161
return parserContext;
6262
}
6363

64-
/**
65-
* Renders all documentation nodes from a parsed documentation context.
66-
*
67-
* @param context - The parsed documentation context to render
68-
* @returns A formatted string containing the rendered documentation
69-
*/
70-
render(context: ParserContext): string {
71-
const docComment: DocComment = context.docComment;
72-
const result = FormatterDefault.renderDocNodes(docComment.getChildNodes());
73-
return result;
74-
}
75-
7664
/**
7765
* Renders only the custom documentation blocks from a parsed documentation context.
7866
* This specifically focuses on rendering blocks marked with custom tags like @demo.
@@ -85,8 +73,7 @@ export class DocGen {
8573
if (!context || !context.docComment) {
8674
throw new Error('Invalid parser context: docComment is undefined');
8775
}
88-
const docComment: DocComment = context.docComment;
89-
const result = FormatterDefault.renderDocNodes(docComment.customBlocks);
90-
return result;
76+
const formatter = new FormatterDocPage(context);
77+
return formatter.createDocPage();
9178
}
9279
}

packages/banira/src/formatter/default.ts

-30
This file was deleted.

0 commit comments

Comments
 (0)