feat: restructure RouteMeta type and update documentation metadata format

Author: liorcodev

CHANGELOG.md

@@ -5,6 +5,43 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.0] - 2026-02-25
+
+### Breaking Changes
+
+- **`RouteMeta` type restructured** — The `docs` metadata fields (`description`, `tags`,
+  `deprecated`, `auth`, `roles`) must now be nested under a `docs` sub-object. The previous flat
+  shape was inconsistent with how the HTML generator read the metadata, meaning those fields were
+  silently ignored in the generated documentation.
+
+  **Before (broken — fields were silently ignored):**
+
+  ```ts
+  t.procedure.meta({
+    name: 'Get User',
+    description: 'Fetch a user by ID', // ❌ never rendered
+    tags: ['Users'], // ❌ never rendered
+    auth: true // ❌ never rendered
+  });
+  ```
+
+  **After (correct):**
+
+  ```ts
+  t.procedure.meta({
+    name: 'Get User',
+    docs: {
+      description: 'Fetch a user by ID', // ✅
+      tags: ['Users'], // ✅
+      auth: true // ✅
+    }
+  });
+  ```
+
+  `name` remains at the top level of `RouteMeta`. All other documentation fields move under `docs`.
+
+---
+
 ## [0.5.2] - 2026-02-24
 
 ### Fixed

README.md

@@ -418,7 +418,7 @@ type RouteMeta = {
     auth?: boolean;
     /** Roles allowed to access this route */
     roles?: string[];
-  }
+  };
 };
 ```
 
@@ -453,7 +453,7 @@ export const appRouter = t.router({
     list: t.procedure
       .meta({
         name: 'List Users',
-        docs: {   
+        docs: {
           description: 'Get a paginated list of users',
           tags: ['Users'],
           auth: true,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "trpc-docs-generator",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "author": "Lior Cohen",
   "homepage": "https://github.com/liorcodev/trpc-docs-generator#readme",
   "repository": {

src/generate-html.ts

@@ -104,21 +104,21 @@ export function generateDocsHtml(routes: RouteInfo[], options: DocsGeneratorOpti
             <div class="stat-label">Total Endpoints</div>
           </div>
           <div class="stat">
-            <div class="stat-value">${routes.filter(r => !(r.meta?.docs as RouteMeta)?.auth).length}</div>
+            <div class="stat-value">${routes.filter(r => !(r.meta?.docs as RouteMeta['docs'])?.auth).length}</div>
             <div class="stat-label">Public Endpoints</div>
             <div class="stat-breakdown">
-              <span>${routes.filter(r => !(r.meta?.docs as RouteMeta)?.auth && r.type === 'query').length} Queries</span>
+              <span>${routes.filter(r => !(r.meta?.docs as RouteMeta['docs'])?.auth && r.type === 'query').length} Queries</span>
               <span>•</span>
-              <span>${routes.filter(r => !(r.meta?.docs as RouteMeta)?.auth && r.type === 'mutation').length} Mutations</span>
+              <span>${routes.filter(r => !(r.meta?.docs as RouteMeta['docs'])?.auth && r.type === 'mutation').length} Mutations</span>
             </div>
           </div>
           <div class="stat">
-            <div class="stat-value">${routes.filter(r => (r.meta?.docs as RouteMeta)?.auth).length}</div>
+            <div class="stat-value">${routes.filter(r => (r.meta?.docs as RouteMeta['docs'])?.auth).length}</div>
             <div class="stat-label">Protected Endpoints</div>
             <div class="stat-breakdown">
-              <span>${routes.filter(r => (r.meta?.docs as RouteMeta)?.auth && r.type === 'query').length} Queries</span>
+              <span>${routes.filter(r => (r.meta?.docs as RouteMeta['docs'])?.auth && r.type === 'query').length} Queries</span>
               <span>•</span>
-              <span>${routes.filter(r => (r.meta?.docs as RouteMeta)?.auth && r.type === 'mutation').length} Mutations</span>
+              <span>${routes.filter(r => (r.meta?.docs as RouteMeta['docs'])?.auth && r.type === 'mutation').length} Mutations</span>
             </div>
           </div>
         </div>
@@ -179,7 +179,7 @@ function formatGroupName(group: string): string {
 }
 
 function generateRouteCard(route: RouteInfo): string {
-  const docs = route.meta?.docs as RouteMeta | undefined;
+  const docs = route.meta?.docs as RouteMeta['docs'];
   const routeId = route.path.replace(/\./g, '-');
 
   return `

