refactor(core): use TemplateScaffolder and simplify scaffoldTemplate API #484
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update create-gen-app to ^0.7.0 - Refactor template-scaffold.ts to use TemplateScaffolder class - Delete boilerplate-scanner.ts and boilerplate-types.ts (now in create-gen-app) - Remove duplicate readBoilerplateConfig/readBoilerplatesConfig functions - Pass prompter through scaffoldTemplate to fix two-instance problem - Update workspace.ts to pass prompter instead of calling close() This eliminates code duplication between pgpm/core and create-gen-app. The TemplateScaffolder class now handles all the boilerplate config reading and path resolution logic.
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
- Add InitWorkspaceOptions interface for workspace initialization - Add static initWorkspace() method to PgpmPackage class - Update CLI workspace.ts to use PgpmPackage.initWorkspace() - Remove scaffoldTemplate from public exports (now internal) - Keep constants (DEFAULT_TEMPLATE_REPO, etc.) exported for CLI use
- Replace scaffoldTemplate() calls with PgpmPackage.initWorkspace() - Update module test to use PgpmPackage.initModule() (requires workspace) - Tests now use the public API instead of internal scaffoldTemplate function
This reverts commit 0f6bb09.
This reverts commit 1270ccb.
… of type/dir/templatePath - Remove TemplateKind type and type parameter - Remove dir parameter (unused in CLI) - Remove templatePath parameter (merged into fromPath) - Add fromPath as the single path selector - Update CLI workspace.ts to use fromPath - Update PgpmPackage.initModule to use fromPath - Update tests to use fromPath The .boilerplates.json resolution is handled by TemplateScaffolder internally, so callers just need to specify 'workspace' or 'module' and it resolves to 'default/workspace' or 'default/module' automatically.
devin-ai-integration
bot
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Refactors
@pgpmjs/coreto use the newTemplateScaffolderclass from[email protected], eliminating code duplication between the two packages. This also fixes the "two-instance Inquirerer problem" that caused double-echoed keystrokes when runningpgpm init workspace.Key changes:
create-gen-appto^0.7.0boilerplate-scanner.tsandboilerplate-types.ts(now provided by create-gen-app)template-scaffold.tsto delegate toTemplateScaffolderinstead of manually composing CacheManager/GitCloner/Templatizerprompterthrough toscaffoldTemplate()to fix double-echo keystrokesscaffoldTemplate()remains the public API from@pgpmjs/coreThe
template-scaffold.tsfile went from ~236 lines to ~100 lines.Updates since last revision
API Simplification: Replaced
type,dir, andtemplatePathparameters with a singlefromPathparameter:type: TemplateKindparameter andTemplateKindtypedirparameter (was unused in CLI)templatePathparameter (merged intofromPath)fromPath: stringas the single path selectorThe
.boilerplates.jsonresolution is now handled entirely byTemplateScaffolder, so callers just specify'workspace'or'module'and it resolves to'default/workspace'or'default/module'automatically.Before:
After:
Review & Testing Checklist for Human
scaffoldTemplate()now requiresfromPathinstead oftype- verify no external consumers are affectedfromPath: 'workspace'correctly resolves todefault/workspacevia.boilerplates.jsonpgpm init workspaceinteractively and verify:pgpm init moduleinside a workspace and verify it still workspgpm init workspace --templatePath supabase/workspaceto verify custom paths still workNotes
This PR depends on
[email protected]which was published from dev-utils#33.Link to Devin run: https://app.devin.ai/sessions/48555739db3d4f1b9e9edfa9ea1e559a
Requested by: Dan Lynch (@pyramation)