feat: force not removing comments while generating ts declaration

To preserve jsdoc comments
adbayb · Mar 17, 2022 · dfc65a0 · dfc65a0
1 parent 628e461
commit dfc65a0
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 14 deletions.
diff --git a/examples/ts-module/src/Button.tsx b/examples/ts-module/src/Button.tsx
@@ -2,6 +2,9 @@ interface ButtonProps {
 	label: string;
 }
 
+/**
+ * Button component
+ */
 export const Button = (props: ButtonProps) => {
 	return (
 		<>

diff --git a/src/bundler/bundler.ts b/src/bundler/bundler.ts
@@ -1,12 +1,13 @@
 /* eslint-disable sonarjs/cognitive-complexity */
-import path from "path";
 import { build } from "esbuild";
-import { helpers } from "termost";
 import { CWD } from "../constants";
 import { ModuleFormat } from "../types";
 import { getPackageMetadata } from "./package";
 import { jsxPlugin } from "./plugins";
-import { getTypeScriptConfiguration } from "./typescript";
+import {
+	generateTypeScriptDeclaration,
+	getTypeScriptConfiguration,
+} from "./typescript";
 
 type BundleParameters = {
 	isProduction: boolean;
@@ -36,16 +37,7 @@ export const bundle = async ({
 
 		if (!outfile) return null;
 
-		try {
-			const typingDir = path.dirname(outfile);
-
-			await helpers.exec(
-				`tsc --declaration --emitDeclarationOnly --incremental --outDir ${typingDir}`,
-				{ cwd: CWD }
-			);
-		} catch (error) {
-			throw new Error(`Typing generation failed:\n${error}`);
-		}
+		await generateTypeScriptDeclaration(outfile);
 
 		return outfile;
 	};

diff --git a/src/bundler/typescript.ts b/src/bundler/typescript.ts
@@ -1,4 +1,5 @@
-import { resolve } from "path";
+import { dirname, resolve } from "path";
+import { helpers } from "termost";
 import { CWD } from "../constants";
 
 export type TypeScriptConfiguration = {
@@ -44,6 +45,21 @@ export const getTypeScriptConfiguration =
 		}
 	};
 
+export const generateTypeScriptDeclaration = async (outfile: string) => {
+	const outdir = dirname(outfile);
+
+	try {
+		await helpers.exec(
+			`tsc --declaration --emitDeclarationOnly --incremental --removeComments false --outDir ${outdir}`,
+			{ cwd: CWD }
+		);
+
+		return outdir;
+	} catch (error) {
+		throw new Error(`Type generation failed:\n${error}`);
+	}
+};
+
 export const hasTypeScript = (
 	tsConfig: TypeScriptConfiguration | null
 ): tsConfig is TypeScriptConfiguration => {