feature(banira-cli): doc gen improved

Sebastian Schürmann · Sebastian Schürmann · commit 2c054767f208 · 2025-01-03T23:56:40.000+01:00
diff --git a/packages/banira-cli/src/actions/doc.ts b/packages/banira-cli/src/actions/doc.ts
@@ -1,12 +1,14 @@
 import { DocGen } from 'banira';
-import { resolve } from 'path';
+import { resolve, basename } from 'path';
 
 export const doc = async (file: string) => {
   try {
     const filePath = resolve(file);
-    const docGen = new DocGen();
-    const documentation = await docGen.parseDoc(filePath);
-    console.log(documentation);
+    const tagName = basename(filePath, '.ts');
+    const docGen = new DocGen(tagName);
+    const parsed = await docGen.parseDoc(filePath);
+    const doc = docGen.renderDocs(parsed);
+    console.log(doc)
   } catch (error) {
     console.error('Failed to generate documentation:', error);
     process.exit(1);
diff --git a/packages/banira-cli/test/cli.test.ts b/packages/banira-cli/test/cli.test.ts
@@ -34,6 +34,7 @@ describe("banira CLI", () => {
         assert.strictEqual(result.exitCode, 0, "Expected successful documentation generation");
         assert.ok(result.stdout.length > 0, "Expected documentation output");
         assert.ok(!result.stderr, "Expected no errors");
+        console.log(result.stdout);
     });
 });
 
diff --git a/packages/banira/src/doc-gen.ts b/packages/banira/src/doc-gen.ts
@@ -89,6 +89,6 @@ export class DocGen {
             throw new Error('Invalid parser context: docComment is undefined');
         }
         const formatter = new FormatterDocPage(context);
-        return formatter.createDocPage();
+        return formatter.createDocPage(this.tagName, this.src, this.title);
     }
 }
diff --git a/packages/banira/src/formatter/doc-page.ts b/packages/banira/src/formatter/doc-page.ts
@@ -19,7 +19,7 @@ export class FormatterDocPage {
         return this.context.docComment.summarySection
     }
 
-    createDocPage(tagName: string = "my-circle", src: string = "../dist/my-circle.js", title: string = "MyCircle Component Demo"): string {
+    createDocPage(tagName: string, src: string, title: string): string {
         return `<!DOCTYPE html>
 <html lang="en">
 <head>

Original file line number	Diff line number	Diff line change
`@@ -89,6 +89,6 @@ export class DocGen {`
`89`	`89`	`throw new Error('Invalid parser context: docComment is undefined');`
`90`	`90`	`}`
`91`	`91`	`const formatter = new FormatterDocPage(context);`
`92`		`- return formatter.createDocPage();`
	`92`	`+ return formatter.createDocPage(this.tagName, this.src, this.title);`
`93`	`93`	`}`
`94`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ export class FormatterDocPage {`
`19`	`19`	`return this.context.docComment.summarySection`
`20`	`20`	`}`
`21`	`21`
`22`		`- createDocPage(tagName: string = "my-circle", src: string = "../dist/my-circle.js", title: string = "MyCircle Component Demo"): string {`
	`22`	`+ createDocPage(tagName: string, src: string, title: string): string {`
`23`	`23`	return `<!DOCTYPE html>
`24`	`24`	`<html lang="en">`
`25`	`25`	`<head>`