refactor: Improve projectExportsOnly handling #601

kingston · 2025-07-10T09:22:42Z

No need to writefile manually

Summary by CodeRabbit

New Features
- Introduced template renderers for text and raw templates, enabling consistent and type-safe rendering functions for code generation.
- Added automated generation of render functions for both individual and grouped text templates.
- Enhanced CLI template generation command to accept an optional directory argument for improved flexibility.
Improvements
- Template export names and path providers are now sorted alphabetically for consistent output.
- Enhanced error handling and guard clauses for template path resolution.
- Centralized and streamlined template rendering through new renderer interfaces in generators.
- Improved support for metadata-only extraction scenarios.
Bug Fixes
- Ensured correct handling of singleton and grouped templates across renderers.
Chores
- Refactored internal logic for better maintainability and integration of new renderer plugins.
- Updated method and function signatures for clarity and improved usability.

- Also allow template generation without any target directory :)

vercel · 2025-07-10T09:22:45Z

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 10, 2025 9:30am

changeset-bot · 2025-07-10T09:22:47Z

🦋 Changeset detected

Latest commit: 062df34

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-10T09:22:51Z

Walkthrough

This change introduces new template renderers for text and raw templates within the code generation system, following the established pattern used by TypeScript template renderers. The new renderers provide a consistent API, support both grouped and individual templates (for text), and integrate with the template renderers plugin system. Additional updates include refactoring internal APIs, updating CLI commands, and adjusting file extraction and writing logic to accommodate these new renderers.

Changes

File(s) / Area	Change Summary
`.changeset/add-text-raw-template-renderers.md`	Documents the addition of text and raw template renderers and their integration with the plugin system.
`packages/core-generators/src/renderers/text/render-text-template-renderers.ts`, `.../raw/render-raw-template-renderers.ts`	Introduce new modules to generate render functions for text and raw templates, supporting both grouped and individual templates (for text), and integrating with generator metadata and plugin systems.
`packages/core-generators/src/renderers/text/text-template-file-extractor.ts`, `.../raw/raw-template-file-extractor.ts`	Update extractors to register template renderers with the new plugin, generating and adding renderer entries for text and raw templates.
`packages/core-generators/src/renderers/text/index.ts`, `.../raw/index.ts`	Add exports for the new template renderer modules.
`packages/core-generators/src/renderers/text/render-text-template-file-action.ts`, `.../raw/render-raw-template-action.ts`, `.../text/render-text-template-group-action.ts`	Add `export` to type aliases for action input types, making them publicly accessible.
`packages/core-generators/src/renderers/extractor/plugins/template-paths/paths-file.ts`, `.../typed-templates-file.ts`	Refactor to sort providers and export names lexicographically and use utility methods for interface content generation.
`packages/core-generators/src/renderers/extractor/plugins/template-paths/template-paths.plugin.ts`	Add guard clauses for output directory and template path root checks.
`packages/core-generators/src/renderers/typescript/templates/types.ts`	Add optional `projectExportsOnly` property to the `TsTemplateFile` interface.
`packages/core-generators/src/renderers/typescript/extractor/ts-template-file-extractor.ts`	Add guard clause for `outputDirectory` and update local variable usage.
`packages/core-generators/src/renderers/typescript/extractor/render-ts-typed-templates.ts`, `.../actions/render-ts-template-file-action.ts`	Adjust file writing and template source logic based on `projectExportsOnly` flag.
`packages/project-builder-cli/src/commands/templates.ts`	Change CLI `generate` subcommand to accept an optional directory argument and update handler signatures.
`packages/project-builder-server/src/template-extractor/run-template-extractor.ts`	Rename and refactor function to remove sync metadata and app-specific logic; update parameter handling.
`packages/react-generators/src/generators/apollo/react-apollo/react-apollo.generator.ts`	Replace usage of `typescriptFileProvider` with new `renderers` object for template rendering.
`packages/react-generators/src/generators/core/react-router/react-router.generator.ts`	Replace manual pseudo-file write with direct renderer invocation for route tree metadata.
`packages/react-generators/src/generators/core/react-router/extractor.json`	Remove "projectExports" entry from the "root-route" template.
`packages/sync/src/output/generator-task-output.ts`	Update `apply` method to accept multiple actions.
`packages/sync/src/templates/extractor/run-template-file-extractors.ts`	Remove `outputDirectory` parameter and update context instantiation.
`packages/sync/src/templates/extractor/runner/template-extractor-context.ts`	Make `outputDirectory` optional in context class and constructor.

Sequence Diagram(s)

sequenceDiagram
    participant Generator
    participant TemplateExtractor
    participant TemplateRenderersPlugin
    participant Builder

    Generator->>TemplateExtractor: Extract templates (text/raw)
    TemplateExtractor->>TemplateRenderersPlugin: Register template renderers (grouped/individual)
    Generator->>Builder: Apply renderers via plugin API
    Builder->>TemplateRenderersPlugin: Retrieve and invoke renderers
    TemplateRenderersPlugin->>Builder: Render files (typed, text, raw)

Possibly related PRs

