Add a test for #2916

Author: Gerrit0

CHANGELOG.md

@@ -23,6 +23,7 @@ title: Changelog
 - Fixed broken links within module pages when structure-dir router was used, #2928.
 - Type parameters on JS classes defined with `@typedef` now correctly handle the constraint, #2929.
 - API: `toString` on types containing index signatures now behave correctly, #2917.
+- Added `@inlineType` to the list of tags excluded by default.
 
 ## v0.28.1 (2025-03-20)
 

src/lib/converter/types.ts

@@ -604,7 +604,7 @@ const predicateConverter: TypeConverter<ts.TypePredicateNode, ts.Type> = {
 
 // This is a horrible thing... we're going to want to split this into converters
 // for different types at some point.
-const typeLiteralConverter: TypeConverter<ts.TypeLiteralNode> = {
+const typeLiteralConverter = {
     kind: [ts.SyntaxKind.TypeLiteral],
     convert(context, node) {
         const symbol = context.getSymbolAtLocation(node) ?? node.symbol;
@@ -653,7 +653,6 @@ const typeLiteralConverter: TypeConverter<ts.TypeLiteralNode> = {
         return new ReflectionType(reflection);
     },
     convertType(context, type) {
-        // Don't use the third parameter here or you break convertTypeInline
         const symbol = type.getSymbol();
         const reflection = new DeclarationReflection(
             "__type",
@@ -693,7 +692,7 @@ const typeLiteralConverter: TypeConverter<ts.TypeLiteralNode> = {
 
         return new ReflectionType(reflection);
     },
-};
+} satisfies TypeConverter<ts.TypeLiteralNode>;
 
 const queryConverter: TypeConverter<ts.TypeQueryNode> = {
     kind: [ts.SyntaxKind.TypeQuery],
@@ -1267,11 +1266,8 @@ function convertTypeInlined(context: Context, type: ts.Type): SomeType {
         return new ArrayType(elementType);
     }
 
-    // typeLiteralConverter doesn't use the node, so we can get away with lying here.
     return typeLiteralConverter.convertType(
         context,
         type,
-        null!,
-        undefined,
     );
 }

src/lib/utils/options/defaults.ts

@@ -38,6 +38,7 @@ export const excludeTags: readonly `@${string}`[] = [
     "@satisfies",
     "@overload",
     "@inline",
+    "@inlineType",
 ];
 
 export const blockTags: readonly `@${string}`[] = TagDefaults.blockTags;

src/test/converter2/issues/gh2916.js

@@ -0,0 +1,12 @@
+/**
+ * @typedef {object} HelloProps
+ * @property {string} name Name property docs
+ */
+
+/**
+ * @inlineType HelloProps
+ * @param {HelloProps} props
+ */
+export function hello(props) {
+    return "Hello {props.name}!";
+}

src/test/issues.c2.test.ts

@@ -2080,6 +2080,12 @@ describe("Issue Tests", () => {
         equal(Bug4.signatures[0].type?.toString(), "U");
     });
 
+    it("#2916 handles @inlineType on @typedef declared types", () => {
+        const project = convert();
+        const hello = querySig(project, "hello");
+        equal(hello.parameters?.[0].type?.toString(), "{ name: string }");
+    });
+
     it("#2917 stringifies index signatures", () => {
         const project = convert();
         const data = query(project, "Foo.data");