Add trailing newline to generated doc files

Gerrit0 · Gerrit0 · commit f0f0106dbbb6 · 2024-07-09T21:52:25.000-06:00
Resolves #2632
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,8 @@
 -   If a relative linked image is referenced multiple times, TypeDoc will no longer sometimes produce invalid links to the image #2627.
 -   `@link` tags will now be validated in referenced markdown documents, #2629.
 -   `@link` tags are now resolved in project documents, #2629.
--   `@hidden` is now properly applied when placed in a function implementation comment.
+-   HTML/JSON output generated by TypeDoc now contains a trailing newline, #2632.
+-   `@hidden` is now properly applied when placed in a function implementation comment, #2634.
 -   Comments on re-exports are now rendered.
 
 ### Thanks!
diff --git a/src/lib/application.ts b/src/lib/application.ts
@@ -614,7 +614,7 @@ export class Application extends ChildableComponent<
         const ser = this.serializer.projectToObject(project, process.cwd());
 
         const space = this.options.getValue("pretty") ? "\t" : "";
-        await writeFile(out, JSON.stringify(ser, null, space));
+        await writeFile(out, JSON.stringify(ser, null, space) + "\n");
         this.logger.info(this.i18n.json_written_to_0(nicePath(out)));
         this.logger.verbose(`JSON rendering took ${Date.now() - start}ms`);
     }
diff --git a/src/lib/output/themes/default/DefaultTheme.tsx b/src/lib/output/themes/default/DefaultTheme.tsx
@@ -291,7 +291,7 @@ export class DefaultTheme extends Theme {
 
     render(page: PageEvent<Reflection>, template: RenderTemplate<PageEvent<Reflection>>): string {
         const templateOutput = this.defaultLayoutTemplate(page, template);
-        return "<!DOCTYPE html>" + JSX.renderElement(templateOutput);
+        return "<!DOCTYPE html>" + JSX.renderElement(templateOutput) + "\n";
     }
 
     private _navigationCache: NavigationElement[] | undefined;

Original file line number	Diff line number	Diff line change
`@@ -614,7 +614,7 @@ export class Application extends ChildableComponent<`
`614`	`614`	`const ser = this.serializer.projectToObject(project, process.cwd());`
`615`	`615`
`616`	`616`	`const space = this.options.getValue("pretty") ? "\t" : "";`
`617`		`- await writeFile(out, JSON.stringify(ser, null, space));`
	`617`	`+ await writeFile(out, JSON.stringify(ser, null, space) + "\n");`
`618`	`618`	`this.logger.info(this.i18n.json_written_to_0(nicePath(out)));`
`619`	`619`	this.logger.verbose(`JSON rendering took ${Date.now() - start}ms`);
`620`	`620`	`}`
Original file line number	Diff line number	Diff line change
`@@ -291,7 +291,7 @@ export class DefaultTheme extends Theme {`
`291`	`291`
`292`	`292`	`render(page: PageEvent<Reflection>, template: RenderTemplate<PageEvent<Reflection>>): string {`
`293`	`293`	`const templateOutput = this.defaultLayoutTemplate(page, template);`
`294`		`- return "<!DOCTYPE html>" + JSX.renderElement(templateOutput);`
	`294`	`+ return "<!DOCTYPE html>" + JSX.renderElement(templateOutput) + "\n";`
`295`	`295`	`}`
`296`	`296`
`297`	`297`	`private _navigationCache: NavigationElement[] \| undefined;`