feat: Add Template Renderers plugin for auto-generated simplified template rendering APIs #589: Introduces the foundational Template Renderers plugin and TypeScript template renderers, which the current PR extends by adding text and raw template renderers.
feat: Support text template groups #494: Adds support for text template groups in fastify and react generators; related as both PRs enhance text template grouping and rendering infrastructure.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a13a90c and 062df34.

📒 Files selected for processing (3)

packages/core-generators/src/renderers/typescript/actions/render-ts-template-file-action.ts (1 hunks)
packages/project-builder-cli/src/commands/templates.ts (3 hunks)
packages/project-builder-server/src/template-extractor/run-template-extractor.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

packages/core-generators/src/renderers/typescript/actions/render-ts-template-file-action.ts
packages/project-builder-cli/src/commands/templates.ts
packages/project-builder-server/src/template-extractor/run-template-extractor.ts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

GitHub Check: Lint
GitHub Check: Test E2E
GitHub Check: test

✨ 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: 4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 69eea11 and a13a90c.

⛔ Files ignored due to path filters (38)

packages/fastify-generators/src/generators/core/error-handler-service/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-scripts/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/fastify-scripts/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/readme/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/core/readme/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/pothos/pothos/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
packages/fastify-generators/src/generators/yoga/yoga-plugin/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/admin/admin-bull-board/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/apollo/react-apollo/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/core/react-components/generated/template-paths.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/core/react-components/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/core/react-router/generated/template-paths.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/core/react-router/generated/ts-import-providers.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/core/react-router/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/core/react-tailwind/generated/index.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/core/react-tailwind/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/core/react/generated/template-paths.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/core/react/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
packages/react-generators/src/generators/core/react/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth/core/generators/auth-hooks/generated/template-paths.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth/core/generators/auth-hooks/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth/core/generators/auth-hooks/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth/core/generators/auth-module/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth/core/generators/auth-routes/generated/template-paths.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth/core/generators/auth-routes/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth/core/generators/auth-routes/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth/core/generators/react-session/generated/template-paths.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth/core/generators/react-session/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth/core/generators/react-session/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth0/generators/react/auth0-hooks/generated/template-paths.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth0/generators/react/auth0-hooks/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/auth0/generators/react/auth0-hooks/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/placeholder-auth/core/generators/placeholder-auth-hooks/generated/template-paths.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/placeholder-auth/core/generators/placeholder-auth-hooks/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-auth/src/placeholder-auth/core/generators/placeholder-auth-hooks/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-storage/src/generators/react/upload-components/generated/template-paths.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-storage/src/generators/react/upload-components/generated/template-renderers.ts is excluded by !**/generated/**, !**/generated/**
plugins/plugin-storage/src/generators/react/upload-components/generated/typed-templates.ts is excluded by !**/generated/**, !**/generated/**

📒 Files selected for processing (25)

.changeset/add-text-raw-template-renderers.md (1 hunks)
packages/core-generators/src/renderers/extractor/plugins/template-paths/paths-file.ts (2 hunks)
packages/core-generators/src/renderers/extractor/plugins/template-paths/template-paths.plugin.ts (2 hunks)
packages/core-generators/src/renderers/extractor/plugins/typed-templates-file.ts (1 hunks)
packages/core-generators/src/renderers/raw/index.ts (1 hunks)
packages/core-generators/src/renderers/raw/raw-template-file-extractor.ts (4 hunks)
packages/core-generators/src/renderers/raw/render-raw-template-action.ts (1 hunks)
packages/core-generators/src/renderers/raw/render-raw-template-renderers.ts (1 hunks)
packages/core-generators/src/renderers/text/index.ts (1 hunks)
packages/core-generators/src/renderers/text/render-text-template-file-action.ts (1 hunks)
packages/core-generators/src/renderers/text/render-text-template-group-action.ts (1 hunks)
packages/core-generators/src/renderers/text/render-text-template-renderers.ts (1 hunks)
packages/core-generators/src/renderers/text/text-template-file-extractor.ts (5 hunks)
packages/core-generators/src/renderers/typescript/actions/render-ts-template-file-action.ts (1 hunks)
packages/core-generators/src/renderers/typescript/extractor/render-ts-typed-templates.ts (2 hunks)
packages/core-generators/src/renderers/typescript/extractor/ts-template-file-extractor.ts (2 hunks)
packages/core-generators/src/renderers/typescript/templates/types.ts (1 hunks)
packages/project-builder-cli/src/commands/templates.ts (3 hunks)
packages/project-builder-server/src/template-extractor/run-template-extractor.ts (1 hunks)
packages/react-generators/src/generators/apollo/react-apollo/react-apollo.generator.ts (6 hunks)
packages/react-generators/src/generators/core/react-router/extractor.json (0 hunks)
packages/react-generators/src/generators/core/react-router/react-router.generator.ts (1 hunks)
packages/sync/src/output/generator-task-output.ts (1 hunks)
packages/sync/src/templates/extractor/run-template-file-extractors.ts (0 hunks)
packages/sync/src/templates/extractor/runner/template-extractor-context.ts (2 hunks)

💤 Files with no reviewable changes (2)

packages/react-generators/src/generators/core/react-router/extractor.json
packages/sync/src/templates/extractor/run-template-file-extractors.ts

🧰 Additional context used

📓 Path-based instructions (5)

`**/*.{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)