feat: Add Template Renderers plugin for auto-generated simplified template rendering APIs #589

kingston · 2025-07-04T13:50:56Z

Summary by CodeRabbit

New Features
- Introduced a Template Renderers plugin that automates the generation of simplified, type-safe template rendering APIs, reducing boilerplate and streamlining integration.
- Added TypeScript-specific renderers, enabling easy and consistent template rendering with improved type safety.
Documentation
- Added comprehensive documentation for the new Template Renderers plugin, including migration guides, usage examples, and configuration options.
Chores
- Updated code review configuration to exclude generated files from review.
- Centralized and exported file naming logic for generated templates.

vercel · 2025-07-04T13:50:59Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
baseplate-project-builder-web	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 4, 2025 1:52pm

changeset-bot · 2025-07-04T13:50:59Z

🦋 Changeset detected

Latest commit: a61ba02

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 17 packages

Name	Type
@baseplate-dev/core-generators	Patch
@baseplate-dev/fastify-generators	Patch
@baseplate-dev/project-builder-server	Patch
@baseplate-dev/react-generators	Patch
@baseplate-dev/plugin-auth	Patch
@baseplate-dev/plugin-storage	Patch
@baseplate-dev/project-builder-cli	Patch
@baseplate-dev/project-builder-common	Patch
@baseplate-dev/project-builder-test	Patch
@baseplate-dev/project-builder-web	Patch
@baseplate-dev/code-morph	Patch
@baseplate-dev/create-project	Patch
@baseplate-dev/project-builder-lib	Patch
@baseplate-dev/sync	Patch
@baseplate-dev/tools	Patch
@baseplate-dev/ui-components	Patch
@baseplate-dev/utils	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2025-07-04T13:51:02Z

Walkthrough

A new Template Renderers plugin and supporting infrastructure were introduced to the code generation system, automating the creation of type-safe template rendering APIs and reducing manual boilerplate. The plugin integrates with the TypeScript extractor, generates renderers for templates and groups, and updates the Prisma generator to use the new API. Documentation and configuration updates accompany the changes.

Changes

File(s)	Change Summary
.changeset/template-renderers-plugin.md packages/core-generators/src/renderers/extractor/plugins/template-renderers/README.md	Added documentation describing the Template Renderers plugin, its API, migration, and usage.
.coderabbit.yaml	Updated code review config to exclude all `generated` directories from reviews.
packages/core-generators/src/renderers/extractor/plugins/index.ts	Added export for `templateRenderersPlugin`.
packages/core-generators/src/renderers/extractor/plugins/template-renderers/index.ts	New module re-exporting from `renderers-file.js` and `template-renderers.plugin.js`.
packages/core-generators/src/renderers/extractor/plugins/template-renderers/renderers-file.ts	New module for generating the `template-renderers.ts` file and related exports.
packages/core-generators/src/renderers/extractor/plugins/template-renderers/template-renderers.plugin.ts	New plugin implementation for managing and generating template renderers.
packages/core-generators/src/renderers/extractor/plugins/template-renderers/types.ts	New TypeScript interfaces for template renderer task dependencies and entries.
packages/core-generators/src/renderers/extractor/plugins/typed-templates-file.ts	Refactored to export typed templates file name and export name helper; updated naming for consistency.
packages/core-generators/src/renderers/typescript/extractor/render-ts-template-renderers.ts	New module for generating TypeScript template renderer entries from template metadata.
packages/core-generators/src/renderers/typescript/extractor/ts-template-file-extractor.ts	Integrated `templateRenderersPlugin` and renderer generation into the TypeScript extractor.
packages/fastify-generators/src/generators/prisma/prisma/prisma.generator.ts	Refactored to use the new `renderers` API for service and seed template rendering.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PrismaGenerator
    participant Renderers
    participant TemplateRenderersPlugin
    participant TypeScriptExtractor

    User->>PrismaGenerator: Run generator
    PrismaGenerator->>Renderers: renderers.service.render(vars)
    Renderers->>TemplateRenderersPlugin: (auto-generated render function)
    TemplateRenderersPlugin->>TypeScriptExtractor: (integrated via plugin)
    TypeScriptExtractor->>Renderers: (render logic executes)
    Renderers-->>PrismaGenerator: Rendered file(s)
    PrismaGenerator-->>User: Generated service and seed files

sequenceDiagram
    participant TypeScriptExtractor
    participant TemplateRenderersPlugin
    participant RenderTsTemplateRenderers

    TypeScriptExtractor->>RenderTsTemplateRenderers: Generate renderer entries for templates
    RenderTsTemplateRenderers-->>TypeScriptExtractor: Renderer entries
    TypeScriptExtractor->>TemplateRenderersPlugin: addTemplateRenderer(generatorName, entry)
    TemplateRenderersPlugin->>TypeScriptExtractor: (afterWrite hook)
    TemplateRenderersPlugin->>FileSystem: writeRenderersFile(generatorName, entries, context)
    FileSystem-->>TemplateRenderersPlugin: template-renderers.ts written

✨ Finishing Touches

📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (5)

packages/core-generators/src/renderers/extractor/plugins/template-renderers/types.ts (1)
6-23: Fix minor typo in JSDoc comment.

The interface structure is well-designed and follows TypeScript best practices.
  /**
-  * The name of the dependency task (will be de-duplicated)..
+  * The name of the dependency task (will be de-duplicated).
   */