src/types.ts

@@ -5,16 +5,19 @@
 export type RouteMeta = {
   /** Human-readable name for the route */
   name?: string;
-  /** Description of what the route does */
-  description?: string;
-  /** Tags for grouping routes */
-  tags?: string[];
-  /** Whether this route is deprecated */
-  deprecated?: boolean;
-  /** Whether this route requires authentication */
-  auth?: boolean;
-  /** Roles allowed to access this route */
-  roles?: string[];
+  /** Documentation metadata */
+  docs?: {
+    /** Description of what the route does */
+    description?: string;
+    /** Tags for grouping routes */
+    tags?: string[];
+    /** Whether this route is deprecated */
+    deprecated?: boolean;
+    /** Whether this route requires authentication */
+    auth?: boolean;
+    /** Roles allowed to access this route */
+    roles?: string[];
+  };
 };
 
 /**

tests/arrays.test.ts

@@ -11,7 +11,7 @@ const router = t.router({
   numArr: t.procedure.input(z.object({ ids: z.array(z.number()) })).query(() => ''),
   objArr: t.procedure
     .input(z.object({ items: z.array(z.object({ id: z.number(), name: z.string() })) }))
-    .query(() => ''),
+    .query(() => '')
 });
 
 describe('array types', () => {

tests/edge-cases.test.ts

@@ -13,8 +13,8 @@ const router = t.router({
       z.object({
         filter: z.union([
           z.object({ type: z.literal('id'), value: z.number() }),
-          z.object({ type: z.literal('name'), value: z.string() }),
-        ]),
+          z.object({ type: z.literal('name'), value: z.string() })
+        ])
       })
     )
     .query(() => ''),
@@ -25,7 +25,7 @@ const router = t.router({
     .query(() => ''),
 
   // Nullable date
-  nullableDate: t.procedure.input(z.object({ at: z.date().nullable() })).query(() => ''),
+  nullableDate: t.procedure.input(z.object({ at: z.date().nullable() })).query(() => '')
 });
 
 describe('edge cases', () => {

tests/enums.test.ts

@@ -9,7 +9,7 @@ const t = initTRPC.create();
 const router = t.router({
   byStatus: t.procedure
     .input(z.object({ status: z.enum(['active', 'inactive', 'pending']) }))
-    .query(() => ''),
+    .query(() => '')
 });
 
 describe('enums', () => {
@@ -21,7 +21,7 @@ describe('enums', () => {
     expect(inputSchema(collectRoutes(router), 'byStatus').properties.status.enum).toEqual([
       'active',
       'inactive',
-      'pending',
+      'pending'
     ]);
   });
 

tests/intersections.test.ts

@@ -10,7 +10,7 @@ const Base = z.object({ id: z.number() });
 const Extra = z.object({ name: z.string() });
 
 const router = t.router({
-  merged: t.procedure.input(Base.and(Extra)).query(() => ''),
+  merged: t.procedure.input(Base.and(Extra)).query(() => '')
 });
 
 describe('intersection types', () => {

tests/literals.test.ts

@@ -9,7 +9,7 @@ const t = initTRPC.create();
 const router = t.router({
   strLit: t.procedure.input(z.object({ v: z.literal('hello') })).query(() => ''),
   numLit: t.procedure.input(z.object({ v: z.literal(42) })).query(() => 0),
-  boolLit: t.procedure.input(z.object({ v: z.literal(true) })).query(() => false),
+  boolLit: t.procedure.input(z.object({ v: z.literal(true) })).query(() => false)
 });
 
 describe('literals', () => {