Merge pull request #69 from Rich-Harris/preserve-type-expressions

preserve type expressions in JSDoc annotations for tags other than `param` and `returns`

src/utils.js

@@ -75,18 +75,20 @@ export function clean_jsdoc(node, code) {
 				if (tag.comment) {
 					should_keep = true;
 
-					const typeExpression = /** @type {ts.JSDocTypeExpression | undefined} */ (
-						// @ts-ignore
-						tag.typeExpression
-					);
-
-					if (typeExpression) {
-						// turn `@param {string} foo description` into `@param foo description`
-						let a = typeExpression.pos;
-						let b = typeExpression.end;
-
-						while (code.original[b] === ' ') b += 1;
-						code.remove(a, b);
+					if (type === 'param' || type === 'returns') {
+						const typeExpression = /** @type {ts.JSDocTypeExpression | undefined} */ (
+							// @ts-ignore
+							tag.typeExpression
+						);
+
+						if (typeExpression) {
+							// turn `@param {string} foo description` into `@param foo description`
+							let a = typeExpression.pos;
+							let b = typeExpression.end;
+
+							while (code.original[b] === ' ') b += 1;
+							code.remove(a, b);
+						}
 					}
 				} else if (preserved_jsdoc_tags.has(type)) {
 					should_keep = true;

test/samples/throws/input/index.js

@@ -0,0 +1,7 @@
+/**
+ * @throws {Error} nope
+ * @returns {never}
+ */
+export function nope() {
+	throw new Error('nope');
+}

test/samples/throws/output/index.d.ts

@@ -0,0 +1,8 @@
+declare module 'throws' {
+	/**
+	 * @throws {Error} nope
+	 * */
+	export function nope(): never;
+}
+
+//# sourceMappingURL=index.d.ts.map

test/samples/throws/output/index.d.ts.map

@@ -0,0 +1,14 @@
+{
+	"version": 3,
+	"file": "index.d.ts",
+	"names": [
+		"nope"
+	],
+	"sources": [
+		"../input/index.js"
+	],
+	"sourcesContent": [
+		null
+	],
+	"mappings": ";;;;iBAIgBA,IAAIA"
+}