packages/core-generators/src/renderers/extractor/plugins/template-renderers/README.md (3)
116-116: Simplify wording for clarity.
-This plugin follows the exact same pattern as the typed templates system:
+This plugin follows the same pattern as the typed templates system:
177-177: Add language specification to code block.
-```
+```text
221-226: Fix grammar in numbered list.
-Follow the established pattern:
-
-1. Create a renderer function (e.g., `renderTextTemplateRenderers`)
-2. Define task dependencies and render functions for your template type
-3. Use the existing generic plugin - no changes needed
-4. Follow the same integration pattern in your template extractor
+Follow the established pattern:
+
+1. Create a renderer function (e.g., `renderTextTemplateRenderers`)
+2. Define task dependencies and render functions for your template type
+3. Use the existing generic plugin - no changes needed
+4. Use the same integration pattern in your template extractor
packages/core-generators/src/renderers/typescript/extractor/render-ts-template-renderers.ts (1)
31-35: Export the interface to follow project conventions.

According to the coding guidelines, all interfaces and types should be exported.
-interface RenderTsTemplateRenderersContext {
+export interface RenderTsTemplateRenderersContext {
   generatorPackageName: string;
   generatorName: string;
 }

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b6bc11f and a61ba02.

⛔ Files ignored due to path filters (70)

packages/core-generators/src/generators/node/eslint/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/core-generators/src/generators/node/eslint/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/core-generators/src/generators/node/ts-utils/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/core-generators/src/generators/node/ts-utils/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/core-generators/src/generators/node/vitest/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/core-generators/src/generators/node/vitest/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/auth/auth-context/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/auth/auth-context/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/auth/auth-plugin/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/auth/auth-plugin/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/auth/auth-roles/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/auth/auth-roles/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/auth/user-session-types/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/auth/user-session-types/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/bull/bull-mq/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/bull/bull-mq/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/bull/fastify-bull-board/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/bull/fastify-bull-board/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/app-module-setup/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/app-module-setup/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/app-module/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/app-module/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/axios/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/axios/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/config-service/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/config-service/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/error-handler-service/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/error-handler-service/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-graceful-shutdown/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-graceful-shutdown/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-health-check/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-health-check/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-redis/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-redis/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-sentry/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-sentry/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-server/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-server/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/logger-service/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/logger-service/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/request-context/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/request-context/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/request-service-context/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/request-service-context/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/service-context/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/service-context/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/email/fastify-postmark/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/email/fastify-postmark/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/pothos/pothos-auth/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/pothos/pothos-auth/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/pothos/pothos-scalar/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/pothos/pothos-scalar/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/pothos/pothos-sentry/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/pothos/pothos-sentry/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/pothos/pothos/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/pothos/pothos/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/prisma/prisma-utils/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/prisma/prisma-utils/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/prisma/prisma/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/prisma/prisma/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/stripe/fastify-stripe/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/stripe/fastify-stripe/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/vitest/prisma-vitest/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/vitest/prisma-vitest/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/yoga/yoga-plugin/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/yoga/yoga-plugin/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth0/generators/fastify/auth0-module/generated/index.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth0/generators/fastify/auth0-module/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-storage/src/generators/fastify/storage-module/generated/index.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-storage/src/generators/fastify/storage-module/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**

📒 Files selected for processing (12)

.changeset/template-renderers-plugin.md (1 hunks)
.coderabbit.yaml (1 hunks)
packages/core-generators/src/renderers/extractor/plugins/index.ts (1 hunks)
packages/core-generators/src/renderers/extractor/plugins/template-renderers/README.md (1 hunks)
packages/core-generators/src/renderers/extractor/plugins/template-renderers/index.ts (1 hunks)
packages/core-generators/src/renderers/extractor/plugins/template-renderers/renderers-file.ts (1 hunks)
packages/core-generators/src/renderers/extractor/plugins/template-renderers/template-renderers.plugin.ts (1 hunks)
packages/core-generators/src/renderers/extractor/plugins/template-renderers/types.ts (1 hunks)
packages/core-generators/src/renderers/extractor/plugins/typed-templates-file.ts (4 hunks)
packages/core-generators/src/renderers/typescript/extractor/render-ts-template-renderers.ts (1 hunks)
packages/core-generators/src/renderers/typescript/extractor/ts-template-file-extractor.ts (5 hunks)
packages/fastify-generators/src/generators/prisma/prisma/prisma.generator.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (6)

`**/*.{ts,tsx}`: TypeScript with strict type checking Node 16 module resolution ...

**/*.{ts,tsx}: TypeScript with strict type checking
Node 16 module resolution - include file extensions in imports (.js)
Sort imports by group: external libs first, then local imports
Use camelCase for variables/functions, PascalCase for types/classes
Always include return types on top-level functions including React components (React.ReactElement)
Include absolute paths in import statements via tsconfig paths (@src/ is the alias for src/)
Order functions such that functions are placed below the variables/functions they use
If a particular interface or type is not exported, change the file so it is exported
Prefer using nullish coalescing operator (??) instead of logical or (||)
Use console.info/warn/error instead of console.log
Always use .js extensions in imports, even for TypeScript files
Specify explicit return types on all functions

📄 Source: CodeRabbit Inference Engine (CLAUDE.md)